Skip to content

Commit 3db332f

Browse files
gitlab-terraform-provider-botgitlab-terraform-provider-bot
committed
Update docs for v3.20.0 release
1 parent c273bbd commit 3db332f

13 files changed

+289
-15
lines changed

‎docs/data-sources/group.md

+3
Original file line numberDiff line numberDiff line change
@@ -39,15 +39,18 @@ data "gitlab_group" "foo" {
3939

4040
- `default_branch_protection` (Number) Whether developers and maintainers can push to the applicable default branch.
4141
- `description` (String) The description of the group.
42+
- `extra_shared_runners_minutes_limit` (Number) Can be set by administrators only. Additional CI/CD minutes for this group.
4243
- `full_name` (String) The full name of the group.
4344
- `id` (String) The ID of this resource.
4445
- `lfs_enabled` (Boolean) Boolean, is LFS enabled for projects in this group.
46+
- `membership_lock` (Boolean) Users cannot be added to projects in this group.
4547
- `name` (String) The name of this group.
4648
- `parent_id` (Number) Integer, ID of the parent group.
4749
- `path` (String) The path of the group.
4850
- `prevent_forking_outside_group` (Boolean) When enabled, users can not fork projects from this group to external namespaces.
4951
- `request_access_enabled` (Boolean) Boolean, is request for access enabled to the group.
5052
- `runners_token` (String, Sensitive) The group level registration token to use during runner setup.
53+
- `shared_runners_minutes_limit` (Number) Can be set by administrators only. Maximum number of monthly CI/CD minutes for this group. Can be nil (default; inherit system default), 0 (unlimited), or > 0.
5154
- `visibility_level` (String) Visibility level of the group. Possible values are `private`, `internal`, `public`.
5255
- `web_url` (String) Web URL of the group.
5356

‎docs/data-sources/group_subgroups.md

+83
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "gitlab_group_subgroups Data Source - terraform-provider-gitlab"
4+
subcategory: ""
5+
description: |-
6+
The gitlab_group_subgroups data source allows to get subgroups of a group.
7+
Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/groups.html#list-a-groups-subgroups
8+
---
9+
10+
# gitlab_group_subgroups (Data Source)
11+
12+
The `gitlab_group_subgroups` data source allows to get subgroups of a group.
13+
14+
**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/groups.html#list-a-groups-subgroups)
15+
16+
## Example Usage
17+
18+
```terraform
19+
data "gitlab_group_subgroups" "subgroups" {
20+
group_id = "123456"
21+
}
22+
23+
output "subgroups" {
24+
value = data.gitlab_group_subgroups.subgroups
25+
}
26+
```
27+
28+
<!-- schema generated by tfplugindocs -->
29+
## Schema
30+
31+
### Required
32+
33+
- `group_id` (Number) The ID of the group.
34+
35+
### Optional
36+
37+
- `all_available` (Boolean) Show all the groups you have access to.
38+
- `min_access_level` (String) Limit to groups where current user has at least this access level.
39+
- `order_by` (String) Order groups by name, path or id.
40+
- `owned` (Boolean) Limit to groups explicitly owned by the current user.
41+
- `search` (String) Return the list of authorized groups matching the search criteria.
42+
- `skip_groups` (List of Number) Skip the group IDs passed.
43+
- `sort` (String) Order groups in asc or desc order.
44+
- `statistics` (Boolean) Include group statistics (administrators only).
45+
- `with_custom_attributes` (Boolean) Include custom attributes in response (administrators only).
46+
47+
### Read-Only
48+
49+
- `id` (String) The ID of this resource.
50+
- `subgroups` (List of Object) Subgroups of the parent group. (see [below for nested schema](#nestedatt--subgroups))
51+
52+
<a id="nestedatt--subgroups"></a>
53+
### Nested Schema for `subgroups`
54+
55+
Read-Only:
56+
57+
- `auto_devops_enabled` (Boolean)
58+
- `avatar_url` (String)
59+
- `created_at` (String)
60+
- `default_branch_protection` (Number)
61+
- `description` (String)
62+
- `emails_disabled` (Boolean)
63+
- `file_template_project_id` (Number)
64+
- `full_name` (String)
65+
- `full_path` (String)
66+
- `group_id` (Number)
67+
- `ip_restriction_ranges` (String)
68+
- `lfs_enabled` (Boolean)
69+
- `mentions_disabled` (Boolean)
70+
- `name` (String)
71+
- `parent_id` (Number)
72+
- `path` (String)
73+
- `project_creation_level` (String)
74+
- `request_access_enabled` (Boolean)
75+
- `require_two_factor_authentication` (Boolean)
76+
- `share_with_group_lock` (Boolean)
77+
- `statistics` (Map of String)
78+
- `subgroup_creation_level` (String)
79+
- `two_factor_grace_period` (Number)
80+
- `visibility` (String)
81+
- `web_url` (String)
82+
83+

‎docs/data-sources/groups.md

+69
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "gitlab_groups Data Source - terraform-provider-gitlab"
4+
subcategory: ""
5+
description: |-
6+
The gitlab_groups data source allows details of multiple groups to be retrieved given some optional filter criteria.
7+
-> Some attributes might not be returned depending on if you're an admin or not.
8+
-> Some available options require administrator privileges.
9+
Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/groups.html#list-groups
10+
---
11+
12+
# gitlab_groups (Data Source)
13+
14+
The `gitlab_groups` data source allows details of multiple groups to be retrieved given some optional filter criteria.
15+
16+
-> Some attributes might not be returned depending on if you're an admin or not.
17+
18+
-> Some available options require administrator privileges.
19+
20+
**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/groups.html#list-groups)
21+
22+
## Example Usage
23+
24+
```terraform
25+
data "gitlab_groups" "example" {
26+
sort = "desc"
27+
order_by = "name"
28+
}
29+
30+
data "gitlab_groups" "example-two" {
31+
search = "GitLab"
32+
}
33+
```
34+
35+
<!-- schema generated by tfplugindocs -->
36+
## Schema
37+
38+
### Optional
39+
40+
- `order_by` (String) Order the groups' list by `id`, `name`, `path`, or `similarity`. (Requires administrator privileges)
41+
- `search` (String) Search groups by name or path.
42+
- `sort` (String) Sort groups' list in asc or desc order. (Requires administrator privileges)
43+
44+
### Read-Only
45+
46+
- `groups` (List of Object) The list of groups. (see [below for nested schema](#nestedatt--groups))
47+
- `id` (String) The ID of this resource.
48+
49+
<a id="nestedatt--groups"></a>
50+
### Nested Schema for `groups`
51+
52+
Read-Only:
53+
54+
- `default_branch_protection` (Number)
55+
- `description` (String)
56+
- `full_name` (String)
57+
- `full_path` (String)
58+
- `group_id` (Number)
59+
- `lfs_enabled` (Boolean)
60+
- `name` (String)
61+
- `parent_id` (Number)
62+
- `path` (String)
63+
- `prevent_forking_outside_group` (Boolean)
64+
- `request_access_enabled` (Boolean)
65+
- `runners_token` (String)
66+
- `visibility_level` (String)
67+
- `web_url` (String)
68+
69+

‎docs/data-sources/project_branches.md

+72
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "gitlab_project_branches Data Source - terraform-provider-gitlab"
4+
subcategory: ""
5+
description: |-
6+
The gitlab_project_branches data source allows details of the branches of a given project to be retrieved.
7+
Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/branches.html#list-repository-branches
8+
---
9+
10+
# gitlab_project_branches (Data Source)
11+
12+
The `gitlab_project_branches` data source allows details of the branches of a given project to be retrieved.
13+
14+
**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/branches.html#list-repository-branches)
15+
16+
## Example Usage
17+
18+
```terraform
19+
data "gitlab_project_branches" "example" {
20+
project = 30
21+
}
22+
23+
data "gitlab_project_branches" "example" {
24+
project = "foo/bar/baz"
25+
}
26+
```
27+
28+
<!-- schema generated by tfplugindocs -->
29+
## Schema
30+
31+
### Required
32+
33+
- `project` (String) ID or URL-encoded path of the project owned by the authenticated user.
34+
35+
### Read-Only
36+
37+
- `branches` (List of Object) The list of branches of the project, as defined below. (see [below for nested schema](#nestedatt--branches))
38+
- `id` (String) The ID of this resource.
39+
40+
<a id="nestedatt--branches"></a>
41+
### Nested Schema for `branches`
42+
43+
Read-Only:
44+
45+
- `can_push` (Boolean)
46+
- `commit` (Set of Object) (see [below for nested schema](#nestedobjatt--branches--commit))
47+
- `default` (Boolean)
48+
- `developers_can_merge` (Boolean)
49+
- `developers_can_push` (Boolean)
50+
- `merged` (Boolean)
51+
- `name` (String)
52+
- `protected` (Boolean)
53+
- `web_url` (String)
54+
55+
<a id="nestedobjatt--branches--commit"></a>
56+
### Nested Schema for `branches.commit`
57+
58+
Read-Only:
59+
60+
- `author_email` (String)
61+
- `author_name` (String)
62+
- `authored_date` (String)
63+
- `committed_date` (String)
64+
- `committer_email` (String)
65+
- `committer_name` (String)
66+
- `id` (String)
67+
- `message` (String)
68+
- `parent_ids` (Set of String)
69+
- `short_id` (String)
70+
- `title` (String)
71+
72+

‎docs/data-sources/project_protected_branches.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,13 @@
33
page_title: "gitlab_project_protected_branches Data Source - terraform-provider-gitlab"
44
subcategory: ""
55
description: |-
6-
The gitlab_protected_branches data source allows details of the protected branches of a given project.
6+
The gitlab_project_protected_branches data source allows details of the protected branches of a given project.
77
Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/protected_branches.html#list-protected-branches
88
---
99

1010
# gitlab_project_protected_branches (Data Source)
1111

12-
The `gitlab_protected_branches` data source allows details of the protected branches of a given project.
12+
The `gitlab_project_protected_branches` data source allows details of the protected branches of a given project.
1313

1414
**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/protected_branches.html#list-protected-branches)
1515

‎docs/data-sources/user_sshkeys.md

+43
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "gitlab_user_sshkeys Data Source - terraform-provider-gitlab"
4+
subcategory: ""
5+
description: |-
6+
The gitlab_user_sshkeys data source allows a list of SSH keys to be retrieved by either the user ID or username.
7+
Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/users.html#list-ssh-keys-for-user
8+
---
9+
10+
# gitlab_user_sshkeys (Data Source)
11+
12+
The `gitlab_user_sshkeys` data source allows a list of SSH keys to be retrieved by either the user ID or username.
13+
14+
**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/users.html#list-ssh-keys-for-user)
15+
16+
17+
18+
<!-- schema generated by tfplugindocs -->
19+
## Schema
20+
21+
### Optional
22+
23+
- `user_id` (Number) ID of the user to get the SSH keys for.
24+
- `username` (String) Username of the user to get the SSH keys for.
25+
26+
### Read-Only
27+
28+
- `id` (String) The ID of this resource.
29+
- `keys` (List of Object) The user's keys. (see [below for nested schema](#nestedatt--keys))
30+
31+
<a id="nestedatt--keys"></a>
32+
### Nested Schema for `keys`
33+
34+
Read-Only:
35+
36+
- `created_at` (String)
37+
- `expires_at` (String)
38+
- `key` (String)
39+
- `key_id` (Number)
40+
- `title` (String)
41+
- `user_id` (Number)
42+
43+

‎docs/resources/application_settings.md

+5-4
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
page_title: "gitlab_application_settings Resource - terraform-provider-gitlab"
44
subcategory: ""
55
description: |-
6-
The gitlab_application_settings resource allows to manage the GitLabLab application settings.
6+
The gitlab_application_settings resource allows to manage the GitLab application settings.
77
~> This is an experimental resource. By nature it doesn't properly fit into how Terraform resources are meant to work.
8-
Feel free to join the discussion https://github.com/gitlabhq/terraform-provider-gitlab/issues/957 if you have any
8+
Feel free to join the discussion https://gitlab.com/gitlab-org/terraform-provider-gitlab/issues/957 if you have any
99
ideas or questions regarding this resource.
1010
~> All gitlab_application_settings use the same ID gitlab.
1111
!> This resource does not implement any destroy logic, it's a no-op at this point.
@@ -16,10 +16,10 @@ description: |-
1616

1717
# gitlab_application_settings (Resource)
1818

19-
The `gitlab_application_settings` resource allows to manage the GitLabLab application settings.
19+
The `gitlab_application_settings` resource allows to manage the GitLab application settings.
2020

2121
~> This is an **experimental resource**. By nature it doesn't properly fit into how Terraform resources are meant to work.
22-
Feel free to join the [discussion](https://github.com/gitlabhq/terraform-provider-gitlab/issues/957) if you have any
22+
Feel free to join the [discussion](https://gitlab.com/gitlab-org/terraform-provider-gitlab/issues/957) if you have any
2323
ideas or questions regarding this resource.
2424

2525
~> All `gitlab_application_settings` use the same ID `gitlab`.
@@ -152,6 +152,7 @@ resource "gitlab_application_settings" "this" {
152152
- `grafana_enabled` (Boolean) Enable Grafana.
153153
- `grafana_url` (String) Grafana URL.
154154
- `gravatar_enabled` (Boolean) Enable Gravatar.
155+
- `group_owners_can_manage_default_branch_protection` (Boolean) Prevent overrides of default branch protection.
155156
- `hashed_storage_enabled` (Boolean) Create new projects using hashed storage paths: Enable immutable, hash-based paths and repository names to store repositories on disk. This prevents repositories from having to be moved or renamed when the Project URL changes and may improve disk I/O performance. (Always enabled in GitLab versions 13.0 and later, configuration is scheduled for removal in 14.0).
156157
- `help_page_hide_commercial_content` (Boolean) Hide marketing-related entries from help.
157158
- `help_page_support_url` (String) Alternate support URL for help page and help dropdown.

‎docs/resources/branch_protection.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ description: |-
66
The gitlab_branch_protection resource allows to manage the lifecycle of a protected branch of a repository.
77
~> Branch Protection Behavior for the default branch
88
Depending on the GitLab instance, group or project setting the default branch of a project is created automatically by GitLab behind the scenes.
9-
Due to some https://github.com/gitlabhq/terraform-provider-gitlab/issues/792 limitations https://discuss.hashicorp.com/t/ignore-the-order-of-a-complex-typed-list/42242 in the Terraform Provider SDK and the GitLab API,
9+
Due to some https://gitlab.com/gitlab-org/terraform-provider-gitlab/issues/792 limitations https://discuss.hashicorp.com/t/ignore-the-order-of-a-complex-typed-list/42242 in the Terraform Provider SDK and the GitLab API,
1010
when creating a new project and trying to manage the branch protection setting for its default branch the gitlab_branch_protection resource will
1111
automatically take ownership of the default branch without an explicit import by unprotecting and properly protecting it again.
1212
Having multiple gitlab_branch_protection resources for the same project and default branch will result in them overriding each other - make sure to only have a single one.
@@ -21,7 +21,7 @@ The `gitlab_branch_protection` resource allows to manage the lifecycle of a prot
2121

2222
~> **Branch Protection Behavior for the default branch**
2323
Depending on the GitLab instance, group or project setting the default branch of a project is created automatically by GitLab behind the scenes.
24-
Due to [some](https://github.com/gitlabhq/terraform-provider-gitlab/issues/792) [limitations](https://discuss.hashicorp.com/t/ignore-the-order-of-a-complex-typed-list/42242) in the Terraform Provider SDK and the GitLab API,
24+
Due to [some](https://gitlab.com/gitlab-org/terraform-provider-gitlab/issues/792) [limitations](https://discuss.hashicorp.com/t/ignore-the-order-of-a-complex-typed-list/42242) in the Terraform Provider SDK and the GitLab API,
2525
when creating a new project and trying to manage the branch protection setting for its default branch the `gitlab_branch_protection` resource will
2626
automatically take ownership of the default branch without an explicit import by unprotecting and properly protecting it again.
2727
Having multiple `gitlab_branch_protection` resources for the same project and default branch will result in them overriding each other - make sure to only have a single one.
@@ -93,7 +93,7 @@ resource "gitlab_branch_protection" "main" {
9393
- `allowed_to_merge` (Block Set) Defines permissions for action. (see [below for nested schema](#nestedblock--allowed_to_merge))
9494
- `allowed_to_push` (Block Set) Defines permissions for action. (see [below for nested schema](#nestedblock--allowed_to_push))
9595
- `allowed_to_unprotect` (Block Set) Defines permissions for action. (see [below for nested schema](#nestedblock--allowed_to_unprotect))
96-
- `code_owner_approval_required` (Boolean) Can be set to true to require code owner approval before merging.
96+
- `code_owner_approval_required` (Boolean) Can be set to true to require code owner approval before merging. Only available own Premium and Ultimate instances.
9797
- `merge_access_level` (String) Access levels allowed to merge. Valid values are: `no one`, `developer`, `maintainer`.
9898
- `push_access_level` (String) Access levels allowed to push. Valid values are: `no one`, `developer`, `maintainer`.
9999
- `unprotect_access_level` (String) Access levels allowed to unprotect. Valid values are: `no one`, `developer`, `maintainer`.

‎docs/resources/group.md

+3
Original file line numberDiff line numberDiff line change
@@ -47,14 +47,17 @@ resource "gitlab_project" "example" {
4747
- `default_branch_protection` (Number) Defaults to 2. See https://docs.gitlab.com/ee/api/groups.html#options-for-default_branch_protection
4848
- `description` (String) The description of the group.
4949
- `emails_disabled` (Boolean) Defaults to false. Disable email notifications.
50+
- `extra_shared_runners_minutes_limit` (Number) Can be set by administrators only. Additional CI/CD minutes for this group.
5051
- `lfs_enabled` (Boolean) Defaults to true. Enable/disable Large File Storage (LFS) for the projects in this group.
52+
- `membership_lock` (Boolean) Users cannot be added to projects in this group.
5153
- `mentions_disabled` (Boolean) Defaults to false. Disable the capability of a group from getting mentioned.
5254
- `parent_id` (Number) Id of the parent group (creates a nested group).
5355
- `prevent_forking_outside_group` (Boolean) Defaults to false. When enabled, users can not fork projects from this group to external namespaces.
5456
- `project_creation_level` (String) Defaults to maintainer. Determine if developers can create projects in the group.
5557
- `request_access_enabled` (Boolean) Defaults to false. Allow users to request member access.
5658
- `require_two_factor_authentication` (Boolean) Defaults to false. Require all users in this group to setup Two-factor authentication.
5759
- `share_with_group_lock` (Boolean) Defaults to false. Prevent sharing a project with another group within this group.
60+
- `shared_runners_minutes_limit` (Number) Can be set by administrators only. Maximum number of monthly CI/CD minutes for this group. Can be nil (default; inherit system default), 0 (unlimited), or > 0.
5861
- `subgroup_creation_level` (String) Defaults to owner. Allowed to create subgroups.
5962
- `two_factor_grace_period` (Number) Defaults to 48. Time before Two-factor authentication is enforced (in hours).
6063
- `visibility_level` (String) The group's visibility. Can be `private`, `internal`, or `public`.

‎docs/resources/pipeline_schedule_variable.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,8 @@ resource "gitlab_pipeline_schedule" "example" {
2424
}
2525
2626
resource "gitlab_pipeline_schedule_variable" "example" {
27-
project = gitlab_pipeline_schedule.project
28-
pipeline_schedule_id = gitlab_pipeline_schedule.id
27+
project = gitlab_pipeline_schedule.example.project
28+
pipeline_schedule_id = gitlab_pipeline_schedule.example.id
2929
key = "EXAMPLE_KEY"
3030
value = "example"
3131
}

0 commit comments

Comments
 (0)