Skip to content

Commit 9eed32c

Browse files
Update docs for v18.0.0 release
1 parent 60a2fbb commit 9eed32c

35 files changed

+221
-158
lines changed

CHANGELOG.md

+128-87
Large diffs are not rendered by default.

docs/data-sources/instance_service_account.md

+1
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ data "gitlab_instance_service_account" "example" {
3333

3434
### Read-Only
3535

36+
- `email` (String) The email of the user.
3637
- `id` (String) The ID of this Terraform resource. This matches the service account id.
3738
- `name` (String) The name of the user.
3839
- `username` (String) The username of the user.

docs/data-sources/project.md

-1
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,6 @@ Read-Only:
117117
- `cadence` (String)
118118
- `enabled` (Boolean)
119119
- `keep_n` (Number)
120-
- `name_regex` (String)
121120
- `name_regex_delete` (String)
122121
- `name_regex_keep` (String)
123122
- `next_run_at` (String)

docs/data-sources/project_issues.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -47,11 +47,11 @@ data "gitlab_project_issues" "all_with_foo" {
4747
- `labels` (List of String) Return issues with labels. Issues must have all labels to be returned. None lists all issues with no labels. Any lists all issues with at least one label. No+Label (Deprecated) lists all issues with no labels. Predefined names are case-insensitive.
4848
- `milestone` (String) The milestone title. None lists all issues with no milestone. Any lists all issues that have an assigned milestone.
4949
- `my_reaction_emoji` (String) Return issues reacted by the authenticated user by the given emoji. None returns issues not given a reaction. Any returns issues given at least one reaction.
50-
- `not_assignee_id` (List of Number) Return issues that do not match the assignee id.
51-
- `not_author_id` (List of Number) Return issues that do not match the author id.
50+
- `not_assignee_id` (Number) Return issues that do not match the assignee id.
51+
- `not_author_id` (Number) Return issues that do not match the author id.
5252
- `not_labels` (List of String) Return issues that do not match the labels.
5353
- `not_milestone` (String) Return issues that do not match the milestone.
54-
- `not_my_reaction_emoji` (List of String) Return issues not reacted by the authenticated user by the given emoji.
54+
- `not_my_reaction_emoji` (String) Return issues not reacted by the authenticated user by the given emoji.
5555
- `order_by` (String) Return issues ordered by. Valid values are `created_at`, `updated_at`, `priority`, `due_date`, `relative_position`, `label_priority`, `milestone_due`, `popularity`, `weight`. Default is created_at
5656
- `scope` (String) Return issues for the given scope. Valid values are `created_by_me`, `assigned_to_me`, `all`. Defaults to all.
5757
- `search` (String) Search project issues against their title and description

docs/data-sources/projects.md

-1
Original file line numberDiff line numberDiff line change
@@ -191,7 +191,6 @@ Read-Only:
191191
- `cadence` (String)
192192
- `enabled` (Boolean)
193193
- `keep_n` (Number)
194-
- `name_regex` (String)
195194
- `name_regex_delete` (String)
196195
- `name_regex_keep` (String)
197196
- `next_run_at` (String)

docs/resources/application_settings.md

+6-13
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ subcategory: ""
55
description: |-
66
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://gitlab.com/gitlab-org/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.
@@ -19,7 +19,7 @@ description: |-
1919
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://gitlab.com/gitlab-org/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`.
@@ -188,20 +188,14 @@ resource "gitlab_application_settings" "this" {
188188
- `grafana_url` (String) Grafana URL.
189189
- `gravatar_enabled` (Boolean) Enable Gravatar.
190190
- `group_owners_can_manage_default_branch_protection` (Boolean) Prevent overrides of default branch protection.
191-
- `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).
192191
- `help_page_hide_commercial_content` (Boolean) Hide marketing-related entries from help.
193192
- `help_page_support_url` (String) Alternate support URL for help page and help dropdown.
194193
- `help_page_text` (String) Custom text displayed on the help page.
195194
- `help_text` (String) GitLab server administrator information.
196195
- `hide_third_party_offers` (Boolean) Do not display offers from third parties in GitLab.
197196
- `home_page_url` (String) Redirect to this URL when not logged in.
198-
- `housekeeping_enabled` (Boolean) Enable or disable Git housekeeping.
199-
If enabled, requires either housekeeping_optimize_repository_period OR housekeeping_bitmaps_enabled, housekeeping_full_repack_period, housekeeping_gc_period, and housekeeping_incremental_repack_period.
200-
Options housekeeping_bitmaps_enabled, housekeeping_full_repack_period, housekeeping_gc_period, and housekeeping_incremental_repack_period are deprecated. Use housekeeping_optimize_repository_period instead.
201-
- `housekeeping_full_repack_period` (Number, Deprecated) Number of Git pushes after which an incremental git repack is run.
202-
- `housekeeping_gc_period` (Number, Deprecated) Number of Git pushes after which git gc is run.
203-
- `housekeeping_incremental_repack_period` (Number, Deprecated) Number of Git pushes after which an incremental git repack is run.
204-
- `housekeeping_optimize_repository_period` (Number) Number of Git pushes after which an incremental git repack is run.
197+
- `housekeeping_enabled` (Boolean) Enable or disable Git housekeeping. If enabled, requires housekeeping_optimize_repository_period.
198+
- `housekeeping_optimize_repository_period` (Number) Number of Git pushes after which an incremental git-repack is run.
205199
- `html_emails_enabled` (Boolean) Enable HTML emails.
206200
- `import_sources` (List of String) Sources to allow project import from. Valid values are: `github`, `bitbucket`, `bitbucket_server`, `fogbugz`, `git`, `gitlab_project`, `gitea`, `manifest`
207201
- `in_product_marketing_emails_enabled` (Boolean) Enable in-product marketing emails.
@@ -243,7 +237,7 @@ resource "gitlab_application_settings" "this" {
243237
- `mirror_max_capacity` (Number) Maximum number of mirrors that can be synchronizing at the same time.
244238
- `mirror_max_delay` (Number) Maximum time (in minutes) between updates that a mirror can have when scheduled to synchronize.
245239
- `npm_package_requests_forwarding` (Boolean) Use npmjs.org as a default remote repository when the package is not found in the GitLab Package Registry for npm.
246-
- `nuget_skip_metadata_url_validation` (Boolean) Indicates whether to skip metadata URL validation for the NuGet package. Introduced in GitLab 17.0.
240+
- `nuget_skip_metadata_url_validation` (Boolean) Indicates whether to skip metadata URL validation for the NuGet package.
247241
- `outbound_local_requests_whitelist` (List of String) Define a list of trusted domains or IP addresses to which local requests are allowed when local requests for hooks and services are disabled.
248242
- `package_metadata_purl_types` (List of Number) List of package registry metadata to sync. See the list of the available values (https://gitlab.com/gitlab-org/gitlab/-/blob/ace16c20d5da7c4928dd03fb139692638b557fe3/app/models/concerns/enums/package_metadata.rb#L5). Self-managed, Ultimate only.
249243
- `package_registry_allow_anyone_to_pull_option` (Boolean) Enable to allow anyone to pull from Package Registry visible and changeable.
@@ -279,8 +273,7 @@ resource "gitlab_application_settings" "this" {
279273
- `remember_me_enabled` (Boolean) Enable Remember me setting.
280274
- `repository_checks_enabled` (Boolean) GitLab periodically runs git fsck in all project and wiki repositories to look for silent disk corruption issues.
281275
- `repository_size_limit` (Number) Size limit per repository (MB).
282-
- `repository_storages` (List of String) (GitLab 13.0 and earlier) List of names of enabled storage paths, taken from gitlab.yml. New projects are created in one of these stores, chosen at random.
283-
- `repository_storages_weighted` (Map of Number) (GitLab 13.1 and later) Hash of names of taken from gitlab.yml to weights. New projects are created in one of these stores, chosen by a weighted random selection.
276+
- `repository_storages_weighted` (Map of Number) Hash of names taken from gitlab.yml to weights. New projects are created in one of these stores, chosen by a weighted random selection.
284277
- `require_admin_approval_after_user_signup` (Boolean) When enabled, any user that signs up for an account using the registration form is placed under a Pending approval state and has to be explicitly approved by an administrator.
285278
- `require_admin_two_factor_authentication` (Boolean) Allow administrators to require 2FA for all administrators on the instance.
286279
- `require_personal_access_token_expiry` (Boolean) When enabled, users must set an expiration date when creating a group or project access token, or a personal access token owned by a non-service account.

docs/resources/group.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@ page_title: "gitlab_group Resource - terraform-provider-gitlab"
44
subcategory: ""
55
description: |-
66
The gitlab_group resource allows to manage the lifecycle of a group.
7-
-> On GitLab SaaS, you must use the GitLab UI to create groups without a parent group. You cannot use this provider nor the API to do this.
7+
-> On GitLab.com, you cannot use the gitlab_group resource to create a top-level group https://docs.gitlab.com/user/group/#group-hierarchy. Instead, you must create a group https://docs.gitlab.com/user/group/#create-a-group in the UI, then import the group into your Terraform configuration. From here, you can manage the group using the Terraform Provider.
88
Upstream API: GitLab REST API docs https://docs.gitlab.com/api/groups/
99
---
1010

1111
# gitlab_group (Resource)
1212

1313
The `gitlab_group` resource allows to manage the lifecycle of a group.
1414

15-
-> On GitLab SaaS, you must use the GitLab UI to create groups without a parent group. You cannot use this provider nor the API to do this.
15+
-> On GitLab.com, you cannot use the `gitlab_group` resource to create a [top-level group](https://docs.gitlab.com/user/group/#group-hierarchy). Instead, you must [create a group](https://docs.gitlab.com/user/group/#create-a-group) in the UI, then import the group into your Terraform configuration. From here, you can manage the group using the Terraform Provider.
1616

1717
**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/groups/)
1818

docs/resources/group_access_token.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ resource "gitlab_group_variable" "example" {
4848

4949
- `group` (String) The ID or full path of the group.
5050
- `name` (String) The name of the group access token.
51-
- `scopes` (Set of String) The scopes of the group access token. Valid values are: `api`, `read_api`, `read_registry`, `write_registry`, `read_repository`, `write_repository`, `create_runner`, `manage_runner`, `ai_features`, `k8s_proxy`, `read_observability`, `write_observability`
51+
- `scopes` (Set of String) The scopes of the group access token. Valid values are: `api`, `read_api`, `read_registry`, `write_registry`, `read_virtual_registry`, `write_virtual_registry`, `read_repository`, `write_repository`, `create_runner`, `manage_runner`, `ai_features`, `k8s_proxy`, `read_observability`, `write_observability`, `self_rotate`
5252

5353
### Optional
5454

docs/resources/group_cluster.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@ page_title: "gitlab_group_cluster Resource - terraform-provider-gitlab"
44
subcategory: ""
55
description: |-
66
The gitlab_group_cluster resource allows to manage the lifecycle of a group cluster.
7-
~> This is deprecated GitLab feature since 14.5
7+
~> This is deprecated, due for removal in GitLab 19.0.
88
Upstream API: GitLab REST API docs https://docs.gitlab.com/api/group_clusters/
99
---
1010

1111
# gitlab_group_cluster (Resource)
1212

1313
The `gitlab_group_cluster` resource allows to manage the lifecycle of a group cluster.
1414

15-
~> This is deprecated GitLab feature since 14.5
15+
~> This is deprecated, due for removal in GitLab 19.0.
1616

1717
**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/group_clusters/)
1818

docs/resources/group_ldap_link.md

+4-5
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@ page_title: "gitlab_group_ldap_link Resource - terraform-provider-gitlab"
44
subcategory: ""
55
description: |-
66
The gitlab_group_ldap_link resource allows to manage the lifecycle of an LDAP integration with a group.
7-
Upstream API: GitLab REST API docs https://docs.gitlab.com/api/groups/#ldap-group-links
7+
Upstream API: GitLab REST API docs https://docs.gitlab.com/api/group_ldap_links/
88
---
99

1010
# gitlab_group_ldap_link (Resource)
1111

1212
The `gitlab_group_ldap_link` resource allows to manage the lifecycle of an LDAP integration with a group.
1313

14-
**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/groups/#ldap-group-links)
14+
**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/group_ldap_links/)
1515

1616
## Example Usage
1717

@@ -30,16 +30,15 @@ resource "gitlab_group_ldap_link" "test" {
3030
### Required
3131

3232
- `group` (String) The ID or URL-encoded path of the group
33+
- `group_access` (String) Minimum access level for members of the LDAP group. Valid values are: `no one`, `minimal`, `guest`, `planner`, `reporter`, `developer`, `maintainer`, `owner`
3334
- `ldap_provider` (String) The name of the LDAP provider as stored in the GitLab database. Note that this is NOT the value of the `label` attribute as shown in the web UI. In most cases this will be `ldapmain` but you may use the [LDAP check rake task](https://docs.gitlab.com/administration/raketasks/ldap/#check) for receiving the LDAP server name: `LDAP: ... Server: ldapmain`
3435

3536
### Optional
3637

37-
- `access_level` (String, Deprecated) Minimum access level for members of the LDAP group. Valid values are: `no one`, `minimal`, `guest`, `planner`, `reporter`, `developer`, `maintainer`, `owner`
3838
- `cn` (String) The CN of the LDAP group to link with. Required if `filter` is not provided.
3939
- `filter` (String) The LDAP filter for the group. Required if `cn` is not provided. Requires GitLab Premium or above.
4040
- `force` (Boolean) If true, then delete and replace an existing LDAP link if one exists. Will also remove an LDAP link if the parent group is not found.
41-
- `group_access` (String) Minimum access level for members of the LDAP group. Valid values are: `no one`, `minimal`, `guest`, `planner`, `reporter`, `developer`, `maintainer`, `owner`
42-
- `member_role_id` (Number) The ID of a custom member role. Only available for Ultimate instances. When using a custom role, the `group_access` must match the base role used to create the custom role.
41+
- `member_role_id` (Number) The ID of a custom member role. Only available for Ultimate instances. When using a custom role, the `group_access` must match the base role used to create the custom role. To remove a custom role and revert to a base role, set this value to `0`.
4342

4443
### Read-Only
4544

docs/resources/group_project_file_template.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ description: |-
99
For more information about which file types are available as templates, view
1010
GitLab's documentation https://docs.gitlab.com/user/group/custom_project_templates/
1111
-> This resource requires a GitLab Enterprise instance with a Premium license.
12-
Upstream API: GitLab REST API docs https://docs.gitlab.com/api/groups/#update-group
12+
Upstream API: GitLab REST API docs https://docs.gitlab.com/api/groups/#update-group-attributes
1313
---
1414

1515
# gitlab_group_project_file_template (Resource)
@@ -22,7 +22,7 @@ For more information about which file types are available as templates, view
2222

2323
-> This resource requires a GitLab Enterprise instance with a Premium license.
2424

25-
**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/groups/#update-group)
25+
**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/groups/#update-group-attributes)
2626

2727
## Example Usage
2828

docs/resources/group_saml_link.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@ page_title: "gitlab_group_saml_link Resource - terraform-provider-gitlab"
44
subcategory: ""
55
description: |-
66
The gitlab_group_saml_link resource allows to manage the lifecycle of an SAML integration with a group.
7-
Upstream API: GitLab REST API docs https://docs.gitlab.com/api/groups/#saml-group-links
7+
Upstream API: GitLab REST API docs https://docs.gitlab.com/api/saml/#saml-group-links
88
---
99

1010
# gitlab_group_saml_link (Resource)
1111

1212
The `gitlab_group_saml_link` resource allows to manage the lifecycle of an SAML integration with a group.
1313

14-
**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/groups/#saml-group-links)
14+
**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/saml/#saml-group-links)
1515

1616
## Example Usage
1717

docs/resources/group_service_account_access_token.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ resource "gitlab_group_service_account_access_token" "example_sa_token" {
8181

8282
- `group` (String) The ID or URL-encoded path of the group containing the service account. Must be a top level group.
8383
- `name` (String) The name of the personal access token.
84-
- `scopes` (Set of String) The scopes of the group service account access token. valid values are: `api`, `read_api`, `read_registry`, `write_registry`, `read_repository`, `write_repository`, `create_runner`, `manage_runner`, `ai_features`, `k8s_proxy`, `read_observability`, `write_observability`
84+
- `scopes` (Set of String) The scopes of the group service account access token. valid values are: `api`, `read_user`, `read_api`, `read_repository`, `write_repository`, `read_registry`, `write_registry`, `read_virtual_registry`, `write_virtual_registry`, `sudo`, `admin_mode`, `create_runner`, `manage_runner`, `ai_features`, `k8s_proxy`, `self_rotate`, `read_service_ping`
8585
- `user_id` (Number) The ID of a service account user.
8686

8787
### Optional

docs/resources/group_share_group.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ resource "gitlab_group_share_group" "test" {
3636
### Optional
3737

3838
- `expires_at` (String) Share expiration date. Format: `YYYY-MM-DD`
39-
- `member_role_id` (Number) The ID of a custom member role. Only available for Ultimate instances.
39+
- `member_role_id` (Number) The ID of a custom member role. Only available for Ultimate instances. If `member_role_id` is removed from the config, the group share will revert to a base role.
4040

4141
### Read-Only
4242

docs/resources/instance_cluster.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@ page_title: "gitlab_instance_cluster Resource - terraform-provider-gitlab"
44
subcategory: ""
55
description: |-
66
The gitlab_instance_cluster resource allows to manage the lifecycle of an instance cluster.
7-
~> This is deprecated GitLab feature since 14.5
7+
~> This is deprecated, due for removal in GitLab 19.0.
88
Upstream API: GitLab REST API docs https://docs.gitlab.com/api/instance_clusters/
99
---
1010

1111
# gitlab_instance_cluster (Resource)
1212

1313
The `gitlab_instance_cluster` resource allows to manage the lifecycle of an instance cluster.
1414

15-
~> This is deprecated GitLab feature since 14.5
15+
~> This is deprecated, due for removal in GitLab 19.0.
1616

1717
**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/instance_clusters/)
1818

0 commit comments

Comments
 (0)