You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/_index.md
+13Lines changed: 13 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -32,6 +32,8 @@ We support the following versions:
32
32
33
33
All other versions are best effort support.
34
34
35
+
We do not support experimental GitLab features until they are enabled by default or made Generally Available.
36
+
35
37
> Note, that the compatibility between a provider release and GitLab itself **cannot** be inferred from the
36
38
release version. New features added to GitLab may not be added to the provider until later versions.
37
39
Equally, features removed or deprecated in GitLab may not be removed or deprecated from the provider until later versions.
@@ -47,6 +49,14 @@ Use the navigation to the left to read about the valid functions and resources.
47
49
> Using a Project or Group access token may cause issues with some resources, as those token types don't
48
50
have full access to every API. This is also true when using a `CI_JOB_TOKEN`. Consider using a dedicated
49
51
Personal Access Token or Service Account if you are experiencing permission errors when adding resources.
52
+
## Authentication and Configuration
53
+
54
+
The configuration for the GitLab Provider can be derived from several sources,
55
+
which are applied in the following order:
56
+
57
+
1. Attributes in the provider configuration (see Schema section below)
58
+
2. Environment variables (see Schema section below)
59
+
3. (experimental) Configuration file (see <https://gitlab.com/gitlab-org/api/client-go#use-the-config-package-experimental>)
50
60
## Example Usage
51
61
52
62
{{< chooser language "typescript,python,go,csharp,java,yaml" >}}
@@ -424,7 +434,10 @@ public class App {
424
434
-`cacertFile` (String) This is a file containing the ca cert to verify the gitlab instance. This is available for use when working with GitLab CE or Gitlab Enterprise with a locally-issued or self-signed certificate chain.
425
435
-`clientCert` (String) File path to client certificate when GitLab instance is behind company proxy. File must contain PEM encoded data.
426
436
-`clientKey` (String) File path to client key when GitLab instance is behind company proxy. File must contain PEM encoded data. Required when `clientCert` is set.
437
+
-`configFile` (String) The path to the configuration file to use. It may be sourced from the `GITLAB_CONFIG_FILE` environment variable.
438
+
-`context` (String) The context to use for authentication and configuration. The context must exist in the configuration file. It may be sourced from the `GITLAB_CONTEXT` environment variable.
427
439
-`earlyAuthCheck` (Boolean) (Experimental) By default the provider does a dummy request to get the current user in order to verify that the provider configuration is correct and the GitLab API is reachable. Set this to `false` to skip this check. This may be useful if the GitLab instance does not yet exist and is created within the same pulumi module. It may be sourced from the `GITLAB_EARLY_AUTH_CHECK`. This is an experimental feature and may change in the future. Please make sure to always keep backups of your state.
440
+
-`enableAutoCiSupport` (Boolean) If automatic CI support should be enabled or not. This only works when not providing a token.
428
441
-`headers` (Map of String) A map of headers to append to all API request to the GitLab instance.
429
442
-`insecure` (Boolean) When set to true this disables SSL verification of the connection to the GitLab instance.
430
443
-`retries` (Number) The number of retries to execute when receiving a 429 Rate Limit error. Each retry will exponentially back off.
0 commit comments