Skip to content

Commit 6059470

Browse files
gitlab-terraform-provider-botgitlab-terraform-provider-bot
committed
Update docs for v17.6.0 release
1 parent 3a945b3 commit 6059470

File tree

103 files changed

+1292
-114
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

103 files changed

+1292
-114
lines changed

‎CHANGELOG.md

+51-8
Large diffs are not rendered by default.

‎docs/data-sources/group_billable_member_memberships.md

+57
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "gitlab_group_billable_member_memberships Data Source - terraform-provider-gitlab"
4+
subcategory: ""
5+
description: |-
6+
The gitlab_group_billable_member_memberships data source allows (sub)group- and project-memberships of a billable member of a group to be retrieved by either the user ID, username or email address.
7+
-> You must be an administrator!
8+
~> When using the email attribute, an exact match is not guaranteed. The most related match will be returned. Starting with GitLab 16.6,
9+
the most related match will prioritize an exact match if one is available.
10+
Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/members.html#list-memberships-for-a-billable-member-of-a-group
11+
---
12+
13+
# gitlab_group_billable_member_memberships (Data Source)
14+
15+
The `gitlab_group_billable_member_memberships` data source allows (sub)group- and project-memberships of a billable member of a group to be retrieved by either the user ID, username or email address.
16+
17+
-> You must be an administrator!
18+
19+
~> When using the `email` attribute, an exact match is not guaranteed. The most related match will be returned. Starting with GitLab 16.6,
20+
the most related match will prioritize an exact match if one is available.
21+
22+
**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/members.html#list-memberships-for-a-billable-member-of-a-group)
23+
24+
## Example Usage
25+
26+
```terraform
27+
data "gitlab_group_billable_member_memberships" "test_user_membership" {
28+
user_id = 21
29+
group_id = 42
30+
}
31+
```
32+
33+
<!-- schema generated by tfplugindocs -->
34+
## Schema
35+
36+
### Required
37+
38+
- `group_id` (String) The ID of the group.
39+
- `user_id` (Number) The ID of the user.
40+
41+
### Read-Only
42+
43+
- `id` (String) The id of the data source. It will always be equal to the user_id
44+
- `memberships` (Attributes List) group- and/or project-memberships of the user. (see [below for nested schema](#nestedatt--memberships))
45+
46+
<a id="nestedatt--memberships"></a>
47+
### Nested Schema for `memberships`
48+
49+
Read-Only:
50+
51+
- `access_level` (String) Access-level of the member. For details see: https://docs.gitlab.com/ee/api/access_requests.html#valid-access-levels
52+
- `created_at` (String) Datetime when the membership was first added.
53+
- `expires_at` (String) Date when the membership will end.
54+
- `id` (Number) The id of the membership.
55+
- `source_full_name` (String) Breadcrumb-style, full display-name of the group or project.
56+
- `source_id` (Number) The id of the group or project, the user is a (direct) member of.
57+
- `source_members_url` (String) URL to the members-page of the group or project.

‎docs/data-sources/group_subgroups.md

+1
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@ output "subgroups" {
5454

5555
Read-Only:
5656

57+
- `allowed_email_domains_list` (String)
5758
- `auto_devops_enabled` (Boolean)
5859
- `avatar_url` (String)
5960
- `created_at` (String)

‎docs/data-sources/metadata.md

+1
Original file line numberDiff line numberDiff line change
@@ -36,5 +36,6 @@ data "gitlab_metadata" "this" {}
3636
Read-Only:
3737

3838
- `enabled` (Boolean) Indicates whether KAS is enabled.
39+
- `external_k8s_proxy_url` (String) URL used by the Kubernetes tooling to communicate with the KAS Kubernetes API proxy. It’s null if kas.enabled is false.
3940
- `external_url` (String) URL used by the agents to communicate with KAS. It’s null if kas.enabled is false.
4041
- `version` (String) Version of KAS. It’s null if kas.enabled is false.

‎docs/data-sources/project.md

+1
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,7 @@ data "gitlab_project" "example" {
5050
- `build_timeout` (Number) The maximum amount of time, in seconds, that a job can run.
5151
- `builds_access_level` (String) Set the builds access level. Valid values are `disabled`, `private`, `enabled`.
5252
- `ci_config_path` (String) CI config file path for the project.
53+
- `ci_pipeline_variables_minimum_override_role` (String) The minimum role required to set variables when running pipelines and jobs. Introduced in GitLab 17.1. Valid values are `developer`, `maintainer`, `owner`, `no_one_allowed`
5354
- `ci_restrict_pipeline_cancellation_role` (String) The role required to cancel a pipeline or job. Introduced in GitLab 16.8. Premium and Ultimate only. Valid values are `developer`, `maintainer`, `no one`
5455
- `ci_separated_caches` (Boolean) Use separate caches for protected branches.
5556
- `container_expiration_policy` (List of Object) Set the image cleanup policy for this project. **Note**: this field is sometimes named `container_expiration_policy_attributes` in the GitLab Upstream API. (see [below for nested schema](#nestedatt--container_expiration_policy))

‎docs/data-sources/project_environments.md

+63
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "gitlab_project_environments Data Source - terraform-provider-gitlab"
4+
subcategory: ""
5+
description: |-
6+
The gitlab_project_environments data source retrieves information about all environments of the given project.
7+
Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/environments.html#list-environments
8+
---
9+
10+
# gitlab_project_environments (Data Source)
11+
12+
The `gitlab_project_environments` data source retrieves information about all environments of the given project.
13+
14+
**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/environments.html#list-environments)
15+
16+
## Example Usage
17+
18+
```terraform
19+
resource "gitlab_project" "this" {
20+
name = "example"
21+
initialize_with_readme = true
22+
}
23+
24+
data "gitlab_project_environments" "this" {
25+
project = gitlab_project.this.path_with_namespace # Can also use project id
26+
}
27+
```
28+
29+
<!-- schema generated by tfplugindocs -->
30+
## Schema
31+
32+
### Required
33+
34+
- `project` (String) The ID or full path of the project.
35+
36+
### Optional
37+
38+
- `name` (String) Return the environment with this name. Mutually exclusive with search.
39+
- `search` (String) Return list of environments matching the search criteria. Mutually exclusive with name. Must be at least 3 characters long.
40+
- `states` (String) List all environments that match the specified state. Valid values are `available`, `stopping`, `stopped`. Returns all environments if not set.
41+
42+
### Read-Only
43+
44+
- `environments` (Attributes List) The list of environments. (see [below for nested schema](#nestedatt--environments))
45+
- `id` (String) The ID of this Terraform resource.
46+
47+
<a id="nestedatt--environments"></a>
48+
### Nested Schema for `environments`
49+
50+
Read-Only:
51+
52+
- `cluster_agent_id` (Number) The ID of the environments cluster agent or `null` if none is assigned.
53+
- `created_at` (String) Timestamp of the environment creation, RFC3339 format.
54+
- `description` (String) The description of the environment.
55+
- `external_url` (String) Place to link to for this environment.
56+
- `flux_resource_path` (String) The Flux resource path to associate with this environment.
57+
- `id` (Number) The ID of the environment.
58+
- `kubernetes_namespace` (String) The Kubernetes namespace to associate with this environment.
59+
- `name` (String) The name of the environment.
60+
- `slug` (String) The simplified version of the environment name, suitable for inclusion in DNS, URLs, Kubernetes labels, and so on. The slug is truncated to 24 characters. A random suffix is automatically added to uppercase environment names.
61+
- `state` (String) The state of the environment. Value can be one of `available`, `stopping`, `stopped`. Returns all environments if not set.
62+
- `tier` (String) The tier of the environment. Value can be one of `production`, `staging`, `testing`, `development`, `other`. Returns all environments if not set.
63+
- `updated_at` (String) Timestamp of the last environment update, RFC3339 format.

‎docs/data-sources/project_protected_branch.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -65,8 +65,9 @@ Read-Only:
6565

6666
Optional:
6767

68-
- `group_id` (Number) The ID of a GitLab group allowed to perform the relevant action. Mutually exclusive with `user_id`.
69-
- `user_id` (Number) The ID of a GitLab user allowed to perform the relevant action. Mutually exclusive with `group_id`.
68+
- `deploy_key_id` (Number) The ID of a GitLab deploy key allowed to perform the relevant action. Mutually exclusive with `group_id` and `user_id`. This field is read-only until Gitlab 17.5.
69+
- `group_id` (Number) The ID of a GitLab group allowed to perform the relevant action. Mutually exclusive with `deploy_key_id` and `user_id`.
70+
- `user_id` (Number) The ID of a GitLab user allowed to perform the relevant action. Mutually exclusive with `deploy_key_id` and `group_id`.
7071

7172
Read-Only:
7273

‎docs/data-sources/project_protected_branches.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -74,8 +74,9 @@ Read-Only:
7474

7575
Optional:
7676

77-
- `group_id` (Number) The ID of a GitLab group allowed to perform the relevant action. Mutually exclusive with `user_id`.
78-
- `user_id` (Number) The ID of a GitLab user allowed to perform the relevant action. Mutually exclusive with `group_id`.
77+
- `deploy_key_id` (Number) The ID of a GitLab deploy key allowed to perform the relevant action. Mutually exclusive with `group_id` and `user_id`. This field is read-only until Gitlab 17.5.
78+
- `group_id` (Number) The ID of a GitLab group allowed to perform the relevant action. Mutually exclusive with `deploy_key_id` and `user_id`.
79+
- `user_id` (Number) The ID of a GitLab user allowed to perform the relevant action. Mutually exclusive with `deploy_key_id` and `group_id`.
7980

8081
Read-Only:
8182

‎docs/data-sources/projects.md

+1
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,7 @@ Read-Only:
9797
- `ci_config_path` (String)
9898
- `ci_default_git_depth` (Number)
9999
- `ci_forward_deployment_enabled` (Boolean)
100+
- `ci_pipeline_variables_minimum_override_role` (String)
100101
- `ci_restrict_pipeline_cancellation_role` (String)
101102
- `container_expiration_policy` (List of Object) (see [below for nested schema](#nestedobjatt--projects--container_expiration_policy))
102103
- `container_registry_access_level` (String)

‎docs/data-sources/runners.md

+58
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "gitlab_runners Data Source - terraform-provider-gitlab"
4+
subcategory: ""
5+
description: |-
6+
The gitlab_runners data source retrieves information about all gitlab runners.
7+
Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/runners.html#list-all-runners
8+
---
9+
10+
# gitlab_runners (Data Source)
11+
12+
The `gitlab_runners` data source retrieves information about all gitlab runners.
13+
14+
**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/runners.html#list-all-runners)
15+
16+
## Example Usage
17+
18+
```terraform
19+
resource "gitlab_user_runner" "this" {
20+
runner_type = "instance_type"
21+
tag_list = ["tag1", "tag2"]
22+
}
23+
24+
data "gitlab_runners" "this" {
25+
paused = false
26+
status = "online"
27+
tag_list = ["tag1", "tag2"]
28+
type = "instance_type"
29+
}
30+
```
31+
32+
<!-- schema generated by tfplugindocs -->
33+
## Schema
34+
35+
### Optional
36+
37+
- `paused` (Boolean) Filters for runners with the given paused value
38+
- `status` (String) Filters for runners with the given status. Valid Values are `online`, `offline`, `stale`, and `never_contacted`.
39+
- `tag_list` (Set of String) Filters for runners with all of the given tags
40+
- `type` (String) The type of runner to return. Valid values are `instance_type`, `group_type` and `project_type`
41+
42+
### Read-Only
43+
44+
- `id` (String) The ID of this Terraform resource.
45+
- `runners` (Attributes List) The list of runners. (see [below for nested schema](#nestedatt--runners))
46+
47+
<a id="nestedatt--runners"></a>
48+
### Nested Schema for `runners`
49+
50+
Read-Only:
51+
52+
- `description` (String) The description of the runner.
53+
- `id` (Number) The runner id.
54+
- `is_shared` (Boolean) Indicates if this is a shared runner
55+
- `online` (Boolean) The connectivity status of the runner.
56+
- `paused` (Boolean) Indicates if the runner is accepting or ignoring new jobs.
57+
- `runner_type` (String) The runner type. Values are `instance_type`, `group_type` and `project_type`.
58+
- `status` (String) The status of the runner. Values can be `online`, `offline`, `stale`, and `never_contacted`.

‎docs/resources/application.md

+9-1
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,15 @@ This is only populated when creating a new application. This attribute is not av
5151

5252
## Import
5353

54-
Import is supported using the following syntax:
54+
Starting in Terraform v1.5.0 you can use an [import block](https://developer.hashicorp.com/terraform/language/import) to import `gitlab_application`. For example:
55+
```terraform
56+
import {
57+
to = gitlab_application.example
58+
id = "see CLI command below for ID"
59+
}
60+
```
61+
62+
Import using the CLI is supported using the following syntax:
5563

5664
```shell
5765
# Gitlab applications can be imported with their id, e.g.

‎docs/resources/branch.md

+9-1
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,15 @@ Read-Only:
7070

7171
## Import
7272

73-
Import is supported using the following syntax:
73+
Starting in Terraform v1.5.0 you can use an [import block](https://developer.hashicorp.com/terraform/language/import) to import `gitlab_branch`. For example:
74+
```terraform
75+
import {
76+
to = gitlab_branch.example
77+
id = "see CLI command below for ID"
78+
}
79+
```
80+
81+
Import using the CLI is supported using the following syntax:
7482

7583
```shell
7684
# Gitlab branches can be imported with a key composed of `<project_id>:<branch_name>`, e.g.

‎docs/resources/branch_protection.md

+12-3
Original file line numberDiff line numberDiff line change
@@ -122,8 +122,9 @@ Read-Only:
122122

123123
Optional:
124124

125-
- `group_id` (Number) The ID of a GitLab group allowed to perform the relevant action. Mutually exclusive with `user_id`.
126-
- `user_id` (Number) The ID of a GitLab user allowed to perform the relevant action. Mutually exclusive with `group_id`.
125+
- `deploy_key_id` (Number) The ID of a GitLab deploy key allowed to perform the relevant action. Mutually exclusive with `group_id` and `user_id`. This field is read-only until Gitlab 17.5.
126+
- `group_id` (Number) The ID of a GitLab group allowed to perform the relevant action. Mutually exclusive with `deploy_key_id` and `user_id`.
127+
- `user_id` (Number) The ID of a GitLab user allowed to perform the relevant action. Mutually exclusive with `deploy_key_id` and `group_id`.
127128

128129
Read-Only:
129130

@@ -146,7 +147,15 @@ Read-Only:
146147

147148
## Import
148149

149-
Import is supported using the following syntax:
150+
Starting in Terraform v1.5.0 you can use an [import block](https://developer.hashicorp.com/terraform/language/import) to import `gitlab_branch_protection`. For example:
151+
```terraform
152+
import {
153+
to = gitlab_branch_protection.example
154+
id = "see CLI command below for ID"
155+
}
156+
```
157+
158+
Import using the CLI is supported using the following syntax:
150159

151160
```shell
152161
# Gitlab protected branches can be imported with a key composed of `<project_id>:<branch>`, e.g.

‎docs/resources/cluster_agent.md

+9-1
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,15 @@ resource "gitlab_repository_file" "example_agent_config" {
6969

7070
## Import
7171

72-
Import is supported using the following syntax:
72+
Starting in Terraform v1.5.0 you can use an [import block](https://developer.hashicorp.com/terraform/language/import) to import `gitlab_cluster_agent`. For example:
73+
```terraform
74+
import {
75+
to = gitlab_cluster_agent.example
76+
id = "see CLI command below for ID"
77+
}
78+
```
79+
80+
Import using the CLI is supported using the following syntax:
7381

7482
```shell
7583
# GitLab Agent for Kubernetes can be imported with the following command and the id pattern `<project>:<agent-id>`

‎docs/resources/cluster_agent_token.md

+9-1
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,15 @@ resource "helm_release" "gitlab_agent" {
8989

9090
## Import
9191

92-
Import is supported using the following syntax:
92+
Starting in Terraform v1.5.0 you can use an [import block](https://developer.hashicorp.com/terraform/language/import) to import `gitlab_cluster_agent_token`. For example:
93+
```terraform
94+
import {
95+
to = gitlab_cluster_agent_token.example
96+
id = "see CLI command below for ID"
97+
}
98+
```
99+
100+
Import using the CLI is supported using the following syntax:
93101

94102
```shell
95103
# A token for a GitLab Agent for Kubernetes can be imported with the following command and the id pattern `<project>:<agent-id>:<token-id>`:

‎docs/resources/compliance_framework.md

+9-1
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,15 @@ resource "gitlab_compliance_framework" "sample" {
5757

5858
## Import
5959

60-
Import is supported using the following syntax:
60+
Starting in Terraform v1.5.0 you can use an [import block](https://developer.hashicorp.com/terraform/language/import) to import `gitlab_compliance_framework`. For example:
61+
```terraform
62+
import {
63+
to = gitlab_compliance_framework.example
64+
id = "see CLI command below for ID"
65+
}
66+
```
67+
68+
Import using the CLI is supported using the following syntax:
6169

6270
```shell
6371
# Gitlab compliance frameworks can be imported with a key composed of `<namespace_path>:<framework_id>`, e.g.

‎docs/resources/deploy_key.md

+9-1
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,15 @@ resource "gitlab_deploy_key" "example" {
4646

4747
## Import
4848

49-
Import is supported using the following syntax:
49+
Starting in Terraform v1.5.0 you can use an [import block](https://developer.hashicorp.com/terraform/language/import) to import `gitlab_deploy_key`. For example:
50+
```terraform
51+
import {
52+
to = gitlab_deploy_key.example
53+
id = "see CLI command below for ID"
54+
}
55+
```
56+
57+
Import using the CLI is supported using the following syntax:
5058

5159
```shell
5260
# GitLab deploy keys can be imported using an id made up of `{project_id}:{deploy_key_id}`, e.g.

‎docs/resources/deploy_key_enable.md

+9-1
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,15 @@ resource "gitlab_deploy_key_enable" "foo" {
6060

6161
## Import
6262

63-
Import is supported using the following syntax:
63+
Starting in Terraform v1.5.0 you can use an [import block](https://developer.hashicorp.com/terraform/language/import) to import `gitlab_deploy_key_enable`. For example:
64+
```terraform
65+
import {
66+
to = gitlab_deploy_key_enable.example
67+
id = "see CLI command below for ID"
68+
}
69+
```
70+
71+
Import using the CLI is supported using the following syntax:
6472

6573
```shell
6674
# GitLab enabled deploy keys can be imported using an id made up of `{project_id}:{deploy_key_id}`, e.g.

0 commit comments

Comments
 (0)