Update docs for v16.0.0 release

Author: gitlab-terraform-provider-bot

CHANGELOG.md

@@ -1,3 +1,54 @@
+## 16.0.0 (2023-05-22)
+
+- This release was tested against GitLab 15.10, 15.11 and 16.0 for both CE and EE.
+- **Note:** this is a major release and breaks some interfaces in resources and data sources of 
+  this provider, but also drops support for older GitLab versions.
+
+BREAKING CHANGES:
+
+See [Terraform GitLab Provider Version 16.0 Upgrade Guide](https://registry.terraform.io/providers/gitlabhq/gitlab/latest/docs/guides/version-16.0-upgrade) for details.
+
+BREAKING CHANGES:
+
+- resource/gitlab_instance_variable: Change `value` attribute to non-sensitive ([!1521](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1521))
+- resource/gitlab_group_variable: Change `value` attribute to non-sensitive ([!1521](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1521))
+- resource/gitlab_project_variable: Change `value` attribute to non-sensitive ([!1521](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1521))
+- resource/gitlab_deploy_token: Change resource id format to `<token-type>:<type-id>:<token-id>` ([!1523](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1523))
+- resource/gitlab_deploy_key: Change resource id format to `<project>:<key-id>` ([!1522](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1522))
+- resource/gitlab_project_hook: Change resource id format to `<project>:<hook-id>` ([!1483](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1483))
+- resource/gitlab_group_label: Change resource id format to `<group>:<label-name>` ([!1525](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1525))
+- resource/gitlab_label: Rename resource to `gitlab_project_label` ([!1526](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1526))
+- resource/gitlab_project_label: Change resource id format to `<project>:<label-name>` ([!1526](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1526))
+- resource/gitlab_managed_license: Remove resource ([!1512](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1512))
+- resource/gitlab_pipeline_schedule_variable: Change resource id format to `<project>:<schedule-id>:<variable-id>` ([!1529](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1529))
+- resource/gitlab_repository_file: Remove support for auto-encoding logic ([!1530](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1530))
+- resource/gitlab_group_ldap_link: Change resource id format to `<group>:<provider>:[cn]:[filter]` ([!1527](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1527))
+- resource/gitlab_group_ldap_link: Rename `group_id` attribute to `group` ([!1532](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1532))
+- resource/gitlab_service_*: Rename `gitlab_service_*` resources to `gitlab_integration_*` ([!1534](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1534))
+- resource/gitlab_project: Remove `operations_access_level` ([!1548](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1548))
+- datasource/gitlab_project: Remove `operations_access_level` ([!1548](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1548))
+- datasource/gitlab_projects: Remove `operations_access_level` ([!1548](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1548))
+- resource/gitlab_pipeline_trigger: Change resource id format to `<project>:<trigger-id>` ([!1551](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1551))
+- resource/gitlab_pipeline_schedule: Change resource id format to `<project>:<schedule-id>` ([!1551](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1551))
+- resource/gitlab_project_freeze_period: Change `project_id` attribute to `project` ([!1553](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1553))
+- resource/gitlab_project_level_mr_approvals: Change `project_id` attribute to `project` ([!1553](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1553))
+- resource/gitlab_project_membership: Change `project_id` attribute to `project` ([!1553](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1553))
+- resource/gitlab_project_share_group: Change `project_id` attribute to `project` ([!1553](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1553))
+- resource/gitlab_project_access_token: Require `expires_at` attribute ([!1557](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1557))
+
+FEATURES:
+
+- resource/gitlab_instance_variable: Support `raw` attribute ([!1533](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1533))
+- resource/gitlab_group_variable: Support `raw` attribute ([!1533](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1533))
+- resource/gitlab_project_variable: Support `raw` attribute ([!1533](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1533))
+- datasource/gitlab_instance_variable: Support `raw` attribute ([!1533](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1533))
+- datasource/gitlab_group_variable: Support `raw` attribute ([!1533](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1533))
+- datasource/gitlab_project_variable: Support `raw` attribute ([!1533](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1533))
+
+IMPROVEMENTS:
+
+- resource/gitlab_project_environment: Wait for environment to stop before deleting it ([!1509](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/1509))
+
 ## 15.11.0 (2023-04-22)
 
 This release was tested against GitLab 15.9, 15.10 and 15.11 for both CE and EE.

docs/data-sources/group_variable.md

@@ -46,6 +46,7 @@ data "gitlab_group_variable" "bar" {
 - `id` (String) The ID of this resource.
 - `masked` (Boolean) If set to `true`, the value of the variable will be hidden in job logs. The value must meet the [masking requirements](https://docs.gitlab.com/ee/ci/variables/#masked-variables). Defaults to `false`.
 - `protected` (Boolean) If set to `true`, the variable will be passed only to pipelines running on protected branches and tags. Defaults to `false`.
+- `raw` (Boolean) Whether the variable is treated as a raw string. Default: false. When true, variables in the value are not expanded.
 - `value` (String) The value of the variable.
 - `variable_type` (String) The type of a variable. Valid values are: `env_var`, `file`. Default is `env_var`.
 

docs/data-sources/group_variables.md

@@ -53,6 +53,7 @@ Read-Only:
 - `key` (String)
 - `masked` (Boolean)
 - `protected` (Boolean)
+- `raw` (Boolean)
 - `value` (String)
 - `variable_type` (String)
 

docs/data-sources/instance_variable.md

@@ -33,6 +33,7 @@ data "gitlab_instance_variable" "foo" {
 - `id` (String) The ID of this resource.
 - `masked` (Boolean) If set to `true`, the value of the variable will be hidden in job logs. The value must meet the [masking requirements](https://docs.gitlab.com/ee/ci/variables/#masked-variables). Defaults to `false`.
 - `protected` (Boolean) If set to `true`, the variable will be passed only to pipelines running on protected branches and tags. Defaults to `false`.
+- `raw` (Boolean) Whether the variable is treated as a raw string. Default: false. When true, variables in the value are not expanded.
 - `value` (String) The value of the variable.
 - `variable_type` (String) The type of a variable. Valid values are: `env_var`, `file`. Default is `env_var`.
 

docs/data-sources/instance_variables.md

@@ -35,6 +35,7 @@ Read-Only:
 - `key` (String)
 - `masked` (Boolean)
 - `protected` (Boolean)
+- `raw` (Boolean)
 - `value` (String)
 - `variable_type` (String)
 

docs/data-sources/project.md

@@ -74,7 +74,6 @@ data "gitlab_project" "example" {
 - `monitor_access_level` (String) Set the monitor access level. Valid values are `disabled`, `private`, `enabled`.
 - `name` (String) The name of the project.
 - `namespace_id` (Number) The namespace (group or user) of the project. Defaults to your user.
-- `operations_access_level` (String) Set the operations access level. Valid values are `disabled`, `private`, `enabled`.
 - `path` (String) The path of the repository.
 - `pipelines_enabled` (Boolean) Enable pipelines for the project.
 - `printing_merge_request_link_enabled` (Boolean) Show link to create/view merge request when pushing from the command line

docs/data-sources/project_issue.md

@@ -16,17 +16,17 @@ The `gitlab_project_issue` data source allows to retrieve details about an issue
 ## Example Usage
 
 ```terraform
-data "gitlab_project" "foo" {
-  id = "foo/bar/baz"
-}
-
-data "gitlab_project_issue" "welcome_issue" {
-  project = data.gitlab_project.foo.id
-  iid     = 1
-}
-
-output "welcome_issue_web_url" {
-  value = data.gitlab_project_issue.web_url
+data "gitlab_project" "foo" {
+  path_with_namespace = "foo/bar/baz"
+}
+
+data "gitlab_project_issue" "welcome_issue" {
+  project = data.gitlab_project.foo.id
+  iid     = 1
+}
+
+output "welcome_issue_web_url" {
+  value = data.gitlab_project_issue.web_url
 }
 ```
 

docs/data-sources/project_variable.md

@@ -46,6 +46,7 @@ data "gitlab_project_variable" "bar" {
 - `id` (String) The ID of this resource.
 - `masked` (Boolean) If set to `true`, the value of the variable will be hidden in job logs. The value must meet the [masking requirements](https://docs.gitlab.com/ee/ci/variables/#masked-variables). Defaults to `false`.
 - `protected` (Boolean) If set to `true`, the variable will be passed only to pipelines running on protected branches and tags. Defaults to `false`.
+- `raw` (Boolean) Whether the variable is treated as a raw string. Default: false. When true, variables in the value are not expanded.
 - `value` (String) The value of the variable.
 - `variable_type` (String) The type of a variable. Valid values are: `env_var`, `file`. Default is `env_var`.
 

docs/data-sources/project_variables.md

@@ -53,6 +53,7 @@ Read-Only:
 - `masked` (Boolean)
 - `project` (String)
 - `protected` (Boolean)
+- `raw` (Boolean)
 - `value` (String)
 - `variable_type` (String)
 

docs/data-sources/projects.md

@@ -140,7 +140,6 @@ Read-Only:
 - `only_allow_merge_if_pipeline_succeeds` (Boolean)
 - `only_mirror_protected_branches` (Boolean)
 - `open_issues_count` (Number)
-- `operations_access_level` (String)
 - `owner` (List of Object) (see [below for nested schema](#nestedobjatt--projects--owner))
 - `packages_enabled` (Boolean)
 - `path` (String)

docs/guides/version-15.7-upgrade.md

@@ -11,7 +11,7 @@ the release cadence and versioning has been
 starting with 15.7 (22nd Dec 2022).
 
 The version bump from [`3.20.0`](https://registry.terraform.io/providers/gitlabhq/gitlab/3.20.0) to
-[`v15.7.0`](https://registry.terraform.io/providers/gitlabhq/gitlab/15.7.0) introduced a few breaking changes,
+[`15.7.0`](https://registry.terraform.io/providers/gitlabhq/gitlab/15.7.0) introduced a few breaking changes,
 which are described below.
 
 

docs/guides/version-16.0-upgrade.md

@@ -0,0 +1,84 @@
+---
+page_title: "Terraform GitLab Provider Version 16.0 Upgrade Guide"
+---
+
+# Upgrade to Terraform GitLab Provider Version 16.0
+
+The GitLab 16.0 major milestone introduced a couple of breaking changes that this
+release addresses. In addition, the provider itself breaks a bunch of interfaces 
+which may require actions on the users side. These are described below:
+
+## Change of resource id formats
+
+**Affected resources**:
+
+- `gitlab_deploy_token`
+- `gitlab_deploy_key`
+- `gitlab_project_hook`
+- `gitlab_group_label`
+- `gitlab_project_label`
+- `gitlab_pipeline_schedule_variable`
+- `gitlab_group_ldap_link`
+- `gitlab_pipeline_trigger`
+- `gitlab_pipeline_schedule`
+
+Some resource `id` formats weren't uniquly identifiable and didn't contain
+all the information to retrive a particular resource from the GitLab API
+given this id.
+
+Therefore, you may need to change your `terraform import` commands to use fully
+identifiable resource ids as described in the repsective docs.
+This may also affect any use of the `id` attribute (`gitlab_*.*.id`) access in 
+your Terraform configuration code.
+
+## Change variable `value` attribute to non-sensitive
+
+**Affected resources**:
+
+- `gitlab_instance_variable`
+- `gitlab_group_variable`
+- `gitlab_project_variable`
+
+The `value` attribute of the `gitlab_*_variable` resources has been changed 
+from `sensitive` to non-sensitive.
+
+Therefore, you may want to use the `sensitive()` or `nonsensitive()` Terraform functions.
+
+## Require `expires_at` attribute for Project Access Tokens
+
+The `expires_at` attribate for the `gitlab_project_access_token` resource is now required.
+
+## Change `project_id` attribute to `project`
+
+**Affected resources**:
+
+- `gitlab_project_freeze_period`
+- `gitlab_project_level_mr_approvals`
+- `gitlab_project_membership`
+- `gitlab_project_share_group`
+
+Some resources used a `project_id` attriute to identify a project by numerical id.
+This attribute has been removed in favor of a new `project` attribute which supports
+both numerical ids and full paths to the project to identify id.
+This aligns with the rest of the project-scoped resources.
+
+## Change `group_id` attribute to `group`
+
+- `gitlab_group_ldap_link`
+
+Some resources used a `group_id` attriute to identify a group by numerical id.
+This attribute has been removed in favor of a new `group` attribute which supports
+both numerical ids and full paths to the group to identify id.
+This aligns with the rest of the group-scoped resources.
+
+## Deprecate `gitlab_service_*` resources
+
+All the `gitlab_service_*` resources have been deprecated in favor 
+of the new `gitlab_integration_*` resources.
+Make sure to adapt to the new ones within the next 3 releases as we'll be 
+removing the `gitlab_service_*` resources with the upcoming 16.3 release.
+
+## Misc removals
+
+- The `gitlab_managed_license` resource has been removed. There is no longer an upstream GitLab API for it.
+- The `operations_access_level` attribute was removed from the `gitlab_project` resource and data sources.

docs/resources/deploy_key.md

@@ -41,6 +41,7 @@ resource "gitlab_deploy_key" "example" {
 
 ### Read-Only
 
+- `deploy_key_id` (Number) The id of the project deploy key.
 - `id` (String) The ID of this resource.
 
 ## Import

docs/resources/deploy_token.md

@@ -58,6 +58,7 @@ resource "gitlab_deploy_token" "example" {
 
 ### Read-Only
 
+- `deploy_token_id` (Number) The id of the deploy token.
 - `id` (String) The ID of this resource.
 - `token` (String, Sensitive) The secret token. This is only populated when creating a new deploy token. **Note**: The token is not available for imported resources.
 

docs/resources/group_label.md

@@ -40,6 +40,7 @@ resource "gitlab_group_label" "fixme" {
 ### Read-Only
 
 - `id` (String) The ID of this resource.
+- `label_id` (Number) The id of the group label.
 
 ## Import
 

docs/resources/group_ldap_link.md

@@ -29,13 +29,14 @@ resource "gitlab_group_ldap_link" "test" {
 
 ### Required
 
-- `cn` (String) The CN of the LDAP group to link with.
-- `group_id` (String) The id of the GitLab group.
+- `group` (String) The ID or URL-encoded path of the group
 - `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/ee/administration/raketasks/ldap.html#check) for receiving the LDAP server name: `LDAP: ... Server: ldapmain`
 
 ### Optional
 
 - `access_level` (String, Deprecated) Minimum access level for members of the LDAP group. Valid values are: `no one`, `minimal`, `guest`, `reporter`, `developer`, `maintainer`, `owner`, `master`
+- `cn` (String) The CN of the LDAP group to link with. Required if `filter` is not provided.
+- `filter` (String) The LDAP filter for the group. Required if `cn` is not provided. Requires GitLab Premium or above.
 - `force` (Boolean) If true, then delete and replace an existing LDAP link if one exists.
 - `group_access` (String) Minimum access level for members of the LDAP group. Valid values are: `no one`, `minimal`, `guest`, `reporter`, `developer`, `maintainer`, `owner`, `master`
 
@@ -48,6 +49,11 @@ resource "gitlab_group_ldap_link" "test" {
 Import is supported using the following syntax:
 
 ```shell
-# GitLab group ldap links can be imported using an id made up of `group_id:ldap_provider:cn`, e.g.
-terraform import gitlab_group_ldap_link.test "12345:ldapmain:testuser"
+# GitLab group ldap links can be imported using an id made up of `group_id:ldap_provider:cn:filter`. CN and Filter are mutually exclusive, so one will be missing.
+
+# If using the CN for the group link, the ID will end with a blank filter (":"). e.g.,
+terraform import gitlab_group_ldap_link.test "12345:ldapmain:testcn:"
+
+# If using the Filter for the group link, the ID will have two "::" in the middle due to having a blank CN. e.g.,
+terraform import gitlab_group_ldap_link.test "12345:ldapmain::testfilter"
 ```

docs/resources/group_variable.md

@@ -33,13 +33,14 @@ resource "gitlab_group_variable" "example" {
 
 - `group` (String) The name or id of the group.
 - `key` (String) The name of the variable.
-- `value` (String, Sensitive) The value of the variable.
+- `value` (String) The value of the variable.
 
 ### Optional
 
 - `environment_scope` (String) The environment scope of the variable. Defaults to all environment (`*`). Note that in Community Editions of Gitlab, values other than `*` will cause inconsistent plans.
 - `masked` (Boolean) If set to `true`, the value of the variable will be hidden in job logs. The value must meet the [masking requirements](https://docs.gitlab.com/ee/ci/variables/#masked-variables). Defaults to `false`.
 - `protected` (Boolean) If set to `true`, the variable will be passed only to pipelines running on protected branches and tags. Defaults to `false`.
+- `raw` (Boolean) Whether the variable is treated as a raw string. Default: false. When true, variables in the value are not expanded.
 - `variable_type` (String) The type of a variable. Valid values are: `env_var`, `file`. Default is `env_var`.
 
 ### Read-Only

docs/resources/instance_variable.md

@@ -30,12 +30,13 @@ resource "gitlab_instance_variable" "example" {
 ### Required
 
 - `key` (String) The name of the variable.
-- `value` (String, Sensitive) The value of the variable.
+- `value` (String) The value of the variable.
 
 ### Optional
 
 - `masked` (Boolean) If set to `true`, the value of the variable will be hidden in job logs. The value must meet the [masking requirements](https://docs.gitlab.com/ee/ci/variables/#masked-variables). Defaults to `false`.
 - `protected` (Boolean) If set to `true`, the variable will be passed only to pipelines running on protected branches and tags. Defaults to `false`.
+- `raw` (Boolean) Whether the variable is treated as a raw string. Default: false. When true, variables in the value are not expanded.
 - `variable_type` (String) The type of a variable. Valid values are: `env_var`, `file`. Default is `env_var`.
 
 ### Read-Only