From d1cad484b172a69d5508595279c72bbdbe050385 Mon Sep 17 00:00:00 2001 From: gitlab-terraform-provider-bot Date: Thu, 20 Feb 2025 22:11:04 +0000 Subject: [PATCH] Update docs for v17.9.0 release --- CHANGELOG.md | 38 +++++ docs/data-sources/application.md | 4 +- docs/data-sources/branch.md | 4 +- docs/data-sources/cluster_agent.md | 7 +- docs/data-sources/cluster_agents.md | 7 +- docs/data-sources/compliance_framework.md | 4 +- docs/data-sources/current_user.md | 4 +- docs/data-sources/group.md | 4 +- .../group_billable_member_memberships.md | 6 +- docs/data-sources/group_hook.md | 4 +- docs/data-sources/group_hooks.md | 4 +- docs/data-sources/group_ids.md | 4 +- docs/data-sources/group_membership.md | 24 ++-- docs/data-sources/group_provisioned_users.md | 4 +- docs/data-sources/group_service_account.md | 11 +- docs/data-sources/group_subgroups.md | 4 +- docs/data-sources/group_variable.md | 12 +- docs/data-sources/group_variables.md | 6 +- docs/data-sources/groups.md | 4 +- docs/data-sources/instance_deploy_keys.md | 4 +- docs/data-sources/instance_service_account.md | 38 +++++ docs/data-sources/instance_variable.md | 6 +- docs/data-sources/instance_variables.md | 4 +- docs/data-sources/metadata.md | 6 +- docs/data-sources/pipeline_schedule.md | 4 +- docs/data-sources/pipeline_schedules.md | 4 +- docs/data-sources/project.md | 10 +- docs/data-sources/project_branches.md | 4 +- docs/data-sources/project_environments.md | 4 +- docs/data-sources/project_hook.md | 4 +- docs/data-sources/project_hooks.md | 4 +- docs/data-sources/project_ids.md | 4 +- docs/data-sources/project_issue.md | 4 +- docs/data-sources/project_issues.md | 8 +- docs/data-sources/project_membership.md | 4 +- docs/data-sources/project_merge_request.md | 4 +- docs/data-sources/project_milestone.md | 4 +- docs/data-sources/project_milestones.md | 6 +- docs/data-sources/project_protected_branch.md | 4 +- .../project_protected_branches.md | 4 +- docs/data-sources/project_protected_tag.md | 4 +- docs/data-sources/project_protected_tags.md | 4 +- docs/data-sources/project_tag.md | 4 +- docs/data-sources/project_tags.md | 4 +- docs/data-sources/project_variable.md | 6 +- docs/data-sources/project_variables.md | 4 +- docs/data-sources/projects.md | 16 +-- docs/data-sources/release.md | 4 +- docs/data-sources/release_link.md | 10 +- docs/data-sources/release_links.md | 4 +- docs/data-sources/repository_file.md | 6 +- docs/data-sources/repository_tree.md | 4 +- docs/data-sources/runners.md | 4 +- docs/data-sources/user.md | 14 +- docs/data-sources/user_sshkeys.md | 4 +- docs/data-sources/users.md | 4 +- docs/development/CreatingANewResource.md | 4 +- docs/index.md | 18 ++- docs/resources/application.md | 4 +- docs/resources/application_settings.md | 84 +++++------ docs/resources/branch.md | 4 +- docs/resources/branch_protection.md | 4 +- docs/resources/cluster_agent.md | 13 +- docs/resources/cluster_agent_token.md | 7 +- docs/resources/compliance_framework.md | 4 +- docs/resources/deploy_key.md | 4 +- docs/resources/deploy_key_enable.md | 4 +- docs/resources/deploy_token.md | 4 +- docs/resources/global_level_notifications.md | 4 +- docs/resources/group.md | 10 +- docs/resources/group_access_token.md | 12 +- docs/resources/group_badge.md | 8 +- docs/resources/group_cluster.md | 4 +- docs/resources/group_custom_attribute.md | 4 +- docs/resources/group_epic_board.md | 4 +- docs/resources/group_hook.md | 4 +- docs/resources/group_issue_board.md | 4 +- docs/resources/group_label.md | 6 +- docs/resources/group_ldap_link.md | 6 +- docs/resources/group_membership.md | 12 +- docs/resources/group_project_file_template.md | 8 +- docs/resources/group_protected_environment.md | 4 +- docs/resources/group_saml_link.md | 4 +- .../group_security_policy_attachment.md | 8 +- docs/resources/group_service_account.md | 4 +- .../group_service_account_access_token.md | 4 +- docs/resources/group_share_group.md | 4 +- docs/resources/group_variable.md | 29 ++-- docs/resources/instance_cluster.md | 4 +- docs/resources/instance_service_account.md | 42 +++++- docs/resources/instance_variable.md | 6 +- .../integration_custom_issue_tracker.md | 4 +- docs/resources/integration_emails_on_push.md | 4 +- docs/resources/integration_external_wiki.md | 4 +- docs/resources/integration_github.md | 4 +- docs/resources/integration_jenkins.md | 4 +- docs/resources/integration_jira.md | 6 +- docs/resources/integration_mattermost.md | 4 +- docs/resources/integration_microsoft_teams.md | 4 +- docs/resources/integration_pipelines_email.md | 4 +- docs/resources/integration_slack.md | 4 +- docs/resources/integration_telegram.md | 6 +- docs/resources/label.md | 4 +- docs/resources/member_role.md | 10 +- docs/resources/pages_domain.md | 8 +- docs/resources/personal_access_token.md | 12 +- docs/resources/pipeline_schedule.md | 4 +- docs/resources/pipeline_schedule_variable.md | 4 +- docs/resources/pipeline_trigger.md | 4 +- docs/resources/project.md | 14 +- docs/resources/project_access_token.md | 12 +- docs/resources/project_approval_rule.md | 4 +- docs/resources/project_badge.md | 4 +- docs/resources/project_cluster.md | 4 +- .../resources/project_compliance_framework.md | 4 +- .../project_compliance_frameworks.md | 4 +- docs/resources/project_custom_attribute.md | 4 +- docs/resources/project_environment.md | 4 +- docs/resources/project_freeze_period.md | 4 +- docs/resources/project_hook.md | 5 +- docs/resources/project_issue.md | 4 +- docs/resources/project_issue_board.md | 4 +- docs/resources/project_job_token_scope.md | 16 ++- docs/resources/project_job_token_scopes.md | 4 +- docs/resources/project_label.md | 4 +- docs/resources/project_level_mr_approvals.md | 4 +- docs/resources/project_level_notifications.md | 4 +- docs/resources/project_membership.md | 5 +- docs/resources/project_milestone.md | 4 +- docs/resources/project_mirror.md | 13 +- .../project_protected_environment.md | 4 +- docs/resources/project_push_rules.md | 4 +- docs/resources/project_runner_enablement.md | 4 +- .../project_security_policy_attachment.md | 8 +- docs/resources/project_share_group.md | 4 +- docs/resources/project_tag.md | 4 +- docs/resources/project_variable.md | 21 ++- docs/resources/project_wiki_page.md | 64 +++++++++ docs/resources/release.md | 133 ++++++++++++++++++ docs/resources/release_link.md | 10 +- docs/resources/repository_file.md | 6 +- docs/resources/runner.md | 6 +- .../resources/service_custom_issue_tracker.md | 4 +- docs/resources/service_emails_on_push.md | 4 +- docs/resources/service_external_wiki.md | 4 +- docs/resources/service_github.md | 4 +- docs/resources/service_jira.md | 6 +- docs/resources/service_microsoft_teams.md | 4 +- docs/resources/service_pipelines_email.md | 4 +- docs/resources/service_slack.md | 4 +- docs/resources/system_hook.md | 7 +- docs/resources/tag_protection.md | 4 +- docs/resources/topic.md | 4 +- docs/resources/user.md | 6 +- docs/resources/user_custom_attribute.md | 4 +- docs/resources/user_gpgkey.md | 4 +- docs/resources/user_impersonation_token.md | 4 +- docs/resources/user_runner.md | 10 +- docs/resources/user_sshkey.md | 4 +- docs/resources/value_stream_analytics.md | 8 +- 160 files changed, 814 insertions(+), 496 deletions(-) create mode 100644 docs/data-sources/instance_service_account.md create mode 100644 docs/resources/project_wiki_page.md create mode 100644 docs/resources/release.md diff --git a/CHANGELOG.md b/CHANGELOG.md index d0c15b26b..10b337fbc 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,41 @@ +## 17.9.0 (2025-02-20) + +This release was tested against GitLab 17.9, 17.8, and 17.7 for both CE and EE + +### KNOWN ISSUES (1 change) + +- resource/gitlab_integration_jira: `comment_on_event_enabled` isn't persisting properly to the underlying integration. This appears to be an upstream issue, but can be tracked [here](https://gitlab.com/gitlab-org/gitlab/-/issues/520330). This will cause an immediate `plan` after `apply` if that attribute is included in the config. Removing the attribute from the config temporarily will allow it to be modified via the UI until this issue is resolved. + +### FEATURES (3 changes) + +- resource/gitlab_project_release: [Add a new resource for managing project releases](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/93b023aa30ef1038eb8c153f601678aa0fc4f7b1) by @heidi.berry ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2277)) +- resource/gitlab_wiki_page: [Add a new wiki page resource](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/bb77788364f15abd4140766ef6a0bb97011d9839) by @nursultanryskulov1 ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2219)) +- datasource/gitlab_instance_service_account: [Add a new instance service account datasource](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/5630deca25de2f741841ed2b9a94a4d163bf06c1) by @ipsavitsky234 ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2271)) + +### IMPROVEMENTS (8 changes) + +- resource/gitlab_group_variable: [Added support for `hidden` variables](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/524765fe53d36fc11ae24bb9dc08c2bbf6f2a077) by @yogeshlonkar ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2237)) +- resource/gitlab_member_role: [Align custom permissions to current API options (adds 5 new permissions to the provider)](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/7ce852f435aba9a64025047835003f5da5771386) by @PatrickRice ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2280)) +- resource/gitlab_project_job_token_scope: [Add support for `groupd_id`](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/cd6c9e62237794406e1595d127ae7ed5c0dcbc08) by @dc-tec ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2290)) +- resource/gitlab_project_hook: [Add support for `resource_access_token_events`](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/7a124e9ca25204232f5e2288e3f9c3686fcd2c69) by @dc-tec ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2292)) +- resource/gitlab_project_membership: [Add custom role support to project membership via `member_role_id`](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/e91dc20a440b699e6ac677397fd398b36f972746) by @mness ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2272)) +- resource/gitlab_instance_service_account: [Add `gitlab_instance_service_account` documentation](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/136bfbe8e2147f5a0ca97eb12a445013020de64a) by @ipsavitsky234 ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2270)) +- [Update Documentation Links to align to new API documentation Launch](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/8a550b86f57da691125bc1f1669e43a255912391) by @Taucher2003 ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2328)) +- [Update the CONTRIBUTING.md docs to fix links and provide better development instructions](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/74dfef50d5c9118f1e673786d69ee9a5027e066e) by @jtymes ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2274)) + +### BUG FIXES (5 changes) + +- resource/gitlab_integration_jira: [Fix issue where `comment_on_event_enabled` causes a plan after apply when not defined in the config](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/7ced3cb22e9d3d2262e6133bc6024e9e8638c658) by @PatrickRice ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2332)) +- resource/gitlab_group_service_account_access_token: [Fix an error when deleting an expired service account access token using a non-admin user](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/026c696d905c03426545398eba6cacf7621aaa92) by @heidi.berry ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2287)) +- resource/gitlab_group_service_account_access_token: [Fix an error when rotating a service account access token that would cause an invalid `id` attribute](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/537004cef0a1c54aa040f7779e98eddfa5a27e44) by @PatrickRice ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2282)) +- resource/gitlab_value_stream_analytics: [Fix an error with label validation, fixed typo in one event name](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/8a0918901c28ae809ad3943d302df70e0ed58054) by @calee1 ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2289)) +- datasource/gitlab_group_service_account: [Set name and username in group service accounts as read-only to align with API](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/698ffdcaaec2a797edc53299134fa98aeee4190e) by @ipsavitsky234 ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2286)) + +### Maintenance (2 changes) + +- [Remove documentation related to very old GitLab versions](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/9ec88d9245d220438234920ff91458235a152f73) by @heidi.berry ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2311)) +- [Update Documentation to include explicit version support policies](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/commit/39f048e4d796574e5e53a809c4c1148d5554fd2f) by @heidi.berry ([merge request](https://gitlab.com/gitlab-org/terraform-provider-gitlab/-/merge_requests/2312)) + ## 17.8.0 (2025-01-16) This release was tested against GitLab 17.8, 17.7, and 17.6 for both CE and EE diff --git a/docs/data-sources/application.md b/docs/data-sources/application.md index aa6b2b198..07f6cb68f 100644 --- a/docs/data-sources/application.md +++ b/docs/data-sources/application.md @@ -4,14 +4,14 @@ page_title: "gitlab_application Data Source - terraform-provider-gitlab" subcategory: "" description: |- The gitlab_application data source retrieves information about a gitlab application. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/applications.html + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/applications/ --- # gitlab_application (Data Source) The `gitlab_application` data source retrieves information about a gitlab application. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/applications.html) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/applications/) ## Example Usage diff --git a/docs/data-sources/branch.md b/docs/data-sources/branch.md index 9d566f3fd..ae65e6753 100644 --- a/docs/data-sources/branch.md +++ b/docs/data-sources/branch.md @@ -4,14 +4,14 @@ page_title: "gitlab_branch Data Source - terraform-provider-gitlab" subcategory: "" description: |- The gitlab_branch data source allows details of a repository branch to be retrieved by its name and project. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/branches.html#get-single-repository-branch + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/branches/#get-single-repository-branch --- # gitlab_branch (Data Source) The `gitlab_branch` data source allows details of a repository branch to be retrieved by its name and project. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/branches.html#get-single-repository-branch) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/branches/#get-single-repository-branch) ## Example Usage diff --git a/docs/data-sources/cluster_agent.md b/docs/data-sources/cluster_agent.md index 2b3219605..0223e6afd 100644 --- a/docs/data-sources/cluster_agent.md +++ b/docs/data-sources/cluster_agent.md @@ -4,17 +4,14 @@ page_title: "gitlab_cluster_agent Data Source - terraform-provider-gitlab" subcategory: "" description: |- The gitlab_cluster_agent data source allows to retrieve details about a GitLab Agent for Kubernetes. - -> Requires at least GitLab 14.10 - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/cluster_agents.html + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/cluster_agents/ --- # gitlab_cluster_agent (Data Source) The `gitlab_cluster_agent` data source allows to retrieve details about a GitLab Agent for Kubernetes. --> Requires at least GitLab 14.10 - -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/cluster_agents.html) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/cluster_agents/) ## Example Usage diff --git a/docs/data-sources/cluster_agents.md b/docs/data-sources/cluster_agents.md index 45ad50696..4f426fdbd 100644 --- a/docs/data-sources/cluster_agents.md +++ b/docs/data-sources/cluster_agents.md @@ -4,17 +4,14 @@ page_title: "gitlab_cluster_agents Data Source - terraform-provider-gitlab" subcategory: "" description: |- The gitlab_cluster_agents data source allows details of GitLab Agents for Kubernetes in a project. - -> Requires at least GitLab 14.10 - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/cluster_agents.html + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/cluster_agents/ --- # gitlab_cluster_agents (Data Source) The `gitlab_cluster_agents` data source allows details of GitLab Agents for Kubernetes in a project. --> Requires at least GitLab 14.10 - -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/cluster_agents.html) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/cluster_agents/) ## Example Usage diff --git a/docs/data-sources/compliance_framework.md b/docs/data-sources/compliance_framework.md index 3afe13231..eb707c5c8 100644 --- a/docs/data-sources/compliance_framework.md +++ b/docs/data-sources/compliance_framework.md @@ -4,14 +4,14 @@ page_title: "gitlab_compliance_framework Data Source - terraform-provider-gitlab subcategory: "" description: |- The gitlab_compliance_framework data source allows details of a compliance framework to be retrieved by its name and the namespace it belongs to. - Upstream API: GitLab GraphQL API docs https://docs.gitlab.com/ee/api/graphql/reference/#querynamespace + Upstream API: GitLab GraphQL API docs https://docs.gitlab.com/api/graphql/reference/#querynamespace --- # gitlab_compliance_framework (Data Source) The `gitlab_compliance_framework` data source allows details of a compliance framework to be retrieved by its name and the namespace it belongs to. -**Upstream API**: [GitLab GraphQL API docs](https://docs.gitlab.com/ee/api/graphql/reference/#querynamespace) +**Upstream API**: [GitLab GraphQL API docs](https://docs.gitlab.com/api/graphql/reference/#querynamespace) ## Example Usage diff --git a/docs/data-sources/current_user.md b/docs/data-sources/current_user.md index 1e714bc44..6e27cfbc3 100644 --- a/docs/data-sources/current_user.md +++ b/docs/data-sources/current_user.md @@ -4,14 +4,14 @@ page_title: "gitlab_current_user Data Source - terraform-provider-gitlab" subcategory: "" description: |- The gitlab_current_user data source allows details of the current user (determined by token provider attribute) to be retrieved. - Upstream API: GitLab GraphQL API docs https://docs.gitlab.com/ee/api/graphql/reference/index.html#querycurrentuser + Upstream API: GitLab GraphQL API docs https://docs.gitlab.com/api/graphql/reference/index/#querycurrentuser --- # gitlab_current_user (Data Source) The `gitlab_current_user` data source allows details of the current user (determined by `token` provider attribute) to be retrieved. -**Upstream API**: [GitLab GraphQL API docs](https://docs.gitlab.com/ee/api/graphql/reference/index.html#querycurrentuser) +**Upstream API**: [GitLab GraphQL API docs](https://docs.gitlab.com/api/graphql/reference/index/#querycurrentuser) ## Example Usage diff --git a/docs/data-sources/group.md b/docs/data-sources/group.md index cd4f3c228..77e812599 100644 --- a/docs/data-sources/group.md +++ b/docs/data-sources/group.md @@ -4,14 +4,14 @@ page_title: "gitlab_group Data Source - terraform-provider-gitlab" subcategory: "" description: |- The gitlab_group data source allows details of a group to be retrieved by its id or full path. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/groups.html#details-of-a-group + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/groups/#details-of-a-group --- # gitlab_group (Data Source) The `gitlab_group` data source allows details of a group to be retrieved by its id or full path. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/groups.html#details-of-a-group) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/groups/#details-of-a-group) ## Example Usage diff --git a/docs/data-sources/group_billable_member_memberships.md b/docs/data-sources/group_billable_member_memberships.md index 32622ca59..64514b46d 100644 --- a/docs/data-sources/group_billable_member_memberships.md +++ b/docs/data-sources/group_billable_member_memberships.md @@ -7,7 +7,7 @@ description: |- -> You must be an administrator! ~> When using the email attribute, an exact match is not guaranteed. The most related match will be returned. Starting with GitLab 16.6, the most related match will prioritize an exact match if one is available. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/members.html#list-memberships-for-a-billable-member-of-a-group + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/members/#list-memberships-for-a-billable-member-of-a-group --- # gitlab_group_billable_member_memberships (Data Source) @@ -19,7 +19,7 @@ The `gitlab_group_billable_member_memberships` data source allows (sub)group- an ~> When using the `email` attribute, an exact match is not guaranteed. The most related match will be returned. Starting with GitLab 16.6, the most related match will prioritize an exact match if one is available. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/members.html#list-memberships-for-a-billable-member-of-a-group) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/members/#list-memberships-for-a-billable-member-of-a-group) ## Example Usage @@ -48,7 +48,7 @@ data "gitlab_group_billable_member_memberships" "test_user_membership" { Read-Only: -- `access_level` (String) Access-level of the member. For details see: https://docs.gitlab.com/ee/api/access_requests.html#valid-access-levels +- `access_level` (String) Access-level of the member. For details see: https://docs.gitlab.com/api/access_requests/#valid-access-levels - `created_at` (String) Datetime when the membership was first added. - `expires_at` (String) Date when the membership will end. - `id` (Number) The id of the membership. diff --git a/docs/data-sources/group_hook.md b/docs/data-sources/group_hook.md index b7c654206..470681c95 100644 --- a/docs/data-sources/group_hook.md +++ b/docs/data-sources/group_hook.md @@ -4,14 +4,14 @@ page_title: "gitlab_group_hook Data Source - terraform-provider-gitlab" subcategory: "" description: |- The gitlab_group_hook data source allows to retrieve details about a hook in a group. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/groups.html#get-group-hook + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/groups/#get-group-hook --- # gitlab_group_hook (Data Source) The `gitlab_group_hook` data source allows to retrieve details about a hook in a group. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/groups.html#get-group-hook) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/groups/#get-group-hook) ## Example Usage diff --git a/docs/data-sources/group_hooks.md b/docs/data-sources/group_hooks.md index 26882461c..dee146c9d 100644 --- a/docs/data-sources/group_hooks.md +++ b/docs/data-sources/group_hooks.md @@ -4,14 +4,14 @@ page_title: "gitlab_group_hooks Data Source - terraform-provider-gitlab" subcategory: "" description: |- The gitlab_group_hooks data source allows to retrieve details about hooks in a group. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/groups.html#list-group-hooks + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/groups/#list-group-hooks --- # gitlab_group_hooks (Data Source) The `gitlab_group_hooks` data source allows to retrieve details about hooks in a group. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/groups.html#list-group-hooks) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/groups/#list-group-hooks) ## Example Usage diff --git a/docs/data-sources/group_ids.md b/docs/data-sources/group_ids.md index e0b8621bf..89a0fe2c2 100644 --- a/docs/data-sources/group_ids.md +++ b/docs/data-sources/group_ids.md @@ -4,14 +4,14 @@ page_title: "gitlab_group_ids Data Source - terraform-provider-gitlab" subcategory: "" description: |- The gitlab_group_ids data source identification information for a given group, allowing a user to translate a full path or ID into the GraphQL ID of the group. - Upstream API: GitLab GraphQL API docs https://docs.gitlab.com/ee/api/graphql/reference/#querygroup + Upstream API: GitLab GraphQL API docs https://docs.gitlab.com/api/graphql/reference/#querygroup --- # gitlab_group_ids (Data Source) The `gitlab_group_ids` data source identification information for a given group, allowing a user to translate a full path or ID into the GraphQL ID of the group. -**Upstream API**: [GitLab GraphQL API docs](https://docs.gitlab.com/ee/api/graphql/reference/#querygroup) +**Upstream API**: [GitLab GraphQL API docs](https://docs.gitlab.com/api/graphql/reference/#querygroup) ## Example Usage diff --git a/docs/data-sources/group_membership.md b/docs/data-sources/group_membership.md index f7142dcb7..35b922c5a 100644 --- a/docs/data-sources/group_membership.md +++ b/docs/data-sources/group_membership.md @@ -4,14 +4,14 @@ page_title: "gitlab_group_membership Data Source - terraform-provider-gitlab" subcategory: "" description: |- The gitlab_group_membership data source allows to list and filter all members of a group specified by either its id or full path. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/members.html#list-all-members-of-a-group-or-project + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/members/#list-all-members-of-a-group-or-project --- # gitlab_group_membership (Data Source) The `gitlab_group_membership` data source allows to list and filter all members of a group specified by either its id or full path. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/members.html#list-all-members-of-a-group-or-project) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/members/#list-all-members-of-a-group-or-project) ## Example Usage @@ -39,19 +39,19 @@ data "gitlab_group_membership" "example" { ### Read-Only -- `id` (String) The ID of this resource. -- `members` (List of Object) The list of group members. (see [below for nested schema](#nestedatt--members)) +- `id` (String) The ID of the group membership. In the format of ``. +- `members` (Attributes List) The list of group members. (see [below for nested schema](#nestedatt--members)) ### Nested Schema for `members` Read-Only: -- `access_level` (String) -- `avatar_url` (String) -- `expires_at` (String) -- `id` (Number) -- `name` (String) -- `state` (String) -- `username` (String) -- `web_url` (String) +- `access_level` (String) The level of access to the group. +- `avatar_url` (String) The avatar URL of the user. +- `expires_at` (String) Expiration date for the group membership. +- `id` (Number) The unique id assigned to the user by the gitlab server. +- `name` (String) The name of the user. +- `state` (String) Whether the user is active or blocked. +- `username` (String) The username of the user. +- `web_url` (String) User's website URL. diff --git a/docs/data-sources/group_provisioned_users.md b/docs/data-sources/group_provisioned_users.md index 193a76084..c265ee831 100644 --- a/docs/data-sources/group_provisioned_users.md +++ b/docs/data-sources/group_provisioned_users.md @@ -4,14 +4,14 @@ page_title: "gitlab_group_provisioned_users Data Source - terraform-provider-git subcategory: "" description: |- The gitlab_group_provisioned_users data source allows details of the provisioned users of a given group. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/groups.html#list-provisioned-users + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/groups/#list-provisioned-users --- # gitlab_group_provisioned_users (Data Source) The `gitlab_group_provisioned_users` data source allows details of the provisioned users of a given group. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/groups.html#list-provisioned-users) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/groups/#list-provisioned-users) diff --git a/docs/data-sources/group_service_account.md b/docs/data-sources/group_service_account.md index 1c911f850..12647aac9 100644 --- a/docs/data-sources/group_service_account.md +++ b/docs/data-sources/group_service_account.md @@ -4,14 +4,14 @@ page_title: "gitlab_group_service_account Data Source - terraform-provider-gitla subcategory: "" description: |- The gitlab_group_service_account data source retrieves information about a gitlab service account for a group. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/group_service_accounts.html#list-service-account-users + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/group_service_accounts/#list-service-account-users --- # gitlab_group_service_account (Data Source) The `gitlab_group_service_account` data source retrieves information about a gitlab service account for a group. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/group_service_accounts.html#list-service-account-users) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/group_service_accounts/#list-service-account-users) @@ -23,11 +23,8 @@ The `gitlab_group_service_account` data source retrieves information about a git - `group` (String) The ID or URL-encoded path of the target group. Must be a top-level group. - `service_account_id` (String) The service account id. -### Optional - -- `name` (String) The name of the user. If not specified, the default Service account user name is used. -- `username` (String) The username of the user. If not specified, it's automatically generated. - ### Read-Only - `id` (String) The ID of this Terraform resource. In the format of `:`. +- `name` (String) The name of the user. If not specified, the default Service account user name is used. +- `username` (String) The username of the user. If not specified, it's automatically generated. diff --git a/docs/data-sources/group_subgroups.md b/docs/data-sources/group_subgroups.md index 3d711bc6f..0ef4b3e43 100644 --- a/docs/data-sources/group_subgroups.md +++ b/docs/data-sources/group_subgroups.md @@ -4,14 +4,14 @@ page_title: "gitlab_group_subgroups Data Source - terraform-provider-gitlab" subcategory: "" description: |- The gitlab_group_subgroups data source allows to get subgroups of a group. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/groups.html#list-a-groups-subgroups + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/groups/#list-a-groups-subgroups --- # gitlab_group_subgroups (Data Source) The `gitlab_group_subgroups` data source allows to get subgroups of a group. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/groups.html#list-a-groups-subgroups) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/groups/#list-a-groups-subgroups) ## Example Usage diff --git a/docs/data-sources/group_variable.md b/docs/data-sources/group_variable.md index e92f76754..94eac070b 100644 --- a/docs/data-sources/group_variable.md +++ b/docs/data-sources/group_variable.md @@ -4,14 +4,14 @@ page_title: "gitlab_group_variable Data Source - terraform-provider-gitlab" subcategory: "" description: |- The gitlab_group_variable data source allows to retrieve details about a group-level CI/CD variable. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/group_level_variables.html + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/group_level_variables/ --- # gitlab_group_variable (Data Source) The `gitlab_group_variable` data source allows to retrieve details about a group-level CI/CD variable. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/group_level_variables.html) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/group_level_variables/) ## Example Usage @@ -44,9 +44,9 @@ data "gitlab_group_variable" "bar" { ### Read-Only - `description` (String) The description of the variable. -- `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`. +- `id` (String) The ID of this Terraform resource. In the format of `::`. +- `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/ci/variables/#masked-variables). +- `protected` (Boolean) If set to `true`, the variable will be passed only to pipelines running on protected branches and tags - `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`. +- `variable_type` (String) The type of a variable. Valid values are: `env_var`, `file`. diff --git a/docs/data-sources/group_variables.md b/docs/data-sources/group_variables.md index 87ed82718..2ff7051f8 100644 --- a/docs/data-sources/group_variables.md +++ b/docs/data-sources/group_variables.md @@ -4,14 +4,14 @@ page_title: "gitlab_group_variables Data Source - terraform-provider-gitlab" subcategory: "" description: |- The gitlab_group_variables data source allows to retrieve all group-level CI/CD variables. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/group_level_variables.html + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/group_level_variables/ --- # gitlab_group_variables (Data Source) The `gitlab_group_variables` data source allows to retrieve all group-level CI/CD variables. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/group_level_variables.html) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/group_level_variables/) ## Example Usage @@ -40,7 +40,7 @@ data "gitlab_group_variables" "staging_vars" { ### Read-Only -- `id` (String) The ID of this resource. +- `id` (String) The ID of this Terraform resource. In the format of `:`. - `variables` (List of Object) The list of variables returned by the search (see [below for nested schema](#nestedatt--variables)) diff --git a/docs/data-sources/groups.md b/docs/data-sources/groups.md index 8412f48ee..71c3fb0bd 100644 --- a/docs/data-sources/groups.md +++ b/docs/data-sources/groups.md @@ -6,7 +6,7 @@ description: |- The gitlab_groups data source allows details of multiple groups to be retrieved given some optional filter criteria. -> Some attributes might not be returned depending on if you're an admin or not. -> Some available options require administrator privileges. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/groups.html#list-groups + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/groups/#list-groups --- # gitlab_groups (Data Source) @@ -17,7 +17,7 @@ The `gitlab_groups` data source allows details of multiple groups to be retrieve -> Some available options require administrator privileges. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/groups.html#list-groups) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/groups/#list-groups) ## Example Usage diff --git a/docs/data-sources/instance_deploy_keys.md b/docs/data-sources/instance_deploy_keys.md index 98b8b0b03..8dc4fce09 100644 --- a/docs/data-sources/instance_deploy_keys.md +++ b/docs/data-sources/instance_deploy_keys.md @@ -5,7 +5,7 @@ subcategory: "" description: |- The gitlab_instance_deploy_keys data source allows to retrieve a list of deploy keys for a GitLab instance. -> This data source requires administration privileges. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/deploy_keys.html#list-all-deploy-keys + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/deploy_keys/#list-all-deploy-keys --- # gitlab_instance_deploy_keys (Data Source) @@ -14,7 +14,7 @@ The `gitlab_instance_deploy_keys` data source allows to retrieve a list of deplo -> This data source requires administration privileges. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/deploy_keys.html#list-all-deploy-keys) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/deploy_keys/#list-all-deploy-keys) ## Example Usage diff --git a/docs/data-sources/instance_service_account.md b/docs/data-sources/instance_service_account.md new file mode 100644 index 000000000..383c68dc1 --- /dev/null +++ b/docs/data-sources/instance_service_account.md @@ -0,0 +1,38 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "gitlab_instance_service_account Data Source - terraform-provider-gitlab" +subcategory: "" +description: |- + The gitlab_instance_service_account data source retrieves information about a gitlab service account. + ~> In order for a user to create a user account, they must have admin privileges at the instance level. This makes this feature unavailable on gitlab.com + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/user_service_accounts/ +--- + +# gitlab_instance_service_account (Data Source) + +The `gitlab_instance_service_account` data source retrieves information about a gitlab service account. + +~> In order for a user to create a user account, they must have admin privileges at the instance level. This makes this feature unavailable on `gitlab.com` + +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/user_service_accounts/) + +## Example Usage + +```terraform +data "gitlab_instance_service_account" "example" { + service_account_id = "123" +} +``` + + +## Schema + +### Required + +- `service_account_id` (String) The service account id. + +### Read-Only + +- `id` (String) The ID of this Terraform resource. This matches the service account id. +- `name` (String) The name of the user. +- `username` (String) The username of the user. diff --git a/docs/data-sources/instance_variable.md b/docs/data-sources/instance_variable.md index b04e6c5f1..0b31a3f6a 100644 --- a/docs/data-sources/instance_variable.md +++ b/docs/data-sources/instance_variable.md @@ -4,14 +4,14 @@ page_title: "gitlab_instance_variable Data Source - terraform-provider-gitlab" subcategory: "" description: |- The gitlab_instance_variable data source allows to retrieve details about an instance-level CI/CD variable. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/instance_level_ci_variables.html + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/instance_level_ci_variables/ --- # gitlab_instance_variable (Data Source) The `gitlab_instance_variable` data source allows to retrieve details about an instance-level CI/CD variable. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/instance_level_ci_variables.html) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/instance_level_ci_variables/) ## Example Usage @@ -32,7 +32,7 @@ data "gitlab_instance_variable" "foo" { - `description` (String) The description of the variable. Maximum of 255 characters. - `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`. +- `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/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. diff --git a/docs/data-sources/instance_variables.md b/docs/data-sources/instance_variables.md index 89ced97d7..e20998519 100644 --- a/docs/data-sources/instance_variables.md +++ b/docs/data-sources/instance_variables.md @@ -4,14 +4,14 @@ page_title: "gitlab_instance_variables Data Source - terraform-provider-gitlab" subcategory: "" description: |- The gitlab_instance_variables data source allows to retrieve all instance-level CI/CD variables. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/instance_level_ci_variables.html + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/instance_level_ci_variables/ --- # gitlab_instance_variables (Data Source) The `gitlab_instance_variables` data source allows to retrieve all instance-level CI/CD variables. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/instance_level_ci_variables.html) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/instance_level_ci_variables/) ## Example Usage diff --git a/docs/data-sources/metadata.md b/docs/data-sources/metadata.md index d29241bd2..bf08fca38 100644 --- a/docs/data-sources/metadata.md +++ b/docs/data-sources/metadata.md @@ -4,14 +4,14 @@ page_title: "gitlab_metadata Data Source - terraform-provider-gitlab" subcategory: "" description: |- The gitlab_metadata data source retrieves the metadata of the GitLab instance. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/metadata.html + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/metadata/ --- # gitlab_metadata (Data Source) The `gitlab_metadata` data source retrieves the metadata of the GitLab instance. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/metadata.html) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/metadata/) ## Example Usage @@ -24,7 +24,7 @@ data "gitlab_metadata" "this" {} ### Read-Only -- `enterprise` (Boolean) If the GitLab instance is an enterprise instance or not. Supported for GitLab 15.6 onwards. +- `enterprise` (Boolean) If the GitLab instance is an enterprise instance or not. - `id` (String) The id of the data source. It will always be `1` - `kas` (Attributes) Metadata about the GitLab agent server for Kubernetes (KAS). (see [below for nested schema](#nestedatt--kas)) - `revision` (String) Revision of the GitLab instance. diff --git a/docs/data-sources/pipeline_schedule.md b/docs/data-sources/pipeline_schedule.md index ac9de731f..3a7ba5294 100644 --- a/docs/data-sources/pipeline_schedule.md +++ b/docs/data-sources/pipeline_schedule.md @@ -4,14 +4,14 @@ page_title: "gitlab_pipeline_schedule Data Source - terraform-provider-gitlab" subcategory: "" description: |- The gitlab_pipeline_schedule data source retrieves information about a gitlab pipeline schedule for a project. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/pipeline_schedules.html + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/pipeline_schedules/ --- # gitlab_pipeline_schedule (Data Source) The `gitlab_pipeline_schedule` data source retrieves information about a gitlab pipeline schedule for a project. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/pipeline_schedules.html) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/pipeline_schedules/) ## Example Usage diff --git a/docs/data-sources/pipeline_schedules.md b/docs/data-sources/pipeline_schedules.md index 73b26830b..80693a574 100644 --- a/docs/data-sources/pipeline_schedules.md +++ b/docs/data-sources/pipeline_schedules.md @@ -4,14 +4,14 @@ page_title: "gitlab_pipeline_schedules Data Source - terraform-provider-gitlab" subcategory: "" description: |- The gitlab_pipeline_schedule data source retrieves information about a gitlab pipeline schedule for a project. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/pipeline_schedules.html + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/pipeline_schedules/ --- # gitlab_pipeline_schedules (Data Source) The `gitlab_pipeline_schedule` data source retrieves information about a gitlab pipeline schedule for a project. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/pipeline_schedules.html) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/pipeline_schedules/) ## Example Usage diff --git a/docs/data-sources/project.md b/docs/data-sources/project.md index dbde136b3..0b4d5b1f4 100644 --- a/docs/data-sources/project.md +++ b/docs/data-sources/project.md @@ -4,14 +4,14 @@ page_title: "gitlab_project Data Source - terraform-provider-gitlab" subcategory: "" description: |- The gitlab_project data source allows details of a project to be retrieved by either its ID or its path with namespace. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/projects.html#get-single-project + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/projects/#get-single-project --- # gitlab_project (Data Source) The `gitlab_project` data source allows details of a project to be retrieved by either its ID or its path with namespace. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/projects.html#get-single-project) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/projects/#get-single-project) ## Example Usage @@ -51,7 +51,7 @@ data "gitlab_project" "example" { - `builds_access_level` (String) Set the builds access level. Valid values are `disabled`, `private`, `enabled`. - `ci_config_path` (String) CI config file path for the project. - `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` -- `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` +- `ci_restrict_pipeline_cancellation_role` (String) The role required to cancel a pipeline or job. Premium and Ultimate only. Valid values are `developer`, `maintainer`, `no one` - `ci_separated_caches` (Boolean) Use separate caches for protected branches. - `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)) - `container_registry_access_level` (String) Set visibility of container registry, for this project. Valid values are `disabled`, `private`, `enabled`. @@ -70,7 +70,7 @@ data "gitlab_project" "example" { - `issues_enabled` (Boolean) Enable issue tracking for the project. - `keep_latest_artifact` (Boolean) Disable or enable the ability to keep the latest artifact for this project. - `lfs_enabled` (Boolean) Enable LFS for the project. -- `merge_commit_template` (String) Template used to create merge commit message in merge requests. (Introduced in GitLab 14.5.) +- `merge_commit_template` (String) Template used to create merge commit message in merge requests. - `merge_pipelines_enabled` (Boolean) Enable or disable merge pipelines. - `merge_requests_access_level` (String) Set the merge requests access level. Valid values are `disabled`, `private`, `enabled`. - `merge_requests_enabled` (Boolean) Enable merge requests for the project. @@ -98,7 +98,7 @@ data "gitlab_project" "example" { - `shared_with_groups` (List of Object) Describes groups which have access shared to this project. (see [below for nested schema](#nestedatt--shared_with_groups)) - `snippets_access_level` (String) Set the snippets access level. Valid values are `disabled`, `private`, `enabled`. - `snippets_enabled` (Boolean) Enable snippets for the project. -- `squash_commit_template` (String) Template used to create squash commit message in merge requests. (Introduced in GitLab 14.6.) +- `squash_commit_template` (String) Template used to create squash commit message in merge requests. - `ssh_url_to_repo` (String) URL that can be provided to `git clone` to clone the - `suggestion_commit_message` (String) The commit message used to apply merge request suggestions. - `topics` (Set of String) The list of topics for the project. diff --git a/docs/data-sources/project_branches.md b/docs/data-sources/project_branches.md index 1c01d36b2..f7533da22 100644 --- a/docs/data-sources/project_branches.md +++ b/docs/data-sources/project_branches.md @@ -4,14 +4,14 @@ page_title: "gitlab_project_branches Data Source - terraform-provider-gitlab" subcategory: "" description: |- The gitlab_project_branches data source allows details of the branches of a given project to be retrieved. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/branches.html#list-repository-branches + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/branches/#list-repository-branches --- # gitlab_project_branches (Data Source) The `gitlab_project_branches` data source allows details of the branches of a given project to be retrieved. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/branches.html#list-repository-branches) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/branches/#list-repository-branches) ## Example Usage diff --git a/docs/data-sources/project_environments.md b/docs/data-sources/project_environments.md index 0354da0c0..b283f5196 100644 --- a/docs/data-sources/project_environments.md +++ b/docs/data-sources/project_environments.md @@ -4,14 +4,14 @@ page_title: "gitlab_project_environments Data Source - terraform-provider-gitlab subcategory: "" description: |- The gitlab_project_environments data source retrieves information about all environments of the given project. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/environments.html#list-environments + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/environments/#list-environments --- # gitlab_project_environments (Data Source) The `gitlab_project_environments` data source retrieves information about all environments of the given project. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/environments.html#list-environments) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/environments/#list-environments) ## Example Usage diff --git a/docs/data-sources/project_hook.md b/docs/data-sources/project_hook.md index b6e3fd4c0..3f3bbc12e 100644 --- a/docs/data-sources/project_hook.md +++ b/docs/data-sources/project_hook.md @@ -4,14 +4,14 @@ page_title: "gitlab_project_hook Data Source - terraform-provider-gitlab" subcategory: "" description: |- The gitlab_project_hook data source allows to retrieve details about a hook in a project. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/projects.html#get-project-hook + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/projects/#get-project-hook --- # gitlab_project_hook (Data Source) The `gitlab_project_hook` data source allows to retrieve details about a hook in a project. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/projects.html#get-project-hook) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/projects/#get-project-hook) ## Example Usage diff --git a/docs/data-sources/project_hooks.md b/docs/data-sources/project_hooks.md index a66e4109b..0209582ba 100644 --- a/docs/data-sources/project_hooks.md +++ b/docs/data-sources/project_hooks.md @@ -4,14 +4,14 @@ page_title: "gitlab_project_hooks Data Source - terraform-provider-gitlab" subcategory: "" description: |- The gitlab_project_hooks data source allows to retrieve details about hooks in a project. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/projects.html#list-project-hooks + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/projects/#list-project-hooks --- # gitlab_project_hooks (Data Source) The `gitlab_project_hooks` data source allows to retrieve details about hooks in a project. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/projects.html#list-project-hooks) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/projects/#list-project-hooks) ## Example Usage diff --git a/docs/data-sources/project_ids.md b/docs/data-sources/project_ids.md index e80d6118a..0183f5d69 100644 --- a/docs/data-sources/project_ids.md +++ b/docs/data-sources/project_ids.md @@ -4,14 +4,14 @@ page_title: "gitlab_project_ids Data Source - terraform-provider-gitlab" subcategory: "" description: |- The gitlab_project_ids data source identification information for a given project, allowing a user to translate a full path or ID into the GraphQL ID of the project. - Upstream API: GitLab GraphQL API docs https://docs.gitlab.com/ee/api/graphql/reference/#queryproject + Upstream API: GitLab GraphQL API docs https://docs.gitlab.com/api/graphql/reference/#queryproject --- # gitlab_project_ids (Data Source) The `gitlab_project_ids` data source identification information for a given project, allowing a user to translate a full path or ID into the GraphQL ID of the project. -**Upstream API**: [GitLab GraphQL API docs](https://docs.gitlab.com/ee/api/graphql/reference/#queryproject) +**Upstream API**: [GitLab GraphQL API docs](https://docs.gitlab.com/api/graphql/reference/#queryproject) ## Example Usage diff --git a/docs/data-sources/project_issue.md b/docs/data-sources/project_issue.md index 4eb828114..3f5cca4b6 100644 --- a/docs/data-sources/project_issue.md +++ b/docs/data-sources/project_issue.md @@ -4,14 +4,14 @@ page_title: "gitlab_project_issue Data Source - terraform-provider-gitlab" subcategory: "" description: |- The gitlab_project_issue data source allows to retrieve details about an issue in a project. - Upstream API: GitLab API docs https://docs.gitlab.com/ee/api/issues.html + Upstream API: GitLab API docs https://docs.gitlab.com/api/issues/ --- # gitlab_project_issue (Data Source) The `gitlab_project_issue` data source allows to retrieve details about an issue in a project. -**Upstream API**: [GitLab API docs](https://docs.gitlab.com/ee/api/issues.html) +**Upstream API**: [GitLab API docs](https://docs.gitlab.com/api/issues/) ## Example Usage diff --git a/docs/data-sources/project_issues.md b/docs/data-sources/project_issues.md index 583120c76..aba419dbf 100644 --- a/docs/data-sources/project_issues.md +++ b/docs/data-sources/project_issues.md @@ -4,14 +4,14 @@ page_title: "gitlab_project_issues Data Source - terraform-provider-gitlab" subcategory: "" description: |- The gitlab_project_issues data source allows to retrieve details about issues in a project. - Upstream API: GitLab API docs https://docs.gitlab.com/ee/api/issues.html + Upstream API: GitLab API docs https://docs.gitlab.com/api/issues/ --- # gitlab_project_issues (Data Source) The `gitlab_project_issues` data source allows to retrieve details about issues in a project. -**Upstream API**: [GitLab API docs](https://docs.gitlab.com/ee/api/issues.html) +**Upstream API**: [GitLab API docs](https://docs.gitlab.com/api/issues/) ## Example Usage @@ -43,7 +43,7 @@ data "gitlab_project_issues" "all_with_foo" { - `created_before` (String) Return issues created on or before the given time. Expected in ISO 8601 format (2019-03-15T08:00:00Z) - `due_date` (String) Return issues that have no due date, are overdue, or whose due date is this week, this month, or between two weeks ago and next month. Accepts: 0 (no due date), any, today, tomorrow, overdue, week, month, next_month_and_previous_two_weeks. - `iids` (List of Number) Return only the issues having the given iid -- `issue_type` (String) Filter to a given type of issue. Valid values are [issue incident test_case]. (Introduced in GitLab 13.12) +- `issue_type` (String) Filter to a given type of issue. Valid values are [issue incident test_case]. - `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. - `milestone` (String) The milestone title. None lists all issues with no milestone. Any lists all issues that have an assigned milestone. - `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. @@ -59,7 +59,7 @@ data "gitlab_project_issues" "all_with_foo" { - `updated_after` (String) Return issues updated on or after the given time. Expected in ISO 8601 format (2019-03-15T08:00:00Z) - `updated_before` (String) Return issues updated on or before the given time. Expected in ISO 8601 format (2019-03-15T08:00:00Z) - `weight` (Number) Return issues with the specified weight. None returns issues with no weight assigned. Any returns issues with a weight assigned. -- `with_labels_details` (Boolean) If true, the response returns more details for each label in labels field: :name, :color, :description, :description_html, :text_color. Default is false. description_html was introduced in GitLab 12.7 +- `with_labels_details` (Boolean) If true, the response returns more details for each label in labels field: :name, :color, :description, :description_html, :text_color. Default is false. ### Read-Only diff --git a/docs/data-sources/project_membership.md b/docs/data-sources/project_membership.md index f9749ffb3..450d4a078 100644 --- a/docs/data-sources/project_membership.md +++ b/docs/data-sources/project_membership.md @@ -5,7 +5,7 @@ subcategory: "" description: |- The gitlab_project_membership data source allows to list and filter all members of a project specified by either its id or full path. -> Note exactly one of project_id or full_path must be provided. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/members.html#list-all-members-of-a-group-or-project + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/members/#list-all-members-of-a-group-or-project --- # gitlab_project_membership (Data Source) @@ -14,7 +14,7 @@ The `gitlab_project_membership` data source allows to list and filter all member -> **Note** exactly one of project_id or full_path must be provided. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/members.html#list-all-members-of-a-group-or-project) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/members/#list-all-members-of-a-group-or-project) ## Example Usage diff --git a/docs/data-sources/project_merge_request.md b/docs/data-sources/project_merge_request.md index f430ac7d3..165e9e7a0 100644 --- a/docs/data-sources/project_merge_request.md +++ b/docs/data-sources/project_merge_request.md @@ -5,7 +5,7 @@ subcategory: "" description: |- The gitlab_project_merge_request data source retrieves information about a single merge request related to a specific project. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/merge_requests.html#get-single-mr + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/merge_requests/#get-single-mr --- # gitlab_project_merge_request (Data Source) @@ -13,7 +13,7 @@ description: |- The `gitlab_project_merge_request` data source retrieves information about a single merge request related to a specific project. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/merge_requests.html#get-single-mr) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/merge_requests/#get-single-mr) ## Example Usage diff --git a/docs/data-sources/project_milestone.md b/docs/data-sources/project_milestone.md index 0669a2763..1091331c7 100644 --- a/docs/data-sources/project_milestone.md +++ b/docs/data-sources/project_milestone.md @@ -4,14 +4,14 @@ page_title: "gitlab_project_milestone Data Source - terraform-provider-gitlab" subcategory: "" description: |- The gitlab_project_milestone data source allows get details of a project milestone. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/milestones.html + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/milestones/ --- # gitlab_project_milestone (Data Source) The `gitlab_project_milestone` data source allows get details of a project milestone. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/milestones.html) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/milestones/) ## Example Usage diff --git a/docs/data-sources/project_milestones.md b/docs/data-sources/project_milestones.md index b554e6f1c..349664d3f 100644 --- a/docs/data-sources/project_milestones.md +++ b/docs/data-sources/project_milestones.md @@ -4,14 +4,14 @@ page_title: "gitlab_project_milestones Data Source - terraform-provider-gitlab" subcategory: "" description: |- The gitlab_project_milestones data source allows get details of a project milestones. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/milestones.html + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/milestones/ --- # gitlab_project_milestones (Data Source) The `gitlab_project_milestones` data source allows get details of a project milestones. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/milestones.html) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/milestones/) ## Example Usage @@ -37,7 +37,7 @@ data "gitlab_project_milestones" "example" { ### Optional - `iids` (List of Number) Return only the milestones having the given `iid` (Note: ignored if `include_parent_milestones` is set as `true`). -- `include_parent_milestones` (Boolean) Include group milestones from parent group and its ancestors. Introduced in GitLab 13.4. +- `include_parent_milestones` (Boolean) Include group milestones from parent group and its ancestors. - `search` (String) Return only milestones with a title or description matching the provided string. - `state` (String) Return only `active` or `closed` milestones. - `title` (String) Return only the milestones having the given `title`. diff --git a/docs/data-sources/project_protected_branch.md b/docs/data-sources/project_protected_branch.md index 69716918e..de7292f68 100644 --- a/docs/data-sources/project_protected_branch.md +++ b/docs/data-sources/project_protected_branch.md @@ -4,14 +4,14 @@ page_title: "gitlab_project_protected_branch Data Source - terraform-provider-gi subcategory: "" description: |- The gitlab_project_protected_branch data source allows details of a protected branch to be retrieved by its name and the project it belongs to. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/protected_branches.html#get-a-single-protected-branch-or-wildcard-protected-branch + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/protected_branches/#get-a-single-protected-branch-or-wildcard-protected-branch --- # gitlab_project_protected_branch (Data Source) The `gitlab_project_protected_branch` data source allows details of a protected branch to be retrieved by its name and the project it belongs to. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/protected_branches.html#get-a-single-protected-branch-or-wildcard-protected-branch) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/protected_branches/#get-a-single-protected-branch-or-wildcard-protected-branch) ## Example Usage diff --git a/docs/data-sources/project_protected_branches.md b/docs/data-sources/project_protected_branches.md index 7b9963417..2295f2942 100644 --- a/docs/data-sources/project_protected_branches.md +++ b/docs/data-sources/project_protected_branches.md @@ -4,14 +4,14 @@ page_title: "gitlab_project_protected_branches Data Source - terraform-provider- subcategory: "" description: |- The gitlab_project_protected_branches data source allows details of the protected branches of a given project. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/protected_branches.html#list-protected-branches + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/protected_branches/#list-protected-branches --- # gitlab_project_protected_branches (Data Source) The `gitlab_project_protected_branches` data source allows details of the protected branches of a given project. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/protected_branches.html#list-protected-branches) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/protected_branches/#list-protected-branches) ## Example Usage diff --git a/docs/data-sources/project_protected_tag.md b/docs/data-sources/project_protected_tag.md index 7abd1de6d..311153ae6 100644 --- a/docs/data-sources/project_protected_tag.md +++ b/docs/data-sources/project_protected_tag.md @@ -4,14 +4,14 @@ page_title: "gitlab_project_protected_tag Data Source - terraform-provider-gitla subcategory: "" description: |- The gitlab_project_protected_tag data source allows details of a protected tag to be retrieved by its name and the project it belongs to. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/protected_tags.html#get-a-single-protected-tag-or-wildcard-protected-tag + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/protected_tags/#get-a-single-protected-tag-or-wildcard-protected-tag --- # gitlab_project_protected_tag (Data Source) The `gitlab_project_protected_tag` data source allows details of a protected tag to be retrieved by its name and the project it belongs to. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/protected_tags.html#get-a-single-protected-tag-or-wildcard-protected-tag) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/protected_tags/#get-a-single-protected-tag-or-wildcard-protected-tag) ## Example Usage diff --git a/docs/data-sources/project_protected_tags.md b/docs/data-sources/project_protected_tags.md index c0feece7d..a500ff2a0 100644 --- a/docs/data-sources/project_protected_tags.md +++ b/docs/data-sources/project_protected_tags.md @@ -4,14 +4,14 @@ page_title: "gitlab_project_protected_tags Data Source - terraform-provider-gitl subcategory: "" description: |- The gitlab_project_protected_tags data source allows details of the protected tags of a given project. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/protected_tags.html#list-protected-tags + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/protected_tags/#list-protected-tags --- # gitlab_project_protected_tags (Data Source) The `gitlab_project_protected_tags` data source allows details of the protected tags of a given project. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/protected_tags.html#list-protected-tags) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/protected_tags/#list-protected-tags) ## Example Usage diff --git a/docs/data-sources/project_tag.md b/docs/data-sources/project_tag.md index 06c42ed04..9f37eff47 100644 --- a/docs/data-sources/project_tag.md +++ b/docs/data-sources/project_tag.md @@ -4,14 +4,14 @@ page_title: "gitlab_project_tag Data Source - terraform-provider-gitlab" subcategory: "" description: |- The gitlab_project_tag data source allows details of a project tag to be retrieved by its name. - Upstream API: GitLab API docs https://docs.gitlab.com/ee/api/tags.html + Upstream API: GitLab API docs https://docs.gitlab.com/api/tags/ --- # gitlab_project_tag (Data Source) The `gitlab_project_tag` data source allows details of a project tag to be retrieved by its name. -**Upstream API**: [GitLab API docs](https://docs.gitlab.com/ee/api/tags.html) +**Upstream API**: [GitLab API docs](https://docs.gitlab.com/api/tags/) ## Example Usage diff --git a/docs/data-sources/project_tags.md b/docs/data-sources/project_tags.md index 6694fba17..ce7d6073d 100644 --- a/docs/data-sources/project_tags.md +++ b/docs/data-sources/project_tags.md @@ -4,14 +4,14 @@ page_title: "gitlab_project_tags Data Source - terraform-provider-gitlab" subcategory: "" description: |- The gitlab_project_tags data source allows details of project tags to be retrieved by some search criteria. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/tags.html#list-project-repository-tags + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/tags/#list-project-repository-tags --- # gitlab_project_tags (Data Source) The `gitlab_project_tags` data source allows details of project tags to be retrieved by some search criteria. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/tags.html#list-project-repository-tags) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/tags/#list-project-repository-tags) ## Example Usage diff --git a/docs/data-sources/project_variable.md b/docs/data-sources/project_variable.md index 00e91d61c..fb424f471 100644 --- a/docs/data-sources/project_variable.md +++ b/docs/data-sources/project_variable.md @@ -4,14 +4,14 @@ page_title: "gitlab_project_variable Data Source - terraform-provider-gitlab" subcategory: "" description: |- The gitlab_project_variable data source allows to retrieve details about a project-level CI/CD variable. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/project_level_variables.html + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/project_level_variables/ --- # gitlab_project_variable (Data Source) The `gitlab_project_variable` data source allows to retrieve details about a project-level CI/CD variable. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/project_level_variables.html) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/project_level_variables/) ## Example Usage @@ -45,7 +45,7 @@ data "gitlab_project_variable" "bar" { - `description` (String) The description of the variable. - `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`. +- `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/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. diff --git a/docs/data-sources/project_variables.md b/docs/data-sources/project_variables.md index 3505c43c7..fe0c7e31d 100644 --- a/docs/data-sources/project_variables.md +++ b/docs/data-sources/project_variables.md @@ -4,14 +4,14 @@ page_title: "gitlab_project_variables Data Source - terraform-provider-gitlab" subcategory: "" description: |- The gitlab_project_variables data source allows to retrieve all project-level CI/CD variables. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/project_level_variables.html + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/project_level_variables/ --- # gitlab_project_variables (Data Source) The `gitlab_project_variables` data source allows to retrieve all project-level CI/CD variables. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/project_level_variables.html) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/project_level_variables/) ## Example Usage diff --git a/docs/data-sources/projects.md b/docs/data-sources/projects.md index 805d34825..cea18effc 100644 --- a/docs/data-sources/projects.md +++ b/docs/data-sources/projects.md @@ -4,20 +4,20 @@ page_title: "gitlab_projects Data Source - terraform-provider-gitlab" subcategory: "" description: |- The gitlab_projects data source allows details of multiple projects to be retrieved. Optionally filtered by the set attributes. - -> This data source supports all available filters exposed by the xanzy/go-gitlab package, which might not expose all available filters exposed by the Gitlab APIs. - -> The owner sub-attributes are only populated if the Gitlab token used has an administrator scope. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/projects.html#list-all-projects + -> This data source supports all available filters exposed by the client-go https://gitlab.com/gitlab-org/api/client-go package, which might not expose all available filters exposed by the GitLab APIs. + -> The owner sub-attributes are only populated if the GitLab token used has an administrator scope. + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/projects/#list-all-projects --- # gitlab_projects (Data Source) The `gitlab_projects` data source allows details of multiple projects to be retrieved. Optionally filtered by the set attributes. --> This data source supports all available filters exposed by the xanzy/go-gitlab package, which might not expose all available filters exposed by the Gitlab APIs. +-> This data source supports all available filters exposed by the [client-go](https://gitlab.com/gitlab-org/api/client-go) package, which might not expose all available filters exposed by the GitLab APIs. --> The [owner sub-attributes](#nestedobjatt--projects--owner) are only populated if the Gitlab token used has an administrator scope. +-> The [owner sub-attributes](#nestedobjatt--projects--owner) are only populated if the GitLab token used has an administrator scope. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/projects.html#list-all-projects) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/projects/#list-all-projects) ## Example Usage @@ -51,8 +51,8 @@ data "gitlab_projects" "projects" { - `include_subgroups` (Boolean) Include projects in subgroups of this group. Default is `false`. Needs `group_id`. - `max_queryable_pages` (Number) The maximum number of project results pages that may be queried. Prevents overloading your Gitlab instance in case of a misconfiguration. - `membership` (Boolean) Limit by projects that the current user is a member of. -- `min_access_level` (Number) Limit to projects where current user has at least this access level, refer to the [official documentation](https://docs.gitlab.com/ee/api/members.html) for values. Cannot be used with `group_id`. -- `order_by` (String) Return projects ordered ordered by: `id`, `name`, `path`, `created_at`, `updated_at`, `last_activity_at`, `similarity`, `repository_size`, `storage_size`, `packages_size`, `wiki_size`. Some values or only available in certain circumstances. See [upstream docs](https://docs.gitlab.com/ee/api/projects.html#list-all-projects) for details. +- `min_access_level` (Number) Limit to projects where current user has at least this access level, refer to the [official documentation](https://docs.gitlab.com/api/members/) for values. Cannot be used with `group_id`. +- `order_by` (String) Return projects ordered ordered by: `id`, `name`, `path`, `created_at`, `updated_at`, `last_activity_at`, `similarity`, `repository_size`, `storage_size`, `packages_size`, `wiki_size`. Some values or only available in certain circumstances. See [upstream docs](https://docs.gitlab.com/api/projects/#list-all-projects) for details. - `owned` (Boolean) Limit by projects owned by the current user. - `page` (Number) The first page to begin the query on. - `per_page` (Number) The number of results to return per page. diff --git a/docs/data-sources/release.md b/docs/data-sources/release.md index 66f92c0c1..e533aeeea 100644 --- a/docs/data-sources/release.md +++ b/docs/data-sources/release.md @@ -4,14 +4,14 @@ page_title: "gitlab_release Data Source - terraform-provider-gitlab" subcategory: "" description: |- The gitlab_release data source retrieves information about a gitlab release for a project. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/releases/ + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/releases/ --- # gitlab_release (Data Source) The `gitlab_release` data source retrieves information about a gitlab release for a project. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/releases/) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/releases/) ## Example Usage diff --git a/docs/data-sources/release_link.md b/docs/data-sources/release_link.md index 8adc914de..24e5b33e4 100644 --- a/docs/data-sources/release_link.md +++ b/docs/data-sources/release_link.md @@ -4,14 +4,14 @@ page_title: "gitlab_release_link Data Source - terraform-provider-gitlab" subcategory: "" description: |- The gitlab_release_link data source allows get details of a release link. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/releases/links.html + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/releases/links/ --- # gitlab_release_link (Data Source) The `gitlab_release_link` data source allows get details of a release link. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/releases/links.html) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/releases/links/) ## Example Usage @@ -37,14 +37,14 @@ data "gitlab_release_link" "example" { ### Required - `link_id` (Number) The ID of the link. -- `project` (String) The ID or [URL-encoded path of the project](https://docs.gitlab.com/ee/api/index.html#namespaced-path-encoding). +- `project` (String) The ID or [URL-encoded path of the project](https://docs.gitlab.com/api/index/#namespaced-path-encoding). - `tag_name` (String) The tag associated with the Release. ### Read-Only -- `direct_asset_url` (String) Full path for a [Direct Asset link](https://docs.gitlab.com/ee/user/project/releases/index.html#permanent-links-to-release-assets). +- `direct_asset_url` (String) Full path for a [Direct Asset link](https://docs.gitlab.com/user/project/releases/index/#permanent-links-to-release-assets). - `external` (Boolean) External or internal link. -- `filepath` (String) Relative path for a [Direct Asset link](https://docs.gitlab.com/ee/user/project/releases/index.html#permanent-links-to-release-assets). +- `filepath` (String) Relative path for a [Direct Asset link](https://docs.gitlab.com/user/project/releases/index/#permanent-links-to-release-assets). - `id` (String) The ID of this resource. - `link_type` (String) The type of the link. Valid values are `other`, `runbook`, `image`, `package`. Defaults to other. - `name` (String) The name of the link. Link names must be unique within the release. diff --git a/docs/data-sources/release_links.md b/docs/data-sources/release_links.md index f6e1ad01e..d4655c57e 100644 --- a/docs/data-sources/release_links.md +++ b/docs/data-sources/release_links.md @@ -4,14 +4,14 @@ page_title: "gitlab_release_links Data Source - terraform-provider-gitlab" subcategory: "" description: |- The gitlab_release_links data source allows get details of release links. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/releases/links.html + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/releases/links/ --- # gitlab_release_links (Data Source) The `gitlab_release_links` data source allows get details of release links. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/releases/links.html) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/releases/links/) ## Example Usage diff --git a/docs/data-sources/repository_file.md b/docs/data-sources/repository_file.md index 95a174928..41f02711c 100644 --- a/docs/data-sources/repository_file.md +++ b/docs/data-sources/repository_file.md @@ -4,14 +4,14 @@ page_title: "gitlab_repository_file Data Source - terraform-provider-gitlab" subcategory: "" description: |- The gitlab_repository_file data source allows details of a file in a repository to be retrieved. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/repository_files.html + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/repository_files/ --- # gitlab_repository_file (Data Source) The `gitlab_repository_file` data source allows details of a file in a repository to be retrieved. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/repository_files.html) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/repository_files/) ## Example Usage @@ -39,7 +39,7 @@ data "gitlab_repository_file" "example" { - `content` (String) File content. - `content_sha256` (String) File content sha256 digest. - `encoding` (String) The file content encoding. -- `execute_filemode` (Boolean) Enables or disables the execute flag on the file. **Note**: requires GitLab 14.10 or newer. +- `execute_filemode` (Boolean) Enables or disables the execute flag on the file. - `file_name` (String) The filename. - `id` (String) The ID of this resource. - `last_commit_id` (String) The last known commit id. diff --git a/docs/data-sources/repository_tree.md b/docs/data-sources/repository_tree.md index f4f05d698..8c357cbaf 100644 --- a/docs/data-sources/repository_tree.md +++ b/docs/data-sources/repository_tree.md @@ -4,14 +4,14 @@ page_title: "gitlab_repository_tree Data Source - terraform-provider-gitlab" subcategory: "" description: |- The gitlab_repository_tree data source allows details of directories and files in a repository to be retrieved. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/repositories.html#list-repository-tree + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/repositories/#list-repository-tree --- # gitlab_repository_tree (Data Source) The `gitlab_repository_tree` data source allows details of directories and files in a repository to be retrieved. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/repositories.html#list-repository-tree) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/repositories/#list-repository-tree) ## Example Usage diff --git a/docs/data-sources/runners.md b/docs/data-sources/runners.md index 4138ec0e3..44bc45538 100644 --- a/docs/data-sources/runners.md +++ b/docs/data-sources/runners.md @@ -4,14 +4,14 @@ page_title: "gitlab_runners Data Source - terraform-provider-gitlab" subcategory: "" description: |- The gitlab_runners data source retrieves information about all gitlab runners. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/runners.html#list-all-runners + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/runners/#list-all-runners --- # gitlab_runners (Data Source) The `gitlab_runners` data source retrieves information about all gitlab runners. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/runners.html#list-all-runners) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/runners/#list-all-runners) ## Example Usage diff --git a/docs/data-sources/user.md b/docs/data-sources/user.md index e82b85bc0..3fd3d09fb 100644 --- a/docs/data-sources/user.md +++ b/docs/data-sources/user.md @@ -5,9 +5,8 @@ subcategory: "" description: |- The gitlab_user data source allows details of a user to be retrieved by either the user ID, username or email address. -> Some attributes might not be returned depending on if you're an admin or not. - ~> When using the email attribute, an exact match is not guaranteed. The most related match will be returned. Starting with GitLab 16.6, - the most related match will prioritize an exact match if one is available. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/users.html#single-user + ~> When using the email attribute, an exact match is not guaranteed. The most related match will be returned. The most related match will prioritize an exact match if one is available. + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/users/#single-user --- # gitlab_user (Data Source) @@ -16,10 +15,9 @@ The `gitlab_user` data source allows details of a user to be retrieved by either -> Some attributes might not be returned depending on if you're an admin or not. -~> When using the `email` attribute, an exact match is not guaranteed. The most related match will be returned. Starting with GitLab 16.6, -the most related match will prioritize an exact match if one is available. +~> When using the `email` attribute, an exact match is not guaranteed. The most related match will be returned. The most related match will prioritize an exact match if one is available. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/users.html#single-user) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/users/#single-user) ## Example Usage @@ -41,8 +39,8 @@ data "gitlab_user" "example-two" { ### Optional -- `email` (String) The public email address of the user. **Note**: before GitLab 14.8 the lookup was based on the users primary email address. -- `namespace_id` (Number) The ID of the user's namespace. Requires admin token to access this field. Available since GitLab 14.10. +- `email` (String) The public email address of the user. +- `namespace_id` (Number) The ID of the user's namespace. Requires admin token to access this field. - `user_id` (Number) The ID of the user. - `username` (String) The username of the user. diff --git a/docs/data-sources/user_sshkeys.md b/docs/data-sources/user_sshkeys.md index 7c282dc69..79618aad0 100644 --- a/docs/data-sources/user_sshkeys.md +++ b/docs/data-sources/user_sshkeys.md @@ -4,14 +4,14 @@ page_title: "gitlab_user_sshkeys Data Source - terraform-provider-gitlab" subcategory: "" description: |- The gitlab_user_sshkeys data source allows a list of SSH keys to be retrieved by either the user ID or username. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/users.html#list-ssh-keys-for-user + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/users/#list-ssh-keys-for-user --- # gitlab_user_sshkeys (Data Source) The `gitlab_user_sshkeys` data source allows a list of SSH keys to be retrieved by either the user ID or username. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/users.html#list-ssh-keys-for-user) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/users/#list-ssh-keys-for-user) diff --git a/docs/data-sources/users.md b/docs/data-sources/users.md index 7c49600ca..a1991991b 100644 --- a/docs/data-sources/users.md +++ b/docs/data-sources/users.md @@ -6,7 +6,7 @@ description: |- The gitlab_users data source allows details of multiple users to be retrieved given some optional filter criteria. -> Some attributes might not be returned depending on if you're an admin or not. -> Some available options require administrator privileges. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ce/api/users.html#list-users + Upstream API: GitLab REST API docs https://docs.gitlab.com/ce/api/users/#list-users --- # gitlab_users (Data Source) @@ -17,7 +17,7 @@ The `gitlab_users` data source allows details of multiple users to be retrieved -> Some available options require administrator privileges. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ce/api/users.html#list-users) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ce/api/users/#list-users) ## Example Usage diff --git a/docs/development/CreatingANewResource.md b/docs/development/CreatingANewResource.md index b8bf6ffee..10292649e 100644 --- a/docs/development/CreatingANewResource.md +++ b/docs/development/CreatingANewResource.md @@ -38,7 +38,7 @@ whenever possible. This means that a new resource meets a couple of criteria: For this example, the [`resource_gitlab_application`](../internal/provider/resource_gitlab_application.go) resource will be used as a step-by-step example. This resource aligns to the -[Applications API](https://docs.gitlab.com/ee/api/applications.html) exposed by GitLab. When creating +[Applications API](https://docs.gitlab.com/api/applications/) exposed by GitLab. When creating a resource, first ensure that the relevant APIs are present in GitLab. If it's not clear whether an api exists for a resource, create an issue on the GitLab Terraform Provider project and ask! @@ -118,7 +118,7 @@ func (r *gitlabApplicationResource) Schema(ctx context.Context, req resource.Sch ~> In order to use a user for a user to create an application, they must have admin priviledges at the instance level. To create an OIDC application, a scope of "openid". -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/applications.html)`), +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/applications/)`), Attributes: map[string]schema.Attribute{ "id": schema.StringAttribute{ diff --git a/docs/index.md b/docs/index.md index a1877ad7e..629eaa808 100644 --- a/docs/index.md +++ b/docs/index.md @@ -9,8 +9,20 @@ Use the GitLab provider to interact with GitLab resources, like users, groups, projects and more. You must configure the provider with the proper credentials before you can use it. -The provider uses the [`xanzy/go-gitlab`](https://gitlab.com/gitlab-org/api/client-go) library -to interact with the [GitLab REST API](https://docs.gitlab.com/ee/api/api_resources.html). +The provider uses the [`client-go`](https://gitlab.com/gitlab-org/api/client-go) library +to interact with the [GitLab REST API](https://docs.gitlab.com/api/api_resources/). + +We support the following versions: + +- Latest 3 patch releases within a major release. For example, if current is 17.8, we support 17.6-17.8. Or if current is 18.1, we support 18.0-18.1. +- We introduce any breaking changes on major releases only. For example, 17.0 or 18.0. +- We run tests against the latest 3 patch releases regardless of whether these cross a major release boundary. For example, if current is 17.8, we test 17.6-17.8. Or if current is 18.1, we test 17.11-18.1. + +All other versions are best effort support. + +-> Note, that the compatibility between a provider release and GitLab itself **cannot** be inferred from the +release version. New features added to GitLab may not be added to the provider until later versions. +Equally, features removed or deprecated in GitLab may not be removed or deprecated from the provider until later versions. Each data source and resource references the appropriate upstream GitLab REST API documentation, which may be consumed to better understand the behavior of the API. @@ -84,4 +96,4 @@ resource "gitlab_project" "sample_group_project" { - `headers` (Map of String) A map of headers to append to all API request to the GitLab instance. - `insecure` (Boolean) When set to true this disables SSL verification of the connection to the GitLab instance. - `retries` (Number) The number of retries to execute when receiving a 429 Rate Limit error. Each retry will exponentially back off. -- `token` (String, Sensitive) The OAuth2 Token, Project, Group, Personal Access Token or CI Job Token used to connect to GitLab. The OAuth method is used in this provider for authentication (using Bearer authorization token). See https://docs.gitlab.com/ee/api/#authentication for details. It may be sourced from the `GITLAB_TOKEN` environment variable. +- `token` (String, Sensitive) The OAuth2 Token, Project, Group, Personal Access Token or CI Job Token used to connect to GitLab. The OAuth method is used in this provider for authentication (using Bearer authorization token). See https://docs.gitlab.com/api/#authentication for details. It may be sourced from the `GITLAB_TOKEN` environment variable. diff --git a/docs/resources/application.md b/docs/resources/application.md index 6a8a253bc..1a5fa79fe 100644 --- a/docs/resources/application.md +++ b/docs/resources/application.md @@ -6,7 +6,7 @@ description: |- The gitlab_application resource allows to manage the lifecycle of applications in gitlab. ~> In order to use a user for a user to create an application, they must have admin privileges at the instance level. To create an OIDC application, a scope of "openid". - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/applications.html + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/applications/ --- # gitlab_application (Resource) @@ -16,7 +16,7 @@ The `gitlab_application` resource allows to manage the lifecycle of applications ~> In order to use a user for a user to create an application, they must have admin privileges at the instance level. To create an OIDC application, a scope of "openid". -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/applications.html) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/applications/) ## Example Usage diff --git a/docs/resources/application_settings.md b/docs/resources/application_settings.md index 677a593fc..2acbd7e05 100644 --- a/docs/resources/application_settings.md +++ b/docs/resources/application_settings.md @@ -11,7 +11,7 @@ description: |- !> This resource does not implement any destroy logic, it's a no-op at this point. It's also not possible to revert to the previous settings. -> Requires at administrative privileges on GitLab. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/settings.html + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/settings/ --- # gitlab_application_settings (Resource) @@ -29,7 +29,7 @@ The `gitlab_application_settings` resource allows to manage the GitLab applicati -> Requires at administrative privileges on GitLab. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/settings.html) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/settings/) ## Example Usage @@ -70,21 +70,21 @@ resource "gitlab_application_settings" "this" { - `asset_proxy_secret_key` (String, Sensitive) Shared secret with the asset proxy server. GitLab restart is required to apply changes. - `asset_proxy_url` (String) URL of the asset proxy server. GitLab restart is required to apply changes. - `authorized_keys_enabled` (Boolean) By default, we write to the authorized_keys file to support Git over SSH without additional configuration. GitLab can be optimized to authenticate SSH keys via the database file. Only disable this if you have configured your OpenSSH server to use the AuthorizedKeysCommand. -- `auto_ban_user_on_excessive_projects_download` (Boolean) When enabled, users will get automatically banned from the application when they download more than the maximum number of unique projects in the time period specified by max_number_of_repository_downloads and max_number_of_repository_downloads_within_time_period respectively. Introduced in GitLab 15.4. Self-managed, Ultimate only. +- `auto_ban_user_on_excessive_projects_download` (Boolean) When enabled, users will get automatically banned from the application when they download more than the maximum number of unique projects in the time period specified by max_number_of_repository_downloads and max_number_of_repository_downloads_within_time_period respectively. Self-managed, Ultimate only. - `auto_devops_domain` (String) Specify a domain to use by default for every project’s Auto Review Apps and Auto Deploy stages. - `auto_devops_enabled` (Boolean) Enable Auto DevOps for projects by default. It automatically builds, tests, and deploys applications based on a predefined CI/CD configuration. - `automatic_purchased_storage_allocation` (Boolean) Enabling this permits automatic allocation of purchased storage in a namespace. - `bulk_import_concurrent_pipeline_batch_limit` (Number) Maximum simultaneous Direct Transfer batches to process. -- `bulk_import_enabled` (Boolean) Enable migrating GitLab groups by direct transfer. Introduced in GitLab 15.8. -- `bulk_import_max_download_file_size` (Number) Maximum download file size when importing from source GitLab instances by direct transfer. Introduced in GitLab 16.3. -- `can_create_group` (Boolean) Indicates whether users can create top-level groups. Introduced in GitLab 15.5. +- `bulk_import_enabled` (Boolean) Enable migrating GitLab groups by direct transfer. +- `bulk_import_max_download_file_size` (Number) Maximum download file size when importing from source GitLab instances by direct transfer. +- `can_create_group` (Boolean) Indicates whether users can create top-level groups. - `check_namespace_plan` (Boolean) Enabling this makes only licensed EE features available to projects if the project namespace’s plan includes the feature or if the project is public. - `ci_max_includes` (Number) The maximum number of includes per pipeline. - `ci_max_total_yaml_size_bytes` (Number) The maximum amount of memory, in bytes, that can be allocated for the pipeline configuration, with all included YAML configuration files. - `commit_email_hostname` (String) Custom hostname (for private commit emails). -- `concurrent_bitbucket_import_jobs_limit` (Number) Maximum number of simultaneous import jobs for the Bitbucket Cloud importer. Introduced in GitLab 16.11. -- `concurrent_bitbucket_server_import_jobs_limit` (Number) Maximum number of simultaneous import jobs for the Bitbucket Server importer. Introduced in GitLab 16.11. -- `concurrent_github_import_jobs_limit` (Number) Maximum number of simultaneous import jobs for the GitHub importer. Introduced in GitLab 16.11. +- `concurrent_bitbucket_import_jobs_limit` (Number) Maximum number of simultaneous import jobs for the Bitbucket Cloud importer. +- `concurrent_bitbucket_server_import_jobs_limit` (Number) Maximum number of simultaneous import jobs for the Bitbucket Server importer. +- `concurrent_github_import_jobs_limit` (Number) Maximum number of simultaneous import jobs for the GitHub importer. - `container_expiration_policies_enable_historic_entries` (Boolean) Enable cleanup policies for all projects. - `container_registry_cleanup_tags_service_max_list_size` (Number) The maximum number of tags that can be deleted in a single execution of cleanup policies. - `container_registry_delete_tags_service_timeout` (Number) The maximum time, in seconds, that the cleanup process can take to delete a batch of tags for cleanup policies. @@ -92,10 +92,10 @@ resource "gitlab_application_settings" "this" { - `container_registry_expiration_policies_worker_capacity` (Number) Number of workers for cleanup policies. - `container_registry_token_expire_delay` (Number) Container Registry token duration in minutes. - `deactivate_dormant_users` (Boolean) Enable automatic deactivation of dormant users. -- `deactivate_dormant_users_period` (Number) Length of time (in days) after which a user is considered dormant. Introduced in GitLab 15.3. -- `decompress_archive_file_timeout` (Number) Default timeout for decompressing archived files, in seconds. Set to 0 to disable timeouts. Introduced in GitLab 16.4. +- `deactivate_dormant_users_period` (Number) Length of time (in days) after which a user is considered dormant. +- `decompress_archive_file_timeout` (Number) Default timeout for decompressing archived files, in seconds. Set to 0 to disable timeouts. - `default_artifacts_expire_in` (String) Set the default expiration time for each job’s artifacts. -- `default_branch_name` (String) Instance-level custom initial branch name (introduced in GitLab 13.2). +- `default_branch_name` (String) Instance-level custom initial branch name - `default_branch_protection` (Number) Determine if developers can push to the default branch. Can take: 0 (not protected, both users with the Developer role or Maintainer role can push new commits and force push), 1 (partially protected, users with the Developer role or Maintainer role can push new commits, but cannot force push) or 2 (fully protected, users with the Developer or Maintainer role cannot push new commits, but users with the Developer or Maintainer role can; no one can force push) as a parameter. Default is 2. - `default_branch_protection_defaults` (Block List, Max: 1) The default_branch_protection_defaults attribute describes the default branch protection defaults. All parameters are optional. (see [below for nested schema](#nestedblock--default_branch_protection_defaults)) - `default_ci_config_path` (String) Default CI/CD configuration file and path for new projects (.gitlab-ci.yml if not set). @@ -106,25 +106,25 @@ resource "gitlab_application_settings" "this" { - `default_projects_limit` (Number) Project limit per user. - `default_snippet_visibility` (String) What visibility level new snippets receive. Can take private, internal and public as a parameter. - `default_syntax_highlighting_theme` (Number) Default syntax highlighting theme for users who are new or not signed in. See IDs of available themes (https://gitlab.com/gitlab-org/gitlab/blob/master/lib/gitlab/themes.rb#L16) -- `delete_inactive_projects` (Boolean) Enable inactive project deletion feature. Introduced in GitLab 14.10. Became operational in GitLab 15.0 (with feature flag inactive_projects_deletion). -- `delete_unconfirmed_users` (Boolean) Specifies whether users who have not confirmed their email should be deleted. When set to true, unconfirmed users are deleted after unconfirmed_users_delete_after_days days. Introduced in GitLab 16.1. Self-managed, Premium and Ultimate only. +- `delete_inactive_projects` (Boolean) Enable inactive project deletion feature. +- `delete_unconfirmed_users` (Boolean) Specifies whether users who have not confirmed their email should be deleted. When set to true, unconfirmed users are deleted after unconfirmed_users_delete_after_days days. Self-managed, Premium and Ultimate only. - `deletion_adjourned_period` (Number) The number of days to wait before deleting a project or group that is marked for deletion. Value must be between 1 and 90. - `diagramsnet_enabled` (Boolean) (If enabled, requires diagramsnet_url) Enable Diagrams.net integration. - `diagramsnet_url` (String) The Diagrams.net instance URL for integration. - `diff_max_files` (Number) Maximum files in a diff. - `diff_max_lines` (Number) Maximum lines in a diff. - `diff_max_patch_bytes` (Number) Maximum diff patch size, in bytes. -- `disable_admin_oauth_scopes` (Boolean) Stops administrators from connecting their GitLab accounts to non-trusted OAuth 2.0 applications that have the api, read_api, read_repository, write_repository, read_registry, write_registry, or sudo scopes. Introduced in GitLab 15.6. -- `disable_feed_token` (Boolean) Disable display of RSS/Atom and calendar feed tokens (introduced in GitLab 13.7). -- `disable_personal_access_tokens` (Boolean) Disable personal access tokens. Introduced in GitLab 15.7. Self-managed, Premium and Ultimate only. There is no method available to enable a personal access token that’s been disabled through the API. This is a known issue. +- `disable_admin_oauth_scopes` (Boolean) Stops administrators from connecting their GitLab accounts to non-trusted OAuth 2.0 applications that have the api, read_api, read_repository, write_repository, read_registry, write_registry, or sudo scopes. +- `disable_feed_token` (Boolean) Disable display of RSS/Atom and calendar feed tokens. +- `disable_personal_access_tokens` (Boolean) Disable personal access tokens. Self-managed, Premium and Ultimate only. There is no method available to enable a personal access token that’s been disabled through the API. This is a known issue. - `disabled_oauth_sign_in_sources` (List of String) Disabled OAuth sign-in sources. - `dns_rebinding_protection_enabled` (Boolean) Enforce DNS rebinding attack protection. - `domain_allowlist` (List of String) Force people to use only corporate emails for sign-up. Null means there is no restriction. - `domain_denylist` (List of String) Users with email addresses that match these domains cannot sign up. Wildcards allowed. Use separate lines for multiple entries. Ex: domain.com, *.domain.com. - `domain_denylist_enabled` (Boolean) (If enabled, requires: domain_denylist) Allows blocking sign-ups from emails from specific domains. -- `downstream_pipeline_trigger_limit_per_project_user_sha` (Number) Maximum downstream pipeline trigger rate. Introduced in GitLab 16.10. +- `downstream_pipeline_trigger_limit_per_project_user_sha` (Number) Maximum downstream pipeline trigger rate. - `dsa_key_restriction` (Number) The minimum allowed bit length of an uploaded DSA key. 0 means no restriction. -1 disables DSA keys. -- `duo_features_enabled` (Boolean) Indicates whether GitLab Duo features are enabled for this instance. Introduced in GitLab 16.10. Self-managed, Premium and Ultimate only. +- `duo_features_enabled` (Boolean) Indicates whether GitLab Duo features are enabled for this instance. Self-managed, Premium and Ultimate only. - `ecdsa_key_restriction` (Number) The minimum allowed curve size (in bits) of an uploaded ECDSA key. 0 means no restriction. -1 disables ECDSA keys. - `ecdsa_sk_key_restriction` (Number) The minimum allowed curve size (in bits) of an uploaded ECDSA_SK key. 0 means no restriction. -1 disables ECDSA_SK keys. - `ed25519_key_restriction` (Number) The minimum allowed curve size (in bits) of an uploaded ED25519 key. 0 means no restriction. -1 disables ED25519 keys. @@ -174,13 +174,13 @@ resource "gitlab_application_settings" "this" { - `first_day_of_week` (Number) Start day of the week for calendar views and date pickers. Valid values are 0 for Sunday, 1 for Monday, and 6 for Saturday. - `geo_node_allowed_ips` (String) Comma-separated list of IPs and CIDRs of allowed secondary nodes. For example, 1.1.1.1, 2.2.2.0/24. - `geo_status_timeout` (Number) The amount of seconds after which a request to get a secondary node status times out. -- `git_rate_limit_users_alertlist` (List of Number) List of user IDs that are emailed when the Git abuse rate limit is exceeded. Maximum: 100 user IDs. Introduced in GitLab 15.9. Self-managed, Ultimate only. -- `git_rate_limit_users_allowlist` (List of String) List of usernames excluded from Git anti-abuse rate limits. Maximum: 100 usernames. Introduced in GitLab 15.2. Self-managed, Ultimate only. +- `git_rate_limit_users_alertlist` (List of Number) List of user IDs that are emailed when the Git abuse rate limit is exceeded. Maximum: 100 user IDs. Self-managed, Ultimate only. +- `git_rate_limit_users_allowlist` (List of String) List of usernames excluded from Git anti-abuse rate limits. Maximum: 100 usernames. Self-managed, Ultimate only. - `git_two_factor_session_expiry` (Number) Maximum duration (in minutes) of a session for Git operations when 2FA is enabled. - `gitaly_timeout_default` (Number) Default Gitaly timeout, in seconds. This timeout is not enforced for Git fetch/push operations or Sidekiq jobs. Set to 0 to disable timeouts. - `gitaly_timeout_fast` (Number) Gitaly fast operation timeout, in seconds. Some Gitaly operations are expected to be fast. If they exceed this threshold, there may be a problem with a storage shard and ‘failing fast’ can help maintain the stability of the GitLab instance. Set to 0 to disable timeouts. - `gitaly_timeout_medium` (Number) Medium Gitaly timeout, in seconds. This should be a value between the Fast and the Default timeout. Set to 0 to disable timeouts. -- `gitlab_shell_operation_limit` (Number) Maximum number of Git operations per minute a user can perform. Introduced in GitLab 16.2. +- `gitlab_shell_operation_limit` (Number) Maximum number of Git operations per minute a user can perform. - `gitpod_enabled` (Boolean) Enable Gitpod integration. - `gitpod_url` (String) The Gitpod instance URL for integration. - `globally_allowed_ips` (String) Comma-separated list of IP addresses and CIDRs always allowed for inbound traffic. For example, 1.1.1.1, 2.2.2.0/24. @@ -205,10 +205,10 @@ resource "gitlab_application_settings" "this" { - `html_emails_enabled` (Boolean) Enable HTML emails. - `import_sources` (List of String) Sources to allow project import from. Valid values are: `github`, `bitbucket`, `bitbucket_server`, `fogbugz`, `git`, `gitlab_project`, `gitea`, `manifest` - `in_product_marketing_emails_enabled` (Boolean) Enable in-product marketing emails. -- `inactive_projects_delete_after_months` (Number) If delete_inactive_projects is true, the time (in months) to wait before deleting inactive projects. Introduced in GitLab 14.10. Became operational in GitLab 15.0. -- `inactive_projects_min_size_mb` (Number) If delete_inactive_projects is true, the minimum repository size for projects to be checked for inactivity. Introduced in GitLab 14.10. Became operational in GitLab 15.0. -- `inactive_projects_send_warning_email_after_months` (Number) If delete_inactive_projects is true, sets the time (in months) to wait before emailing maintainers that the project is scheduled be deleted because it is inactive. Introduced in GitLab 14.10. Became operational in GitLab 15.0. -- `include_optional_metrics_in_service_ping` (Boolean) Whether or not optional metrics are enabled in Service Ping. Introduced in GitLab 16.10. +- `inactive_projects_delete_after_months` (Number) If delete_inactive_projects is true, the time (in months) to wait before deleting inactive projects. +- `inactive_projects_min_size_mb` (Number) If delete_inactive_projects is true, the minimum repository size for projects to be checked for inactivity. +- `inactive_projects_send_warning_email_after_months` (Number) If delete_inactive_projects is true, sets the time (in months) to wait before emailing maintainers that the project is scheduled be deleted because it is inactive. +- `include_optional_metrics_in_service_ping` (Boolean) Whether or not optional metrics are enabled in Service Ping. - `invisible_captcha_enabled` (Boolean) Enable Invisible CAPTCHA spam detection during sign-up. - `issues_create_limit` (Number) Max number of issue creation requests per minute per user. - `jira_connect_application_key` (String) ID of the OAuth application used to authenticate with the GitLab for Jira Cloud app. @@ -216,7 +216,7 @@ resource "gitlab_application_settings" "this" { - `jira_connect_public_key_storage_enabled` (Boolean) Enable public key storage for the GitLab for Jira Cloud app. - `keep_latest_artifact` (Boolean) Prevent the deletion of the artifacts from the most recent successful jobs, regardless of the expiry time. - `local_markdown_version` (Number) Increase this value when any cached Markdown should be invalidated. -- `lock_duo_features_enabled` (Boolean) Indicates whether the GitLab Duo features enabled setting is enforced for all subgroups. Introduced in GitLab 16.10. Self-managed, Premium and Ultimate only. +- `lock_duo_features_enabled` (Boolean) Indicates whether the GitLab Duo features enabled setting is enforced for all subgroups. Self-managed, Premium and Ultimate only. - `mailgun_events_enabled` (Boolean) Enable Mailgun event receiver. - `mailgun_signing_key` (String, Sensitive) The Mailgun HTTP webhook signing key for receiving events from webhook. - `maintenance_mode` (Boolean) When instance is in maintenance mode, non-administrative users can sign in with read-only access and make read-only API requests. @@ -226,17 +226,17 @@ resource "gitlab_application_settings" "this" { - `max_attachment_size` (Number) Limit attachment size in MB. - `max_decompressed_archive_size` (Number) Maximum decompressed archive size in bytes. - `max_export_size` (Number) Maximum export size in MB. 0 for unlimited. -- `max_import_remote_file_size` (Number) Maximum remote file size for imports from external object storages. Introduced in GitLab 16.3. +- `max_import_remote_file_size` (Number) Maximum remote file size for imports from external object storages. - `max_import_size` (Number) Maximum import size in MB. 0 for unlimited. - `max_login_attempts` (Number) Maximum number of sign-in attempts before locking out the user. -- `max_number_of_repository_downloads` (Number) Maximum number of unique repositories a user can download in the specified time period before they are banned. Maximum: 10,000 repositories. Introduced in GitLab 15.1. -- `max_number_of_repository_downloads_within_time_period` (Number) Reporting time period (in seconds). Maximum: 864000 seconds (10 days). Introduced in GitLab 15.1. +- `max_number_of_repository_downloads` (Number) Maximum number of unique repositories a user can download in the specified time period before they are banned. Maximum: 10,000 repositories. +- `max_number_of_repository_downloads_within_time_period` (Number) Reporting time period (in seconds). Maximum: 864000 seconds (10 days). - `max_pages_size` (Number) Maximum size of pages repositories in MB. - `max_personal_access_token_lifetime` (Number) Maximum allowable lifetime for access tokens in days. -- `max_ssh_key_lifetime` (Number) Maximum allowable lifetime for SSH keys in days. Introduced in GitLab 14.6. +- `max_ssh_key_lifetime` (Number) Maximum allowable lifetime for SSH keys in days. - `max_terraform_state_size_bytes` (Number) Maximum size in bytes of the Terraform state files. Set this to 0 for unlimited file size. - `metrics_method_call_threshold` (Number) A method call is only tracked when it takes longer than the given amount of milliseconds. -- `minimum_password_length` (Number) Indicates whether passwords require a minimum length. Introduced in GitLab 15.1. Premium and Ultimate only. +- `minimum_password_length` (Number) Indicates whether passwords require a minimum length. Premium and Ultimate only. - `mirror_available` (Boolean) Allow repository mirroring to configured by project Maintainers. If disabled, only Administrators can configure repository mirroring. - `mirror_capacity_threshold` (Number) Minimum capacity to be available before scheduling more mirrors preemptively. - `mirror_max_capacity` (Number) Maximum number of mirrors that can be synchronizing at the same time. @@ -250,10 +250,10 @@ resource "gitlab_application_settings" "this" { - `pages_domain_verification_enabled` (Boolean) Require users to prove ownership of custom domains. Domain verification is an essential security measure for public GitLab sites. Users are required to demonstrate they control a domain before it is enabled. - `password_authentication_enabled_for_git` (Boolean) Enable authentication for Git over HTTP(S) via a GitLab account password. - `password_authentication_enabled_for_web` (Boolean) Enable authentication for the web interface via a GitLab account password. -- `password_lowercase_required` (Boolean) Indicates whether passwords require at least one lowercase letter. Introduced in GitLab 15.1. -- `password_number_required` (Boolean) Indicates whether passwords require at least one number. Introduced in GitLab 15.1. -- `password_symbol_required` (Boolean) Indicates whether passwords require at least one symbol character. Introduced in GitLab 15.1. -- `password_uppercase_required` (Boolean) Indicates whether passwords require at least one uppercase letter. Introduced in GitLab 15.1. +- `password_lowercase_required` (Boolean) Indicates whether passwords require at least one lowercase letter. +- `password_number_required` (Boolean) Indicates whether passwords require at least one number. +- `password_symbol_required` (Boolean) Indicates whether passwords require at least one symbol character. +- `password_uppercase_required` (Boolean) Indicates whether passwords require at least one uppercase letter. - `performance_bar_allowed_group_path` (String) Path of the group that is allowed to toggle the performance bar. - `personal_access_token_prefix` (String) Prefix for all generated personal access tokens. - `pipeline_limit_per_project_user_sha` (Number) Maximum number of pipeline creation requests per minute per user and commit. @@ -261,8 +261,8 @@ resource "gitlab_application_settings" "this" { - `plantuml_url` (String) The PlantUML instance URL for integration. - `polling_interval_multiplier` (Number) Interval multiplier used by endpoints that perform polling. Set to 0 to disable polling. - `project_export_enabled` (Boolean) Enable project export. -- `project_jobs_api_rate_limit` (Number) Maximum authenticated requests to /project/:id/jobs per minute. Introduced in GitLab 16.5. -- `projects_api_rate_limit_unauthenticated` (Number) Introduced in GitLab 15.10. Max number of requests per 10 minutes per IP address for unauthenticated requests to the list all projects API. To disable throttling set to 0. +- `project_jobs_api_rate_limit` (Number) Maximum authenticated requests to /project/:id/jobs per minute. +- `projects_api_rate_limit_unauthenticated` (Number) Max number of requests per 10 minutes per IP address for unauthenticated requests to the list all projects API. To disable throttling set to 0. - `prometheus_metrics_enabled` (Boolean) Enable Prometheus metrics. - `protected_ci_variables` (Boolean) CI/CD variables are protected by default. - `push_event_activities_limit` (Number) Number of changes (branches or tags) in a single push to determine whether individual push events or bulk push events are created. Bulk push events are created if it surpasses that value. @@ -275,7 +275,7 @@ resource "gitlab_application_settings" "this" { - `recaptcha_site_key` (String, Sensitive) Site key for reCAPTCHA. - `receive_max_input_size` (Number) Maximum push size (MB). - `receptive_cluster_agents_enabled` (Boolean) Enable receptive mode for GitLab Agents for Kubernetes. -- `remember_me_enabled` (Boolean) Enable Remember me setting. Introduced in GitLab 16.0. +- `remember_me_enabled` (Boolean) Enable Remember me setting. - `repository_checks_enabled` (Boolean) GitLab periodically runs git fsck in all project and wiki repositories to look for silent disk corruption issues. - `repository_size_limit` (Number) Size limit per repository (MB). - `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. @@ -290,7 +290,7 @@ resource "gitlab_application_settings" "this" { - `search_rate_limit_unauthenticated` (Number) Max number of requests per minute for performing a search while unauthenticated. To disable throttling set to 0. - `security_approval_policies_limit` (Number) Maximum number of active merge request approval policies per security policy project. Maximum: 20 - `security_policy_global_group_approvers_enabled` (Boolean) Whether to look up merge request approval policy approval groups globally or within project hierarchies. -- `security_txt_content` (String) Public security contact information. Introduced in GitLab 16.7. +- `security_txt_content` (String) Public security contact information. - `send_user_confirmation_email` (Boolean) Send confirmation email on sign-up. - `service_access_tokens_expiration_enforced` (Boolean) Flag to indicate if token expiry date can be optional for service account users - `session_expire_delay` (Number) Session duration in minutes. GitLab restart is required to apply changes. @@ -346,7 +346,7 @@ resource "gitlab_application_settings" "this" { - `throttle_unauthenticated_web_requests_per_period` (Number) Max requests per period per IP. - `time_tracking_limit_to_hours` (Boolean) Limit display of time tracking units to hours. - `two_factor_grace_period` (Number) Amount of time (in hours) that users are allowed to skip forced configuration of two-factor authentication. -- `unconfirmed_users_delete_after_days` (Number) Specifies how many days after sign-up to delete users who have not confirmed their email. Only applicable if delete_unconfirmed_users is set to true. Must be 1 or greater. Introduced in GitLab 16.1. Self-managed, Premium and Ultimate only. +- `unconfirmed_users_delete_after_days` (Number) Specifies how many days after sign-up to delete users who have not confirmed their email. Only applicable if delete_unconfirmed_users is set to true. Must be 1 or greater. Self-managed, Premium and Ultimate only. - `unique_ips_limit_enabled` (Boolean) (If enabled, requires: unique_ips_limit_per_user and unique_ips_limit_time_window) Limit sign in from multiple IPs. - `unique_ips_limit_per_user` (Number) Maximum number of IPs per user. - `unique_ips_limit_time_window` (Number) How many seconds an IP is counted towards the limit. @@ -356,7 +356,7 @@ resource "gitlab_application_settings" "this" { - `user_deactivation_emails_enabled` (Boolean) Send an email to users upon account deactivation. - `user_default_external` (Boolean) Newly registered users are external by default. - `user_default_internal_regex` (String) Specify an email address regex pattern to identify default internal users. -- `user_defaults_to_private_profile` (Boolean) Newly created users have private profile by default. Introduced in GitLab 15.8. +- `user_defaults_to_private_profile` (Boolean) Newly created users have private profile by default. - `user_oauth_applications` (Boolean) Allow users to register any application to use GitLab as an OAuth provider. - `user_show_add_ssh_key_message` (Boolean) When set to false disable the You won't be able to pull or push project code via SSH warning shown to users with no uploaded SSH key. - `valid_runner_registrars` (List of String) List of types which are allowed to register a GitLab Runner. Can be [], ['group'], ['project'] or ['group', 'project']. diff --git a/docs/resources/branch.md b/docs/resources/branch.md index 302d1cf77..539ffba9a 100644 --- a/docs/resources/branch.md +++ b/docs/resources/branch.md @@ -4,14 +4,14 @@ page_title: "gitlab_branch Resource - terraform-provider-gitlab" subcategory: "" description: |- The gitlab_branch resource allows to manage the lifecycle of a repository branch. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/branches.html + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/branches/ --- # gitlab_branch (Resource) The `gitlab_branch` resource allows to manage the lifecycle of a repository branch. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/branches.html) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/branches/) ## Example Usage diff --git a/docs/resources/branch_protection.md b/docs/resources/branch_protection.md index de8851f18..ace93e744 100644 --- a/docs/resources/branch_protection.md +++ b/docs/resources/branch_protection.md @@ -12,7 +12,7 @@ description: |- 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. This behavior might change in the future. ~> The allowed_to_push, allowed_to_merge, allowed_to_unprotect, unprotect_access_level and code_owner_approval_required attributes require a GitLab Enterprise instance. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/protected_branches.html + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/protected_branches/ --- # gitlab_branch_protection (Resource) @@ -29,7 +29,7 @@ The `gitlab_branch_protection` resource allows to manage the lifecycle of a prot ~> The `allowed_to_push`, `allowed_to_merge`, `allowed_to_unprotect`, `unprotect_access_level` and `code_owner_approval_required` attributes require a GitLab Enterprise instance. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/protected_branches.html) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/protected_branches/) ## Example Usage diff --git a/docs/resources/cluster_agent.md b/docs/resources/cluster_agent.md index 6613fc968..fe08b79c2 100644 --- a/docs/resources/cluster_agent.md +++ b/docs/resources/cluster_agent.md @@ -6,11 +6,10 @@ description: |- The gitlab_cluster_agent resource allows to manage the lifecycle of a GitLab Agent for Kubernetes. -> Note that this resource only registers the agent, but doesn't configure it. The configuration needs to be manually added as described in - the docs https://docs.gitlab.com/ee/user/clusters/agent/install/index.html#create-an-agent-configuration-file. + the docs https://docs.gitlab.com/user/clusters/agent/install/index/#create-an-agent-configuration-file. However, a gitlab_repository_file resource may be used to achieve that. -> Requires at least maintainer permissions on the project. - -> Requires at least GitLab 14.10 - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/cluster_agents.html + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/cluster_agents/ --- # gitlab_cluster_agent (Resource) @@ -19,14 +18,12 @@ The `gitlab_cluster_agent` resource allows to manage the lifecycle of a GitLab A -> Note that this resource only registers the agent, but doesn't configure it. The configuration needs to be manually added as described in - [the docs](https://docs.gitlab.com/ee/user/clusters/agent/install/index.html#create-an-agent-configuration-file). + [the docs](https://docs.gitlab.com/user/clusters/agent/install/index/#create-an-agent-configuration-file). However, a `gitlab_repository_file` resource may be used to achieve that. -> Requires at least maintainer permissions on the project. --> Requires at least GitLab 14.10 - -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/cluster_agents.html) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/cluster_agents/) ## Example Usage @@ -37,7 +34,7 @@ resource "gitlab_cluster_agent" "example" { } // Optionally, configure the agent as described in -// https://docs.gitlab.com/ee/user/clusters/agent/install/index.html#create-an-agent-configuration-file +// https://docs.gitlab.com/user/clusters/agent/install/index/#create-an-agent-configuration-file resource "gitlab_repository_file" "example_agent_config" { project = gitlab_cluster_agent.example.project branch = "main" // or use the `default_branch` attribute from a project data source / resource diff --git a/docs/resources/cluster_agent_token.md b/docs/resources/cluster_agent_token.md index 49f01046f..1e5688f84 100644 --- a/docs/resources/cluster_agent_token.md +++ b/docs/resources/cluster_agent_token.md @@ -5,8 +5,7 @@ subcategory: "" description: |- The gitlab_cluster_agent_token resource allows to manage the lifecycle of a token for a GitLab Agent for Kubernetes. -> Requires at least maintainer permissions on the project. - -> Requires at least GitLab 15.0 - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/cluster_agents.html#create-an-agent-token + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/cluster_agents/#create-an-agent-token --- # gitlab_cluster_agent_token (Resource) @@ -15,9 +14,7 @@ The `gitlab_cluster_agent_token` resource allows to manage the lifecycle of a to -> Requires at least maintainer permissions on the project. --> Requires at least GitLab 15.0 - -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/cluster_agents.html#create-an-agent-token) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/cluster_agents/#create-an-agent-token) ## Example Usage diff --git a/docs/resources/compliance_framework.md b/docs/resources/compliance_framework.md index d4979ab50..6a7bd1efa 100644 --- a/docs/resources/compliance_framework.md +++ b/docs/resources/compliance_framework.md @@ -7,7 +7,7 @@ description: |- There can be only one default compliance framework. Of all the configured compliance frameworks marked as default, the last one applied will be the default compliance framework. -> This resource requires a GitLab Enterprise instance with a Premium license to create the compliance framework. -> This resource requires a GitLab Enterprise instance with an Ultimate license to specify a compliance pipeline configuration in the compliance framework. - Upstream API: GitLab GraphQL API docs https://docs.gitlab.com/ee/api/graphql/reference/#mutationcreatecomplianceframework + Upstream API: GitLab GraphQL API docs https://docs.gitlab.com/api/graphql/reference/#mutationcreatecomplianceframework --- # gitlab_compliance_framework (Resource) @@ -20,7 +20,7 @@ There can be only one `default` compliance framework. Of all the configured comp -> This resource requires a GitLab Enterprise instance with an Ultimate license to specify a compliance pipeline configuration in the compliance framework. -**Upstream API**: [GitLab GraphQL API docs](https://docs.gitlab.com/ee/api/graphql/reference/#mutationcreatecomplianceframework) +**Upstream API**: [GitLab GraphQL API docs](https://docs.gitlab.com/api/graphql/reference/#mutationcreatecomplianceframework) ## Example Usage diff --git a/docs/resources/deploy_key.md b/docs/resources/deploy_key.md index ecb18ebf5..46efc974a 100644 --- a/docs/resources/deploy_key.md +++ b/docs/resources/deploy_key.md @@ -5,7 +5,7 @@ subcategory: "" description: |- The gitlab_deploy_key resource allows to manage the lifecycle of a deploy key. -> To enable an already existing deploy key for another project use the gitlab_deploy_key_enable resource. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/deploy_keys.html + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/deploy_keys/ --- # gitlab_deploy_key (Resource) @@ -14,7 +14,7 @@ The `gitlab_deploy_key` resource allows to manage the lifecycle of a deploy key. -> To enable an already existing deploy key for another project use the `gitlab_deploy_key_enable` resource. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/deploy_keys.html) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/deploy_keys/) ## Example Usage diff --git a/docs/resources/deploy_key_enable.md b/docs/resources/deploy_key_enable.md index 464299510..ee7c707ea 100644 --- a/docs/resources/deploy_key_enable.md +++ b/docs/resources/deploy_key_enable.md @@ -4,14 +4,14 @@ page_title: "gitlab_deploy_key_enable Resource - terraform-provider-gitlab" subcategory: "" description: |- The gitlab_deploy_key_enable resource allows to enable an already existing deploy key (see gitlab_deploy_key resource) for a specific project. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/deploy_keys.html#enable-a-deploy-key + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/deploy_keys/#enable-a-deploy-key --- # gitlab_deploy_key_enable (Resource) The `gitlab_deploy_key_enable` resource allows to enable an already existing deploy key (see `gitlab_deploy_key resource`) for a specific project. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/deploy_keys.html#enable-a-deploy-key) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/deploy_keys/#enable-a-deploy-key) ## Example Usage diff --git a/docs/resources/deploy_token.md b/docs/resources/deploy_token.md index 13c4b784f..343cc025a 100644 --- a/docs/resources/deploy_token.md +++ b/docs/resources/deploy_token.md @@ -4,14 +4,14 @@ page_title: "gitlab_deploy_token Resource - terraform-provider-gitlab" subcategory: "" description: |- The gitlab_deploy_token resource allows to manage the lifecycle of group and project deploy tokens. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/deploy_tokens.html + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/deploy_tokens/ --- # gitlab_deploy_token (Resource) The `gitlab_deploy_token` resource allows to manage the lifecycle of group and project deploy tokens. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/deploy_tokens.html) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/deploy_tokens/) ## Example Usage diff --git a/docs/resources/global_level_notifications.md b/docs/resources/global_level_notifications.md index f9f10f95e..1f51be4f5 100644 --- a/docs/resources/global_level_notifications.md +++ b/docs/resources/global_level_notifications.md @@ -4,14 +4,14 @@ page_title: "gitlab_global_level_notifications Resource - terraform-provider-git subcategory: "" description: |- The gitlab_global_level_notifications resource allows to manage global notifications. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/notification_settings.html#group--project-level-notification-settings + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/notification_settings/#group--project-level-notification-settings --- # gitlab_global_level_notifications (Resource) The `gitlab_global_level_notifications` resource allows to manage global notifications. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/notification_settings.html#group--project-level-notification-settings) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/notification_settings/#group--project-level-notification-settings) ## Example Usage diff --git a/docs/resources/group.md b/docs/resources/group.md index 52824fd0d..33f213324 100644 --- a/docs/resources/group.md +++ b/docs/resources/group.md @@ -5,7 +5,7 @@ subcategory: "" description: |- The gitlab_group resource allows to manage the lifecycle of a group. -> 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. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/groups.html + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/groups/ --- # gitlab_group (Resource) @@ -14,7 +14,7 @@ The `gitlab_group` resource allows to manage the lifecycle of a group. -> 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. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/groups.html) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/groups/) ## Example Usage @@ -98,7 +98,7 @@ resource "gitlab_group" "example-five" { - `avatar` (String) A local path to the avatar image to upload. **Note**: not available for imported resources. - `avatar_hash` (String) The hash of the avatar image. Use `filesha256("path/to/avatar.png")` whenever possible. **Note**: this is used to trigger an update of the avatar. If it's not given, but an avatar is given, the avatar will be updated each time. - `default_branch` (String) Initial default branch name. -- `default_branch_protection` (Number, Deprecated) See https://docs.gitlab.com/ee/api/groups.html#options-for-default_branch_protection. Valid values are: `0`, `1`, `2`, `3`, `4`. +- `default_branch_protection` (Number, Deprecated) See https://docs.gitlab.com/api/groups/#options-for-default_branch_protection. Valid values are: `0`, `1`, `2`, `3`, `4`. - `default_branch_protection_defaults` (Block List, Max: 1) The default branch protection defaults (see [below for nested schema](#nestedblock--default_branch_protection_defaults)) - `description` (String) The group's description. - `emails_enabled` (Boolean) Enable email notifications. @@ -149,7 +149,7 @@ Optional: - `author_email_regex` (String) All commit author emails must match this regex, e.g. `@my-company.com$`. - `branch_name_regex` (String) All branch names must match this regex, e.g. `(feature|hotfix)\/*`. -- `commit_committer_check` (Boolean) Only commits pushed using verified emails are allowed. **Note** This attribute is only supported in GitLab versions >= 16.4. +- `commit_committer_check` (Boolean) Only commits pushed using verified emails are allowed. - `commit_committer_name_check` (Boolean) Users can only push commits to this repository if the commit author name is consistent with their GitLab account name. - `commit_message_negative_regex` (String) No commit message is allowed to match this regex, for example `ssh\:\/\/`. - `commit_message_regex` (String) All commit messages must match this regex, e.g. `Fixed \d+\..*`. @@ -159,7 +159,7 @@ Optional: - `member_check` (Boolean) Allows only GitLab users to author commits. - `prevent_secrets` (Boolean) GitLab will reject any files that are likely to contain secrets. - `reject_non_dco_commits` (Boolean) Reject commit when it’s not DCO certified. -- `reject_unsigned_commits` (Boolean) Only commits signed through GPG are allowed. **Note** This attribute is only supported in GitLab versions >= 16.4. +- `reject_unsigned_commits` (Boolean) Only commits signed through GPG are allowed. ## Import diff --git a/docs/resources/group_access_token.md b/docs/resources/group_access_token.md index e03bb5595..8a6f93c5f 100644 --- a/docs/resources/group_access_token.md +++ b/docs/resources/group_access_token.md @@ -4,23 +4,23 @@ page_title: "gitlab_group_access_token Resource - terraform-provider-gitlab" subcategory: "" description: |- The gitlab_group_access_token resource allows to manage the lifecycle of a group access token. - ~> Observability scopes are in beta and may not work on all instances. See more details in the documentation https://docs.gitlab.com/ee/operations/tracing.html + ~> Observability scopes are in beta and may not work on all instances. See more details in the documentation https://docs.gitlab.com/operations/tracing/ ~> Use rotation_configuration to automatically rotate tokens instead of using timestamp() as timestamp will cause changes with every plan. terraform apply must still be run to rotate the token. - ~> Due to Automatic reuse detection https://docs.gitlab.com/ee/api/group_access_tokens.html#automatic-reuse-detection it's possible that a new Group Access Token will immediately be revoked. Check if an old process using the old token is running if this happens. - Upstream API: GitLab REST API https://docs.gitlab.com/ee/api/group_access_tokens.html + ~> Due to Automatic reuse detection https://docs.gitlab.com/api/group_access_tokens/#automatic-reuse-detection it's possible that a new Group Access Token will immediately be revoked. Check if an old process using the old token is running if this happens. + Upstream API: GitLab REST API https://docs.gitlab.com/api/group_access_tokens/ --- # gitlab_group_access_token (Resource) The `gitlab_group_access_token` resource allows to manage the lifecycle of a group access token. -~> Observability scopes are in beta and may not work on all instances. See more details in [the documentation](https://docs.gitlab.com/ee/operations/tracing.html) +~> Observability scopes are in beta and may not work on all instances. See more details in [the documentation](https://docs.gitlab.com/operations/tracing/) ~> Use `rotation_configuration` to automatically rotate tokens instead of using `timestamp()` as timestamp will cause changes with every plan. `terraform apply` must still be run to rotate the token. -~> Due to [Automatic reuse detection](https://docs.gitlab.com/ee/api/group_access_tokens.html#automatic-reuse-detection) it's possible that a new Group Access Token will immediately be revoked. Check if an old process using the old token is running if this happens. +~> Due to [Automatic reuse detection](https://docs.gitlab.com/api/group_access_tokens/#automatic-reuse-detection) it's possible that a new Group Access Token will immediately be revoked. Check if an old process using the old token is running if this happens. -**Upstream API**: [GitLab REST API](https://docs.gitlab.com/ee/api/group_access_tokens.html) +**Upstream API**: [GitLab REST API](https://docs.gitlab.com/api/group_access_tokens/) ## Example Usage diff --git a/docs/resources/group_badge.md b/docs/resources/group_badge.md index 89495ac40..2529c9dba 100644 --- a/docs/resources/group_badge.md +++ b/docs/resources/group_badge.md @@ -4,14 +4,14 @@ page_title: "gitlab_group_badge Resource - terraform-provider-gitlab" subcategory: "" description: |- The gitlab_group_badge resource allows to manage the lifecycle of group badges. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/user/project/badges.html#group-badges + Upstream API: GitLab REST API docs https://docs.gitlab.com/user/project/badges/#group-badges --- # gitlab_group_badge (Resource) The `gitlab_group_badge` resource allows to manage the lifecycle of group badges. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/user/project/badges.html#group-badges) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/user/project/badges/#group-badges) ## Example Usage @@ -53,7 +53,7 @@ resource "gitlab_group_badge" "gitlab_release" { ### Required -- `group` (String) The id of the group to add the badge to. +- `group` (String) The ID or URL-encoded path of the group to add the badge to. - `image_url` (String) The image url which will be presented on group overview. - `link_url` (String) The url linked with the badge. @@ -63,7 +63,7 @@ resource "gitlab_group_badge" "gitlab_release" { ### Read-Only -- `id` (String) The ID of this resource. +- `id` (String) The ID of this Terraform resource. In the format of `:`. - `rendered_image_url` (String) The image_url argument rendered (in case of use of placeholders). - `rendered_link_url` (String) The link_url argument rendered (in case of use of placeholders). diff --git a/docs/resources/group_cluster.md b/docs/resources/group_cluster.md index 074e65afc..174844a0d 100644 --- a/docs/resources/group_cluster.md +++ b/docs/resources/group_cluster.md @@ -5,7 +5,7 @@ subcategory: "" description: |- The gitlab_group_cluster resource allows to manage the lifecycle of a group cluster. ~> This is deprecated GitLab feature since 14.5 - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/group_clusters.html + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/group_clusters/ --- # gitlab_group_cluster (Resource) @@ -14,7 +14,7 @@ The `gitlab_group_cluster` resource allows to manage the lifecycle of a group cl ~> This is deprecated GitLab feature since 14.5 -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/group_clusters.html) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/group_clusters/) ## Example Usage diff --git a/docs/resources/group_custom_attribute.md b/docs/resources/group_custom_attribute.md index 4369eb1fe..f89334131 100644 --- a/docs/resources/group_custom_attribute.md +++ b/docs/resources/group_custom_attribute.md @@ -4,14 +4,14 @@ page_title: "gitlab_group_custom_attribute Resource - terraform-provider-gitlab" subcategory: "" description: |- The gitlab_group_custom_attribute resource allows to manage custom attributes for a group. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/custom_attributes.html + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/custom_attributes/ --- # gitlab_group_custom_attribute (Resource) The `gitlab_group_custom_attribute` resource allows to manage custom attributes for a group. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/custom_attributes.html) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/custom_attributes/) ## Example Usage diff --git a/docs/resources/group_epic_board.md b/docs/resources/group_epic_board.md index 76c38dee2..5c2df1bb1 100644 --- a/docs/resources/group_epic_board.md +++ b/docs/resources/group_epic_board.md @@ -5,7 +5,7 @@ subcategory: "" description: |- The gitlab_group_epic_board resource allows to manage the lifecycle of a epic board in a group. ~> Multiple epic boards on one group requires a GitLab Premium or above License. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/group_boards.html + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/group_boards/ --- # gitlab_group_epic_board (Resource) @@ -14,7 +14,7 @@ The `gitlab_group_epic_board` resource allows to manage the lifecycle of a epic ~> Multiple epic boards on one group requires a GitLab Premium or above License. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/group_boards.html) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/group_boards/) ## Example Usage diff --git a/docs/resources/group_hook.md b/docs/resources/group_hook.md index 812074462..3d66cbe0a 100644 --- a/docs/resources/group_hook.md +++ b/docs/resources/group_hook.md @@ -4,14 +4,14 @@ page_title: "gitlab_group_hook Resource - terraform-provider-gitlab" subcategory: "" description: |- The gitlab_group_hook resource allows to manage the lifecycle of a group hook. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/groups.html#hooks + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/groups/#hooks --- # gitlab_group_hook (Resource) The `gitlab_group_hook` resource allows to manage the lifecycle of a group hook. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/groups.html#hooks) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/groups/#hooks) ## Example Usage diff --git a/docs/resources/group_issue_board.md b/docs/resources/group_issue_board.md index 39cd59b3f..e7b5d125a 100644 --- a/docs/resources/group_issue_board.md +++ b/docs/resources/group_issue_board.md @@ -5,7 +5,7 @@ subcategory: "" description: |- The gitlab_group_issue_board resource allows to manage the lifecycle of a issue board in a group. ~> Multiple issue boards on one group requires a GitLab Premium or above License. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/group_boards.html + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/group_boards/ --- # gitlab_group_issue_board (Resource) @@ -14,7 +14,7 @@ The `gitlab_group_issue_board` resource allows to manage the lifecycle of a issu ~> Multiple issue boards on one group requires a GitLab Premium or above License. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/group_boards.html) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/group_boards/) diff --git a/docs/resources/group_label.md b/docs/resources/group_label.md index b56063f93..580100171 100644 --- a/docs/resources/group_label.md +++ b/docs/resources/group_label.md @@ -4,14 +4,14 @@ page_title: "gitlab_group_label Resource - terraform-provider-gitlab" subcategory: "" description: |- The gitlab_group_label resource allows to manage the lifecycle of labels within a group. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/user/project/labels.html#group-labels + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/group_labels/ --- # gitlab_group_label (Resource) The `gitlab_group_label` resource allows to manage the lifecycle of labels within a group. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/user/project/labels.html#group-labels) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/group_labels/) ## Example Usage @@ -39,7 +39,7 @@ resource "gitlab_group_label" "fixme" { ### Read-Only -- `id` (String) The ID of this resource. +- `id` (String) The ID of this Terraform resource. In the format of `:`. - `label_id` (Number) The id of the group label. ## Import diff --git a/docs/resources/group_ldap_link.md b/docs/resources/group_ldap_link.md index 070bcea9a..496f2e6b4 100644 --- a/docs/resources/group_ldap_link.md +++ b/docs/resources/group_ldap_link.md @@ -4,14 +4,14 @@ page_title: "gitlab_group_ldap_link Resource - terraform-provider-gitlab" subcategory: "" description: |- The gitlab_group_ldap_link resource allows to manage the lifecycle of an LDAP integration with a group. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/groups.html#ldap-group-links + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/groups/#ldap-group-links --- # gitlab_group_ldap_link (Resource) The `gitlab_group_ldap_link` resource allows to manage the lifecycle of an LDAP integration with a group. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/groups.html#ldap-group-links) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/groups/#ldap-group-links) ## Example Usage @@ -30,7 +30,7 @@ resource "gitlab_group_ldap_link" "test" { ### Required - `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` +- `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` ### Optional diff --git a/docs/resources/group_membership.md b/docs/resources/group_membership.md index 9c3766ae0..01ce96b14 100644 --- a/docs/resources/group_membership.md +++ b/docs/resources/group_membership.md @@ -5,7 +5,7 @@ subcategory: "" description: |- The gitlab_group_membership resource allows to manage the lifecycle of a users group membership. -> If a group should grant membership to another group use the gitlab_group_share_group resource instead. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/members.html + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/members/ --- # gitlab_group_membership (Resource) @@ -14,13 +14,13 @@ The `gitlab_group_membership` resource allows to manage the lifecycle of a users -> If a group should grant membership to another group use the `gitlab_group_share_group` resource instead. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/members.html) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/members/) ## Example Usage ```terraform resource "gitlab_group_membership" "test" { - group_id = "12345" + group_id = 12345 user_id = 1337 access_level = "guest" expires_at = "2020-12-31" @@ -33,8 +33,8 @@ resource "gitlab_group_membership" "test" { ### Required - `access_level` (String) Access level for the member. Valid values are: `no one`, `minimal`, `guest`, `reporter`, `developer`, `maintainer`, `owner`. -- `group_id` (String) The id of the group. -- `user_id` (Number) The id of the user. +- `group_id` (Number) The ID of the group. +- `user_id` (Number) The ID of the user. ### Optional @@ -45,7 +45,7 @@ resource "gitlab_group_membership" "test" { ### Read-Only -- `id` (String) The ID of this resource. +- `id` (String) The ID of the group membership. In the format of ``. ## Import diff --git a/docs/resources/group_project_file_template.md b/docs/resources/group_project_file_template.md index 2c51857b8..f829a502c 100644 --- a/docs/resources/group_project_file_template.md +++ b/docs/resources/group_project_file_template.md @@ -7,9 +7,9 @@ description: |- custom file templates will be loaded. In order to use this resource, the project selected must be a direct child of the group selected. After the resource has run, gitlab_project_template.template_project_id is available for use. For more information about which file types are available as templates, view - GitLab's documentation https://docs.gitlab.com/ee/user/group/custom_project_templates.html + GitLab's documentation https://docs.gitlab.com/user/group/custom_project_templates/ -> This resource requires a GitLab Enterprise instance with a Premium license. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/groups.html#update-group + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/groups/#update-group --- # gitlab_group_project_file_template (Resource) @@ -18,11 +18,11 @@ The `gitlab_group_project_file_template` resource allows setting a project from custom file templates will be loaded. In order to use this resource, the project selected must be a direct child of the group selected. After the resource has run, `gitlab_project_template.template_project_id` is available for use. For more information about which file types are available as templates, view -[GitLab's documentation](https://docs.gitlab.com/ee/user/group/custom_project_templates.html) +[GitLab's documentation](https://docs.gitlab.com/user/group/custom_project_templates/) -> This resource requires a GitLab Enterprise instance with a Premium license. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/groups.html#update-group) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/groups/#update-group) ## Example Usage diff --git a/docs/resources/group_protected_environment.md b/docs/resources/group_protected_environment.md index e640f4116..4bb49f047 100644 --- a/docs/resources/group_protected_environment.md +++ b/docs/resources/group_protected_environment.md @@ -8,7 +8,7 @@ description: |- you need to make sure that users have access to the group with Maintainer role or higher. In order to use a group_id in the deploy_access_levels configuration, the group_id must be a sub-group under the given group. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/group_protected_environments.html + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/group_protected_environments/ --- # gitlab_group_protected_environment (Resource) @@ -20,7 +20,7 @@ The `gitlab_group_protected_environment` resource allows to manage the lifecycle In order to use a group_id in the `deploy_access_levels` configuration, the group_id must be a sub-group under the given group. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/group_protected_environments.html) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/group_protected_environments/) ## Example Usage diff --git a/docs/resources/group_saml_link.md b/docs/resources/group_saml_link.md index ca1f7896e..530582756 100644 --- a/docs/resources/group_saml_link.md +++ b/docs/resources/group_saml_link.md @@ -4,14 +4,14 @@ page_title: "gitlab_group_saml_link Resource - terraform-provider-gitlab" subcategory: "" description: |- The gitlab_group_saml_link resource allows to manage the lifecycle of an SAML integration with a group. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/groups.html#saml-group-links + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/groups/#saml-group-links --- # gitlab_group_saml_link (Resource) The `gitlab_group_saml_link` resource allows to manage the lifecycle of an SAML integration with a group. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/groups.html#saml-group-links) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/groups/#saml-group-links) ## Example Usage diff --git a/docs/resources/group_security_policy_attachment.md b/docs/resources/group_security_policy_attachment.md index fdcff7aee..026a64ddb 100644 --- a/docs/resources/group_security_policy_attachment.md +++ b/docs/resources/group_security_policy_attachment.md @@ -4,17 +4,17 @@ page_title: "gitlab_group_security_policy_attachment Resource - terraform-provid subcategory: "" description: |- The gitlab_group_security_policy_attachment resource allows to attach a security policy project to a group. - ~> Policies https://docs.gitlab.com/ee/user/application_security/policies/ are files stored in a policy project as raw YAML, to allow maximum flexibility with support of all kind of policy and all their options. See the examples for how to create a policy project, add a policy, and link it. Use the gitlab_repository_file resource to create policies instead of a specific policy resource. This ensures all policy options are immediately via Terraform once released. - Upstream API: GitLab GraphQL API docs https://docs.gitlab.com/ee/api/graphql/reference/index.html#mutationsecuritypolicyprojectassign + ~> Policies https://docs.gitlab.com/user/application_security/policies/ are files stored in a policy project as raw YAML, to allow maximum flexibility with support of all kind of policy and all their options. See the examples for how to create a policy project, add a policy, and link it. Use the gitlab_repository_file resource to create policies instead of a specific policy resource. This ensures all policy options are immediately via Terraform once released. + Upstream API: GitLab GraphQL API docs https://docs.gitlab.com/api/graphql/reference/index/#mutationsecuritypolicyprojectassign --- # gitlab_group_security_policy_attachment (Resource) The `gitlab_group_security_policy_attachment` resource allows to attach a security policy project to a group. -~> [Policies](https://docs.gitlab.com/ee/user/application_security/policies/) are files stored in a policy project as raw YAML, to allow maximum flexibility with support of all kind of policy and all their options. See the examples for how to create a policy project, add a policy, and link it. Use the `gitlab_repository_file` resource to create policies instead of a specific policy resource. This ensures all policy options are immediately via Terraform once released. +~> [Policies](https://docs.gitlab.com/user/application_security/policies/) are files stored in a policy project as raw YAML, to allow maximum flexibility with support of all kind of policy and all their options. See the examples for how to create a policy project, add a policy, and link it. Use the `gitlab_repository_file` resource to create policies instead of a specific policy resource. This ensures all policy options are immediately via Terraform once released. -**Upstream API**: [GitLab GraphQL API docs](https://docs.gitlab.com/ee/api/graphql/reference/index.html#mutationsecuritypolicyprojectassign) +**Upstream API**: [GitLab GraphQL API docs](https://docs.gitlab.com/api/graphql/reference/index/#mutationsecuritypolicyprojectassign) ## Example Usage diff --git a/docs/resources/group_service_account.md b/docs/resources/group_service_account.md index 889daee3b..df807ea25 100644 --- a/docs/resources/group_service_account.md +++ b/docs/resources/group_service_account.md @@ -4,14 +4,14 @@ page_title: "gitlab_group_service_account Resource - terraform-provider-gitlab" subcategory: "" description: |- The gitlab_group_service_account resource allows creating a GitLab group service account. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/group_service_accounts.html + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/group_service_accounts/ --- # gitlab_group_service_account (Resource) The `gitlab_group_service_account` resource allows creating a GitLab group service account. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/group_service_accounts.html) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/group_service_accounts/) ## Example Usage diff --git a/docs/resources/group_service_account_access_token.md b/docs/resources/group_service_account_access_token.md index c457d2e3c..310d65112 100644 --- a/docs/resources/group_service_account_access_token.md +++ b/docs/resources/group_service_account_access_token.md @@ -8,7 +8,7 @@ description: |- ~> Reading the access token status of a service account requires an admin token or a top-level group owner token on gitlab.com. As a result, this resource will ignore permission errors when attempting to read the token status, and will rely on the values in state instead. This can lead to apply-time failures if the token configured for the provider doesn't have permissions to rotate tokens for the service account. ~> Use rotation_configuration to automatically rotate tokens instead of using timestamp() as timestamp will cause changes with every plan. terraform apply must still be run to rotate the token. ~> Due to a limitation in the API, the rotation_configuration is unable to set the new expiry date. Instead, when the resource is created, it will default the expiry date to 7 days in the future. On each subsequent apply, the new expiry will be 7 days from the date of the apply. - Upstream API: GitLab API docs https://docs.gitlab.com/ee/api/group_service_accounts.html#create-a-personal-access-token-for-a-service-account-user + Upstream API: GitLab API docs https://docs.gitlab.com/api/group_service_accounts/#create-a-personal-access-token-for-a-service-account-user --- # gitlab_group_service_account_access_token (Resource) @@ -23,7 +23,7 @@ The `gitlab_group_service_account_access_token` resource allows to manage the li ~> Due to a limitation in the API, the `rotation_configuration` is unable to set the new expiry date. Instead, when the resource is created, it will default the expiry date to 7 days in the future. On each subsequent apply, the new expiry will be 7 days from the date of the apply. -**Upstream API**: [GitLab API docs](https://docs.gitlab.com/ee/api/group_service_accounts.html#create-a-personal-access-token-for-a-service-account-user) +**Upstream API**: [GitLab API docs](https://docs.gitlab.com/api/group_service_accounts/#create-a-personal-access-token-for-a-service-account-user) ## Example Usage diff --git a/docs/resources/group_share_group.md b/docs/resources/group_share_group.md index 1b8de519f..909193bdc 100644 --- a/docs/resources/group_share_group.md +++ b/docs/resources/group_share_group.md @@ -4,14 +4,14 @@ page_title: "gitlab_group_share_group Resource - terraform-provider-gitlab" subcategory: "" description: |- The gitlab_group_share_group resource allows to manage the lifecycle of group shared with another group. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/groups.html#share-groups-with-groups + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/groups/#share-groups-with-groups --- # gitlab_group_share_group (Resource) The `gitlab_group_share_group` resource allows to manage the lifecycle of group shared with another group. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/groups.html#share-groups-with-groups) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/groups/#share-groups-with-groups) ## Example Usage diff --git a/docs/resources/group_variable.md b/docs/resources/group_variable.md index 0f61cd6b5..feb0e59dd 100644 --- a/docs/resources/group_variable.md +++ b/docs/resources/group_variable.md @@ -3,15 +3,15 @@ page_title: "gitlab_group_variable Resource - terraform-provider-gitlab" subcategory: "" description: |- - The gitlab_group_variable resource allows to manage the lifecycle of a CI/CD variable for a group. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/group_level_variables.html + The gitlab_group_variable resource allows creating a GitLab group level variables. + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/group_level_variables/ --- # gitlab_group_variable (Resource) -The `gitlab_group_variable` resource allows to manage the lifecycle of a CI/CD variable for a group. +The `gitlab_group_variable` resource allows creating a GitLab group level variables. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/group_level_variables.html) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/group_level_variables/) ## Example Usage @@ -24,6 +24,16 @@ resource "gitlab_group_variable" "example" { masked = false environment_scope = "*" } + +# Example with masked and hidden +resource "gitlab_group_variable" "example" { + project = "12345" + key = "group_variable_key" + value = "group_variable_value" + masked = true + hidden = true + protected = false +} ``` @@ -39,14 +49,15 @@ resource "gitlab_group_variable" "example" { - `description` (String) The description of the variable. - `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`. +- `hidden` (Boolean) If set to `true`, the value of the variable will be hidden in the CI/CD User Interface. The value must meet the [hidden requirements](https://docs.gitlab.com/ci/variables/#hide-a-cicd-variable). +- `masked` (Boolean) If set to `true`, the value of the variable will be masked in job logs. The value must meet the [masking requirements](https://docs.gitlab.com/ci/variables/#mask-a-cicd-variable). +- `protected` (Boolean) If set to `true`, the variable will be passed only to pipelines running on protected branches and tags. +- `raw` (Boolean) Whether the variable is treated as a raw string. When true, variables in the value are not expanded. +- `variable_type` (String) The type of a variable. Valid values are: `env_var`, `file`. ### Read-Only -- `id` (String) The ID of this resource. +- `id` (String) The ID of this Terraform resource. In the format of `::`. ## Import diff --git a/docs/resources/instance_cluster.md b/docs/resources/instance_cluster.md index 85b866e88..f22dc1985 100644 --- a/docs/resources/instance_cluster.md +++ b/docs/resources/instance_cluster.md @@ -5,7 +5,7 @@ subcategory: "" description: |- The gitlab_instance_cluster resource allows to manage the lifecycle of an instance cluster. ~> This is deprecated GitLab feature since 14.5 - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/instance_clusters.html + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/instance_clusters/ --- # gitlab_instance_cluster (Resource) @@ -14,7 +14,7 @@ The `gitlab_instance_cluster` resource allows to manage the lifecycle of an inst ~> This is deprecated GitLab feature since 14.5 -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/instance_clusters.html) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/instance_clusters/) ## Example Usage diff --git a/docs/resources/instance_service_account.md b/docs/resources/instance_service_account.md index 9220646ae..997806721 100644 --- a/docs/resources/instance_service_account.md +++ b/docs/resources/instance_service_account.md @@ -5,7 +5,7 @@ subcategory: "" description: |- The gitlab_instance_service_account resource allows creating a GitLab instance service account. ~> In order for a user to create a user account, they must have admin privileges at the instance level. This makes this feature unavailable on gitlab.com - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/user_service_accounts.html + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/user_service_accounts/ --- # gitlab_instance_service_account (Resource) @@ -14,9 +14,29 @@ The `gitlab_instance_service_account` resource allows creating a GitLab instance ~> In order for a user to create a user account, they must have admin privileges at the instance level. This makes this feature unavailable on `gitlab.com` -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/user_service_accounts.html) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/user_service_accounts/) +## Example Usage +```terraform +# create a service account +resource "gitlab_instance_service_account" "example_sa" { + name = "example-name" + username = "example-username" + timeouts = { + # service accounts do not delete instantly, but you can set up a timeout on deletion + delete = "3m" + } +} + +resources "gitlab_personal_access_token" "example_token" { + user_id = gitlab_instance_service_account.example_sa.service_account_id + name = "Example personal access token for a service account" + expires_at = "2026-01-01" + + scopes = ["api"] +} +``` ## Schema @@ -38,3 +58,21 @@ The `gitlab_instance_service_account` resource allows creating a GitLab instance Optional: - `delete` (String) A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs. + +## Import + +Starting in Terraform v1.5.0 you can use an [import block](https://developer.hashicorp.com/terraform/language/import) to import `gitlab_instance_service_account`. For example: +```terraform +import { + to = gitlab_instance_service_account.example + id = "see CLI command below for ID" +} +``` + +Import using the CLI is supported using the following syntax: + +```shell +# You can import a group service account using `terraform import `. The +# `id` is the id of the service account +terraform import gitlab_instance_service_account.example example +``` diff --git a/docs/resources/instance_variable.md b/docs/resources/instance_variable.md index a0fc7a3be..8318d6298 100644 --- a/docs/resources/instance_variable.md +++ b/docs/resources/instance_variable.md @@ -4,14 +4,14 @@ page_title: "gitlab_instance_variable Resource - terraform-provider-gitlab" subcategory: "" description: |- The gitlab_instance_variable resource allows to manage the lifecycle of an instance-level CI/CD variable. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/instance_level_ci_variables.html + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/instance_level_ci_variables/ --- # gitlab_instance_variable (Resource) The `gitlab_instance_variable` resource allows to manage the lifecycle of an instance-level CI/CD variable. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/instance_level_ci_variables.html) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/instance_level_ci_variables/) ## Example Usage @@ -35,7 +35,7 @@ resource "gitlab_instance_variable" "example" { ### Optional - `description` (String) The description of the variable. Maximum of 255 characters. -- `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`. +- `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/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`. diff --git a/docs/resources/integration_custom_issue_tracker.md b/docs/resources/integration_custom_issue_tracker.md index 7e2689eaa..eced54738 100644 --- a/docs/resources/integration_custom_issue_tracker.md +++ b/docs/resources/integration_custom_issue_tracker.md @@ -4,14 +4,14 @@ page_title: "gitlab_integration_custom_issue_tracker Resource - terraform-provid subcategory: "" description: |- The gitlab_integration_custom_issue_tracker resource allows to manage the lifecycle of a project integration with Custom Issue Tracker. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/integrations.html#custom-issue-tracker + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/integrations/#custom-issue-tracker --- # gitlab_integration_custom_issue_tracker (Resource) The `gitlab_integration_custom_issue_tracker` resource allows to manage the lifecycle of a project integration with Custom Issue Tracker. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/integrations.html#custom-issue-tracker) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/integrations/#custom-issue-tracker) ## Example Usage diff --git a/docs/resources/integration_emails_on_push.md b/docs/resources/integration_emails_on_push.md index 5999419d7..ad69365a9 100644 --- a/docs/resources/integration_emails_on_push.md +++ b/docs/resources/integration_emails_on_push.md @@ -4,14 +4,14 @@ page_title: "gitlab_integration_emails_on_push Resource - terraform-provider-git subcategory: "" description: |- The gitlab_integration_emails_on_push resource allows to manage the lifecycle of a project integration with Emails on Push Service. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/integrations.html#emails-on-push + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/integrations/#emails-on-push --- # gitlab_integration_emails_on_push (Resource) The `gitlab_integration_emails_on_push` resource allows to manage the lifecycle of a project integration with Emails on Push Service. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/integrations.html#emails-on-push) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/integrations/#emails-on-push) ## Example Usage diff --git a/docs/resources/integration_external_wiki.md b/docs/resources/integration_external_wiki.md index 60ba9e3bc..575545ca2 100644 --- a/docs/resources/integration_external_wiki.md +++ b/docs/resources/integration_external_wiki.md @@ -4,14 +4,14 @@ page_title: "gitlab_integration_external_wiki Resource - terraform-provider-gitl subcategory: "" description: |- The gitlab_integration_external_wiki resource allows to manage the lifecycle of a project integration with External Wiki Service. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/integrations.html#external-wiki + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/integrations/#external-wiki --- # gitlab_integration_external_wiki (Resource) The `gitlab_integration_external_wiki` resource allows to manage the lifecycle of a project integration with External Wiki Service. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/integrations.html#external-wiki) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/integrations/#external-wiki) ## Example Usage diff --git a/docs/resources/integration_github.md b/docs/resources/integration_github.md index 31b04a597..eb9a52710 100644 --- a/docs/resources/integration_github.md +++ b/docs/resources/integration_github.md @@ -5,7 +5,7 @@ subcategory: "" description: |- The gitlab_integration_github resource allows to manage the lifecycle of a project integration with GitHub. -> This resource requires a GitLab Enterprise instance. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/integrations.html#github + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/integrations/#github --- # gitlab_integration_github (Resource) @@ -14,7 +14,7 @@ The `gitlab_integration_github` resource allows to manage the lifecycle of a pro -> This resource requires a GitLab Enterprise instance. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/integrations.html#github) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/integrations/#github) ## Example Usage diff --git a/docs/resources/integration_jenkins.md b/docs/resources/integration_jenkins.md index cf17adf2d..37bb9d349 100644 --- a/docs/resources/integration_jenkins.md +++ b/docs/resources/integration_jenkins.md @@ -4,14 +4,14 @@ page_title: "gitlab_integration_jenkins Resource - terraform-provider-gitlab" subcategory: "" description: |- The gitlab_integration_jenkins resource allows to manage the lifecycle of a project integration with Jenkins. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/integrations.html#jenkins + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/integrations/#jenkins --- # gitlab_integration_jenkins (Resource) The `gitlab_integration_jenkins` resource allows to manage the lifecycle of a project integration with Jenkins. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/integrations.html#jenkins) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/integrations/#jenkins) ## Example Usage diff --git a/docs/resources/integration_jira.md b/docs/resources/integration_jira.md index ba1eace2c..bf0591d53 100644 --- a/docs/resources/integration_jira.md +++ b/docs/resources/integration_jira.md @@ -4,14 +4,14 @@ page_title: "gitlab_integration_jira Resource - terraform-provider-gitlab" subcategory: "" description: |- The gitlab_integration_jira resource allows to manage the lifecycle of a project integration with Jira. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/integrations.html#jira + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/integrations/#jira --- # gitlab_integration_jira (Resource) The `gitlab_integration_jira` resource allows to manage the lifecycle of a project integration with Jira. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/integrations.html#jira) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/integrations/#jira) ## Example Usage @@ -49,7 +49,7 @@ resource "gitlab_integration_jira" "jira" { - `jira_issue_prefix` (String) Prefix to match Jira issue keys. - `jira_issue_regex` (String) Regular expression to match Jira issue keys. - `jira_issue_transition_automatic` (Boolean) Enable automatic issue transitions. Takes precedence over jira_issue_transition_id if enabled. Defaults to false. This value cannot be imported, and will not perform drift detection if changed outside Terraform. -- `jira_issue_transition_id` (String) The ID of a transition that moves issues to a closed state. You can find this number under the JIRA workflow administration (Administration > Issues > Workflows) by selecting View under Operations of the desired workflow of your project. By default, this ID is set to 2. *Note**: importing this field is only supported since GitLab 15.2. +- `jira_issue_transition_id` (String) The ID of a transition that moves issues to a closed state. You can find this number under the JIRA workflow administration (Administration > Issues > Workflows) by selecting View under Operations of the desired workflow of your project. By default, this ID is set to 2. - `merge_requests_events` (Boolean) Enable notifications for merge request events - `project_key` (String) The short identifier for your JIRA project, all uppercase, e.g., PROJ. - `project_keys` (List of String) Keys of Jira projects. When issues_enabled is true, this setting specifies which Jira projects to view issues from in GitLab. diff --git a/docs/resources/integration_mattermost.md b/docs/resources/integration_mattermost.md index 1de5bcbf1..e653a896f 100644 --- a/docs/resources/integration_mattermost.md +++ b/docs/resources/integration_mattermost.md @@ -4,14 +4,14 @@ page_title: "gitlab_integration_mattermost Resource - terraform-provider-gitlab" subcategory: "" description: |- The gitlab_integration_mattermost resource allows to manage the lifecycle of a project integration with Mattermost. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/integrations.html#mattermost-notifications + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/integrations/#mattermost-notifications --- # gitlab_integration_mattermost (Resource) The `gitlab_integration_mattermost` resource allows to manage the lifecycle of a project integration with Mattermost. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/integrations.html#mattermost-notifications) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/integrations/#mattermost-notifications) ## Example Usage diff --git a/docs/resources/integration_microsoft_teams.md b/docs/resources/integration_microsoft_teams.md index f387592d7..09e029df6 100644 --- a/docs/resources/integration_microsoft_teams.md +++ b/docs/resources/integration_microsoft_teams.md @@ -4,14 +4,14 @@ page_title: "gitlab_integration_microsoft_teams Resource - terraform-provider-gi subcategory: "" description: |- The gitlab_integration_microsoft_teams resource allows to manage the lifecycle of a project integration with Microsoft Teams. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/integrations.html#microsoft-teams + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/integrations/#microsoft-teams --- # gitlab_integration_microsoft_teams (Resource) The `gitlab_integration_microsoft_teams` resource allows to manage the lifecycle of a project integration with Microsoft Teams. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/integrations.html#microsoft-teams) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/integrations/#microsoft-teams) ## Example Usage diff --git a/docs/resources/integration_pipelines_email.md b/docs/resources/integration_pipelines_email.md index a50959d84..6012b37ec 100644 --- a/docs/resources/integration_pipelines_email.md +++ b/docs/resources/integration_pipelines_email.md @@ -4,14 +4,14 @@ page_title: "gitlab_integration_pipelines_email Resource - terraform-provider-gi subcategory: "" description: |- The gitlab_integration_pipelines_email resource allows to manage the lifecycle of a project integration with Pipeline Emails Service. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/integrations.html#pipeline-emails + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/integrations/#pipeline-emails --- # gitlab_integration_pipelines_email (Resource) The `gitlab_integration_pipelines_email` resource allows to manage the lifecycle of a project integration with Pipeline Emails Service. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/integrations.html#pipeline-emails) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/integrations/#pipeline-emails) ## Example Usage diff --git a/docs/resources/integration_slack.md b/docs/resources/integration_slack.md index fa117940f..e99c0ae09 100644 --- a/docs/resources/integration_slack.md +++ b/docs/resources/integration_slack.md @@ -4,14 +4,14 @@ page_title: "gitlab_integration_slack Resource - terraform-provider-gitlab" subcategory: "" description: |- The gitlab_integration_slack resource allows to manage the lifecycle of a project integration with Slack. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/integrations.html#slack-notifications + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/integrations/#slack-notifications --- # gitlab_integration_slack (Resource) The `gitlab_integration_slack` resource allows to manage the lifecycle of a project integration with Slack. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/integrations.html#slack-notifications) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/integrations/#slack-notifications) ## Example Usage diff --git a/docs/resources/integration_telegram.md b/docs/resources/integration_telegram.md index 7ee5b42dd..2c33484b0 100644 --- a/docs/resources/integration_telegram.md +++ b/docs/resources/integration_telegram.md @@ -4,14 +4,14 @@ page_title: "gitlab_integration_telegram Resource - terraform-provider-gitlab" subcategory: "" description: |- The gitlab_integration_telegram resource allows to manage the lifecycle of a project integration with Telegram. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/integrations.html#telegram + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/integrations/#telegram --- # gitlab_integration_telegram (Resource) The `gitlab_integration_telegram` resource allows to manage the lifecycle of a project integration with Telegram. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/integrations.html#telegram) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/integrations/#telegram) ## Example Usage @@ -60,7 +60,7 @@ resource "gitlab_integration_telegram" "default" { ### Optional -- `branches_to_be_notified` (String) Branches to send notifications for (introduced in GitLab 16.5). Update of this attribute was not supported before Gitlab 16.11 due to API bug. Valid options are `all`, `default`, `protected`, `default_and_protected`. +- `branches_to_be_notified` (String) Branches to send notifications for. Valid options are `all`, `default`, `protected`, `default_and_protected`. - `notify_only_broken_pipelines` (Boolean) Send notifications for broken pipelines. ### Read-Only diff --git a/docs/resources/label.md b/docs/resources/label.md index 370433151..e07528196 100644 --- a/docs/resources/label.md +++ b/docs/resources/label.md @@ -5,7 +5,7 @@ subcategory: "" description: |- The gitlab_label resource allows to manage the lifecycle of a project label. ~> This resource is deprecated. use gitlab_project_labelinstead! - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/labels.html#project-labels + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/labels/#project-labels --- # gitlab_label (Resource) @@ -14,7 +14,7 @@ The `gitlab_label` resource allows to manage the lifecycle of a project label. ~> This resource is deprecated. use `gitlab_project_label`instead! -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/labels.html#project-labels) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/labels/#project-labels) diff --git a/docs/resources/member_role.md b/docs/resources/member_role.md index 7e4b48a5e..df4a536cf 100644 --- a/docs/resources/member_role.md +++ b/docs/resources/member_role.md @@ -6,9 +6,9 @@ description: |- The gitlab_member_role resource allows to manage the lifecycle of a custom member role. Custom roles allow an organization to create user roles with the precise privileges and permissions required for that organization’s needs. -> This resource requires an Ultimate license. - -> Most custom roles are considered billable users that use a seat. Custom roles billing and seat usage https://docs.gitlab.com/ee/user/custom_roles.html#billing-and-seat-usage + -> Most custom roles are considered billable users that use a seat. Custom roles billing and seat usage https://docs.gitlab.com/user/custom_roles/#billing-and-seat-usage -> There can be only 10 custom roles on your instance or namespace. See issue 450929 https://gitlab.com/gitlab-org/gitlab/-/issues/450929 for more details. - Upstream API: GitLab GraphQL API docs https://docs.gitlab.com/ee/api/graphql/reference/#mutationmemberrolecreate + Upstream API: GitLab GraphQL API docs https://docs.gitlab.com/api/graphql/reference/#mutationmemberrolecreate --- # gitlab_member_role (Resource) @@ -19,11 +19,11 @@ Custom roles allow an organization to create user roles with the precise privile -> This resource requires an Ultimate license. --> Most custom roles are considered billable users that use a seat. [Custom roles billing and seat usage](https://docs.gitlab.com/ee/user/custom_roles.html#billing-and-seat-usage) +-> Most custom roles are considered billable users that use a seat. [Custom roles billing and seat usage](https://docs.gitlab.com/user/custom_roles/#billing-and-seat-usage) -> There can be only 10 custom roles on your instance or namespace. See [issue 450929](https://gitlab.com/gitlab-org/gitlab/-/issues/450929) for more details. -**Upstream API**: [GitLab GraphQL API docs](https://docs.gitlab.com/ee/api/graphql/reference/#mutationmemberrolecreate) +**Upstream API**: [GitLab GraphQL API docs](https://docs.gitlab.com/api/graphql/reference/#mutationmemberrolecreate) ## Example Usage @@ -59,7 +59,7 @@ resource "gitlab_member_role" "example" { ### Required - `base_access_level` (String) The base access level for the custom role. Valid values are: `DEVELOPER`, `GUEST`, `MAINTAINER`, `MINIMAL_ACCESS`, `OWNER`, `REPORTER` -- `enabled_permissions` (Set of String) All permissions enabled for the custom role. Valid values are: `ADMIN_CICD_VARIABLES`, `ADMIN_COMPLIANCE_FRAMEWORK`, `ADMIN_GROUP_MEMBER`, `ADMIN_INTEGRATIONS`, `ADMIN_MERGE_REQUEST`, `ADMIN_PUSH_RULES`, `ADMIN_RUNNERS`, `ADMIN_TERRAFORM_STATE`, `ADMIN_VULNERABILITY`, `ADMIN_WEB_HOOK`, `ARCHIVE_PROJECT`, `MANAGE_DEPLOY_TOKENS`, `MANAGE_GROUP_ACCESS_TOKENS`, `MANAGE_MERGE_REQUEST_SETTINGS`, `MANAGE_PROJECT_ACCESS_TOKENS`, `MANAGE_SECURITY_POLICY_LINK`, `READ_CODE`, `READ_CRM_CONTACT`, `READ_DEPENDENCY`, `READ_RUNNERS`, `READ_VULNERABILITY`, `REMOVE_GROUP`, `REMOVE_PROJECT` +- `enabled_permissions` (Set of String) All permissions enabled for the custom role. Valid values are: `ADMIN_CICD_VARIABLES`, `ADMIN_COMPLIANCE_FRAMEWORK`, `ADMIN_GROUP_MEMBER`, `ADMIN_INTEGRATIONS`, `ADMIN_MERGE_REQUEST`, `ADMIN_PROTECTED_BRANCH`, `ADMIN_PUSH_RULES`, `ADMIN_RUNNERS`, `ADMIN_TERRAFORM_STATE`, `ADMIN_VULNERABILITY`, `ADMIN_WEB_HOOK`, `ARCHIVE_PROJECT`, `MANAGE_DEPLOY_TOKENS`, `MANAGE_GROUP_ACCESS_TOKENS`, `MANAGE_MERGE_REQUEST_SETTINGS`, `MANAGE_PROJECT_ACCESS_TOKENS`, `MANAGE_SECURITY_POLICY_LINK`, `READ_ADMIN_CICD`, `READ_ADMIN_DASHBOARD`, `READ_CODE`, `READ_COMPLIANCE_DASHBOARD`, `READ_CRM_CONTACT`, `READ_DEPENDENCY`, `READ_RUNNERS`, `READ_VULNERABILITY`, `REMOVE_GROUP`, `REMOVE_PROJECT` - `name` (String) Name for the member role. ### Optional diff --git a/docs/resources/pages_domain.md b/docs/resources/pages_domain.md index 878d05c0a..c0fd9ee7c 100644 --- a/docs/resources/pages_domain.md +++ b/docs/resources/pages_domain.md @@ -4,14 +4,14 @@ page_title: "gitlab_pages_domain Resource - terraform-provider-gitlab" subcategory: "" description: |- The gitlab_pages_domain resource allows connecting custom domains and TLS certificates in GitLab Pages. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/pages_domains.html + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/pages_domains/ --- # gitlab_pages_domain (Resource) The `gitlab_pages_domain` resource allows connecting custom domains and TLS certificates in GitLab Pages. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/pages_domains.html) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/pages_domains/) ## Example Usage @@ -40,11 +40,11 @@ resource "gitlab_pages_domain" "this" { ### Required - `domain` (String) The custom domain indicated by the user. -- `project` (String) The ID or [URL-encoded path of the project](https://docs.gitlab.com/ee/api/index.html#namespaced-path-encoding) owned by the authenticated user. +- `project` (String) The ID or [URL-encoded path of the project](https://docs.gitlab.com/api/index/#namespaced-path-encoding) owned by the authenticated user. ### Optional -- `auto_ssl_enabled` (Boolean) Enables [automatic generation](https://docs.gitlab.com/ee/user/project/pages/custom_domains_ssl_tls_certification/lets_encrypt_integration.html) of SSL certificates issued by Let’s Encrypt for custom domains. When this is set to "true", certificate can't be provided. +- `auto_ssl_enabled` (Boolean) Enables [automatic generation](https://docs.gitlab.com/user/project/pages/custom_domains_ssl_tls_certification/lets_encrypt_integration/) of SSL certificates issued by Let’s Encrypt for custom domains. When this is set to "true", certificate can't be provided. - `certificate` (String) The certificate in PEM format with intermediates following in most specific to least specific order. - `expired` (Boolean) Whether the certificate is expired. - `key` (String) The certificate key in PEM format. diff --git a/docs/resources/personal_access_token.md b/docs/resources/personal_access_token.md index 3e2e2729a..89488832f 100644 --- a/docs/resources/personal_access_token.md +++ b/docs/resources/personal_access_token.md @@ -6,10 +6,10 @@ description: |- The gitlab_personal_access_token resource allows to manage the lifecycle of a personal access token. -> This resource requires administration privileges. ~> Use of the timestamp() function with expires_at will cause the resource to be re-created with every apply, it's recommended to use plantimestamp() or a static value instead. - ~> Observability scopes are in beta and may not work on all instances. See more details in the documentation https://docs.gitlab.com/ee/operations/tracing.html + ~> Observability scopes are in beta and may not work on all instances. See more details in the documentation https://docs.gitlab.com/operations/tracing/ ~> Use rotation_configuration to automatically rotate tokens instead of using timestamp() as timestamp will cause changes with every plan. terraform apply must still be run to rotate the token. - ~> Due to Automatic reuse detection https://docs.gitlab.com/ee/api/personal_access_tokens.html#automatic-reuse-detection it's possible that a new Personal Access Token will immediately be revoked. Check if an old process using the old token is running if this happens. - Upstream API: GitLab API docs https://docs.gitlab.com/ee/api/personal_access_tokens.html + ~> Due to Automatic reuse detection https://docs.gitlab.com/api/personal_access_tokens/#automatic-reuse-detection it's possible that a new Personal Access Token will immediately be revoked. Check if an old process using the old token is running if this happens. + Upstream API: GitLab API docs https://docs.gitlab.com/api/personal_access_tokens/ --- # gitlab_personal_access_token (Resource) @@ -20,13 +20,13 @@ The `gitlab_personal_access_token` resource allows to manage the lifecycle of a ~> Use of the `timestamp()` function with expires_at will cause the resource to be re-created with every apply, it's recommended to use `plantimestamp()` or a static value instead. -~> Observability scopes are in beta and may not work on all instances. See more details in [the documentation](https://docs.gitlab.com/ee/operations/tracing.html) +~> Observability scopes are in beta and may not work on all instances. See more details in [the documentation](https://docs.gitlab.com/operations/tracing/) ~> Use `rotation_configuration` to automatically rotate tokens instead of using `timestamp()` as timestamp will cause changes with every plan. `terraform apply` must still be run to rotate the token. -~> Due to [Automatic reuse detection](https://docs.gitlab.com/ee/api/personal_access_tokens.html#automatic-reuse-detection) it's possible that a new Personal Access Token will immediately be revoked. Check if an old process using the old token is running if this happens. +~> Due to [Automatic reuse detection](https://docs.gitlab.com/api/personal_access_tokens/#automatic-reuse-detection) it's possible that a new Personal Access Token will immediately be revoked. Check if an old process using the old token is running if this happens. -**Upstream API**: [GitLab API docs](https://docs.gitlab.com/ee/api/personal_access_tokens.html) +**Upstream API**: [GitLab API docs](https://docs.gitlab.com/api/personal_access_tokens/) ## Example Usage diff --git a/docs/resources/pipeline_schedule.md b/docs/resources/pipeline_schedule.md index 36658d8c4..47588b8c9 100644 --- a/docs/resources/pipeline_schedule.md +++ b/docs/resources/pipeline_schedule.md @@ -4,14 +4,14 @@ page_title: "gitlab_pipeline_schedule Resource - terraform-provider-gitlab" subcategory: "" description: |- The gitlab_pipeline_schedule resource allows to manage the lifecycle of a scheduled pipeline. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/pipeline_schedules.html + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/pipeline_schedules/ --- # gitlab_pipeline_schedule (Resource) The `gitlab_pipeline_schedule` resource allows to manage the lifecycle of a scheduled pipeline. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/pipeline_schedules.html) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/pipeline_schedules/) ## Example Usage diff --git a/docs/resources/pipeline_schedule_variable.md b/docs/resources/pipeline_schedule_variable.md index b8eab6993..c9fe6513a 100644 --- a/docs/resources/pipeline_schedule_variable.md +++ b/docs/resources/pipeline_schedule_variable.md @@ -4,14 +4,14 @@ page_title: "gitlab_pipeline_schedule_variable Resource - terraform-provider-git subcategory: "" description: |- The gitlab_pipeline_schedule_variable resource allows to manage the lifecycle of a variable for a pipeline schedule. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/pipeline_schedules.html#pipeline-schedule-variables + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/pipeline_schedules/#pipeline-schedule-variables --- # gitlab_pipeline_schedule_variable (Resource) The `gitlab_pipeline_schedule_variable` resource allows to manage the lifecycle of a variable for a pipeline schedule. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/pipeline_schedules.html#pipeline-schedule-variables) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/pipeline_schedules/#pipeline-schedule-variables) ## Example Usage diff --git a/docs/resources/pipeline_trigger.md b/docs/resources/pipeline_trigger.md index 9018c1182..6eec9602c 100644 --- a/docs/resources/pipeline_trigger.md +++ b/docs/resources/pipeline_trigger.md @@ -4,14 +4,14 @@ page_title: "gitlab_pipeline_trigger Resource - terraform-provider-gitlab" subcategory: "" description: |- The gitlab_pipeline_trigger resource allows to manage the lifecycle of a pipeline trigger. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/pipeline_triggers.html + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/pipeline_triggers/ --- # gitlab_pipeline_trigger (Resource) The `gitlab_pipeline_trigger` resource allows to manage the lifecycle of a pipeline trigger. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/pipeline_triggers.html) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/pipeline_triggers/) ## Example Usage diff --git a/docs/resources/project.md b/docs/resources/project.md index 0d274b03f..49722b43f 100644 --- a/docs/resources/project.md +++ b/docs/resources/project.md @@ -11,7 +11,7 @@ description: |- In the gitlab_project resource, define a local-exec provisioner which invokes the /projects/:id/protected_branches/:name API via curl to delete the branch protection on the default branch using a DELETE request. Then define the desired branch protection using the gitlab_branch_protection resource. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ce/api/projects.html + Upstream API: GitLab REST API docs https://docs.gitlab.com/ce/api/projects/ --- # gitlab_project (Resource) @@ -27,7 +27,7 @@ In the `gitlab_project` resource, define a `local-exec` provisioner which invoke the `/projects/:id/protected_branches/:name` API via curl to delete the branch protection on the default branch using a `DELETE` request. Then define the desired branch protection using the `gitlab_branch_protection` resource. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ce/api/projects.html) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ce/api/projects/) ## Example Usage @@ -155,7 +155,7 @@ resource "gitlab_project" "import_private" { - `ci_default_git_depth` (Number) Default number of revisions for shallow cloning. - `ci_forward_deployment_enabled` (Boolean) When a new deployment job starts, skip older deployment jobs that are still pending. - `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` -- `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` +- `ci_restrict_pipeline_cancellation_role` (String) The role required to cancel a pipeline or job. Premium and Ultimate only. Valid values are `developer`, `maintainer`, `no one` - `ci_separated_caches` (Boolean) Use separate caches for protected branches. - `container_expiration_policy` (Block List, Max: 1) 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](#nestedblock--container_expiration_policy)) - `container_registry_access_level` (String) Set visibility of container registry, for this project. Valid values are `disabled`, `private`, `enabled`. @@ -180,7 +180,7 @@ resource "gitlab_project" "import_private" { - `issues_template` (String) Sets the template for new issues in the project. - `keep_latest_artifact` (Boolean) Disable or enable the ability to keep the latest artifact for this project. - `lfs_enabled` (Boolean) Enable LFS for the project. -- `merge_commit_template` (String) Template used to create merge commit message in merge requests. (Introduced in GitLab 14.5.) +- `merge_commit_template` (String) Template used to create merge commit message in merge requests. - `merge_method` (String) Set the merge method. Valid values are `merge`, `rebase_merge`, `ff`. - `merge_pipelines_enabled` (Boolean) Enable or disable merge pipelines. - `merge_requests_access_level` (String) Set the merge requests access level. Valid values are `disabled`, `private`, `enabled`. @@ -224,8 +224,8 @@ There is currently no known way to determine if the default branch protection is This attribute is only used during resource creation, thus changes are suppressed and the attribute cannot be imported. - `snippets_access_level` (String) Set the snippets access level. Valid values are `disabled`, `private`, `enabled`. - `snippets_enabled` (Boolean) Enable snippets for the project. -- `squash_commit_template` (String) Template used to create squash commit message in merge requests. (Introduced in GitLab 14.6.) -- `squash_option` (String) Squash commits when merge request. Valid values are `never`, `always`, `default_on`, or `default_off`. The default value is `default_off`. [GitLab >= 14.1] +- `squash_commit_template` (String) Template used to create squash commit message in merge requests. +- `squash_option` (String) Squash commits when merge request. Valid values are `never`, `always`, `default_on`, or `default_off`. The default value is `default_off`. - `suggestion_commit_message` (String) The commit message used to apply merge request suggestions. - `tags` (Set of String) The list of tags for a project; put array of tags, that should be finally assigned to a project. Use topics instead. - `template_name` (String) When used without use_custom_template, name of a built-in project template. When used with use_custom_template, name of a custom project template. This option is mutually exclusive with `template_project_id`. @@ -233,7 +233,7 @@ This attribute is only used during resource creation, thus changes are suppresse - `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts)) - `topics` (Set of String) The list of topics for the project. - `use_custom_template` (Boolean) Use either custom instance or group (with group_with_project_templates_id) project template (enterprise edition). - ~> When using a custom template, [Group Tokens won't work](https://docs.gitlab.com/15.7/ee/user/project/settings/import_export_troubleshooting.html#import-using-the-rest-api-fails-when-using-a-group-access-token). You must use a real user's Personal Access Token. + ~> When using a custom template, [Group Tokens won't work](https://docs.gitlab.com/15.7/ee/user/project/settings/import_export_troubleshooting/#import-using-the-rest-api-fails-when-using-a-group-access-token). You must use a real user's Personal Access Token. - `visibility_level` (String) Set to `public` to create a public project. Valid values are `private`, `internal`, `public`. - `wiki_access_level` (String) Set the wiki access level. Valid values are `disabled`, `private`, `enabled`. - `wiki_enabled` (Boolean) Enable wiki for the project. diff --git a/docs/resources/project_access_token.md b/docs/resources/project_access_token.md index 418c168b2..52bf59aa0 100644 --- a/docs/resources/project_access_token.md +++ b/docs/resources/project_access_token.md @@ -4,23 +4,23 @@ page_title: "gitlab_project_access_token Resource - terraform-provider-gitlab" subcategory: "" description: |- The gitlab_project_access_token resource allows to manage the lifecycle of a project access token. - ~> Observability scopes are in beta and may not work on all instances. See more details in the documentation https://docs.gitlab.com/ee/operations/tracing.html + ~> Observability scopes are in beta and may not work on all instances. See more details in the documentation https://docs.gitlab.com/operations/tracing/ ~> Use rotation_configuration to automatically rotate tokens instead of using timestamp() as timestamp will cause changes with every plan. terraform apply must still be run to rotate the token. - ~> Due to Automatic reuse detection https://docs.gitlab.com/ee/api/project_access_tokens.html#automatic-reuse-detection it's possible that a new Project Access Token will immediately be revoked. Check if an old process using the old token is running if this happens. - Upstream API: GitLab API docs https://docs.gitlab.com/ee/api/project_access_tokens.html + ~> Due to Automatic reuse detection https://docs.gitlab.com/api/project_access_tokens/#automatic-reuse-detection it's possible that a new Project Access Token will immediately be revoked. Check if an old process using the old token is running if this happens. + Upstream API: GitLab API docs https://docs.gitlab.com/api/project_access_tokens/ --- # gitlab_project_access_token (Resource) The `gitlab_project_access_token` resource allows to manage the lifecycle of a project access token. -~> Observability scopes are in beta and may not work on all instances. See more details in [the documentation](https://docs.gitlab.com/ee/operations/tracing.html) +~> Observability scopes are in beta and may not work on all instances. See more details in [the documentation](https://docs.gitlab.com/operations/tracing/) ~> Use `rotation_configuration` to automatically rotate tokens instead of using `timestamp()` as timestamp will cause changes with every plan. `terraform apply` must still be run to rotate the token. -~> Due to [Automatic reuse detection](https://docs.gitlab.com/ee/api/project_access_tokens.html#automatic-reuse-detection) it's possible that a new Project Access Token will immediately be revoked. Check if an old process using the old token is running if this happens. +~> Due to [Automatic reuse detection](https://docs.gitlab.com/api/project_access_tokens/#automatic-reuse-detection) it's possible that a new Project Access Token will immediately be revoked. Check if an old process using the old token is running if this happens. -**Upstream API**: [GitLab API docs](https://docs.gitlab.com/ee/api/project_access_tokens.html) +**Upstream API**: [GitLab API docs](https://docs.gitlab.com/api/project_access_tokens/) ## Example Usage diff --git a/docs/resources/project_approval_rule.md b/docs/resources/project_approval_rule.md index c5e924fc2..a2a91324b 100644 --- a/docs/resources/project_approval_rule.md +++ b/docs/resources/project_approval_rule.md @@ -10,7 +10,7 @@ description: |- to prevent a common error with this resource. ~> Since a project is limited to one "any_approver" rule, attempting to add two "any_approver" rules to the same project in terraform will result in terraform identifying changes with every "plan" operation, and may result in an error during the "apply" operation. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/merge_request_approvals.html#project-level-mr-approvals + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/merge_request_approvals/#project-level-mr-approvals --- # gitlab_project_approval_rule (Resource) @@ -26,7 +26,7 @@ The `gitlab_project_approval_rule` resource allows to manage the lifecycle of a ~> Since a project is limited to one "any_approver" rule, attempting to add two "any_approver" rules to the same project in terraform will result in terraform identifying changes with every "plan" operation, and may result in an error during the "apply" operation. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/merge_request_approvals.html#project-level-mr-approvals) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/merge_request_approvals/#project-level-mr-approvals) ## Example Usage diff --git a/docs/resources/project_badge.md b/docs/resources/project_badge.md index 90df4b712..2222644d4 100644 --- a/docs/resources/project_badge.md +++ b/docs/resources/project_badge.md @@ -4,14 +4,14 @@ page_title: "gitlab_project_badge Resource - terraform-provider-gitlab" subcategory: "" description: |- The gitlab_project_badge resource allows to manage the lifecycle of project badges. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/user/project/badges.html#project-badges + Upstream API: GitLab REST API docs https://docs.gitlab.com/user/project/badges/#project-badges --- # gitlab_project_badge (Resource) The `gitlab_project_badge` resource allows to manage the lifecycle of project badges. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/user/project/badges.html#project-badges) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/user/project/badges/#project-badges) ## Example Usage diff --git a/docs/resources/project_cluster.md b/docs/resources/project_cluster.md index 736533d7f..5f49afa69 100644 --- a/docs/resources/project_cluster.md +++ b/docs/resources/project_cluster.md @@ -5,7 +5,7 @@ subcategory: "" description: |- The gitlab_project_cluster resource allows to manage the lifecycle of a project cluster. ~> This is deprecated GitLab feature since 14.5 - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/project_clusters.html + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/project_clusters/ --- # gitlab_project_cluster (Resource) @@ -14,7 +14,7 @@ The `gitlab_project_cluster` resource allows to manage the lifecycle of a projec ~> This is deprecated GitLab feature since 14.5 -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/project_clusters.html) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/project_clusters/) ## Example Usage diff --git a/docs/resources/project_compliance_framework.md b/docs/resources/project_compliance_framework.md index e7a19cc0d..8f503aa73 100644 --- a/docs/resources/project_compliance_framework.md +++ b/docs/resources/project_compliance_framework.md @@ -5,7 +5,7 @@ subcategory: "" description: |- The gitlab_project_compliance_framework resource allows to manage the lifecycle of a compliance framework on a project. -> This resource requires a GitLab Enterprise instance with a Premium license to set the compliance framework on a project. - Upstream API: GitLab GraphQL API docs https://docs.gitlab.com/ee/api/graphql/reference/#mutationprojectsetcomplianceframework + Upstream API: GitLab GraphQL API docs https://docs.gitlab.com/api/graphql/reference/#mutationprojectsetcomplianceframework --- # gitlab_project_compliance_framework (Resource) @@ -14,7 +14,7 @@ The `gitlab_project_compliance_framework` resource allows to manage the lifecycl -> This resource requires a GitLab Enterprise instance with a Premium license to set the compliance framework on a project. -**Upstream API**: [GitLab GraphQL API docs](https://docs.gitlab.com/ee/api/graphql/reference/#mutationprojectsetcomplianceframework) +**Upstream API**: [GitLab GraphQL API docs](https://docs.gitlab.com/api/graphql/reference/#mutationprojectsetcomplianceframework) ## Example Usage diff --git a/docs/resources/project_compliance_frameworks.md b/docs/resources/project_compliance_frameworks.md index 84f709fa4..c2a1973a3 100644 --- a/docs/resources/project_compliance_frameworks.md +++ b/docs/resources/project_compliance_frameworks.md @@ -5,7 +5,7 @@ subcategory: "" description: |- The gitlab_project_compliance_frameworks resource allows to manage the lifecycle of compliance frameworks on a project. -> This resource requires a GitLab Enterprise instance with a Premium license to set the compliance frameworks on a project. - Upstream API: GitLab GraphQL API docs https://docs.gitlab.com/ee/api/graphql/reference/#mutationprojectupdatecomplianceframeworks + Upstream API: GitLab GraphQL API docs https://docs.gitlab.com/api/graphql/reference/#mutationprojectupdatecomplianceframeworks --- # gitlab_project_compliance_frameworks (Resource) @@ -14,7 +14,7 @@ The `gitlab_project_compliance_frameworks` resource allows to manage the lifecyc -> This resource requires a GitLab Enterprise instance with a Premium license to set the compliance frameworks on a project. -**Upstream API**: [GitLab GraphQL API docs](https://docs.gitlab.com/ee/api/graphql/reference/#mutationprojectupdatecomplianceframeworks) +**Upstream API**: [GitLab GraphQL API docs](https://docs.gitlab.com/api/graphql/reference/#mutationprojectupdatecomplianceframeworks) ## Example Usage diff --git a/docs/resources/project_custom_attribute.md b/docs/resources/project_custom_attribute.md index d5c781a99..0bb2015d0 100644 --- a/docs/resources/project_custom_attribute.md +++ b/docs/resources/project_custom_attribute.md @@ -4,14 +4,14 @@ page_title: "gitlab_project_custom_attribute Resource - terraform-provider-gitla subcategory: "" description: |- The gitlab_project_custom_attribute resource allows to manage custom attributes for a project. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/custom_attributes.html + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/custom_attributes/ --- # gitlab_project_custom_attribute (Resource) The `gitlab_project_custom_attribute` resource allows to manage custom attributes for a project. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/custom_attributes.html) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/custom_attributes/) ## Example Usage diff --git a/docs/resources/project_environment.md b/docs/resources/project_environment.md index e586205f6..260014cae 100644 --- a/docs/resources/project_environment.md +++ b/docs/resources/project_environment.md @@ -7,7 +7,7 @@ description: |- -> During a terraform destroy this resource by default will not attempt to stop the environment first. An environment is required to be in a stopped state before a deletetion of the environment can occur. Set the stop_before_destroy flag to attempt to automatically stop the environment before deletion. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/environments.html + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/environments/ --- # gitlab_project_environment (Resource) @@ -18,7 +18,7 @@ The `gitlab_project_environment` resource allows to manage the lifecycle of an e An environment is required to be in a stopped state before a deletetion of the environment can occur. Set the `stop_before_destroy` flag to attempt to automatically stop the environment before deletion. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/environments.html) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/environments/) ## Example Usage diff --git a/docs/resources/project_freeze_period.md b/docs/resources/project_freeze_period.md index ba9e09de7..68196c080 100644 --- a/docs/resources/project_freeze_period.md +++ b/docs/resources/project_freeze_period.md @@ -4,14 +4,14 @@ page_title: "gitlab_project_freeze_period Resource - terraform-provider-gitlab" subcategory: "" description: |- The gitlab_project_freeze_period resource allows to manage the lifecycle of a freeze period for a project. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/freeze_periods.html + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/freeze_periods/ --- # gitlab_project_freeze_period (Resource) The `gitlab_project_freeze_period` resource allows to manage the lifecycle of a freeze period for a project. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/freeze_periods.html) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/freeze_periods/) ## Example Usage diff --git a/docs/resources/project_hook.md b/docs/resources/project_hook.md index f908c251c..4539d19dc 100644 --- a/docs/resources/project_hook.md +++ b/docs/resources/project_hook.md @@ -4,14 +4,14 @@ page_title: "gitlab_project_hook Resource - terraform-provider-gitlab" subcategory: "" description: |- The gitlab_project_hook resource allows to manage the lifecycle of a project hook. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/projects.html#hooks + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/projects/#hooks --- # gitlab_project_hook (Resource) The `gitlab_project_hook` resource allows to manage the lifecycle of a project hook. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/projects.html#hooks) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/projects/#hooks) ## Example Usage @@ -70,6 +70,7 @@ resource "gitlab_project_hook" "custom_headers" { - `push_events` (Boolean) Invoke the hook for push events. - `push_events_branch_filter` (String) Invoke the hook for push events on matching branches only. - `releases_events` (Boolean) Invoke the hook for release events. +- `resource_access_token_events` (Boolean) Invoke the hook for project access token expiry events. - `tag_push_events` (Boolean) Invoke the hook for tag push events. - `token` (String, Sensitive) A token to present when invoking the hook. The token is not available for imported resources. - `wiki_page_events` (Boolean) Invoke the hook for wiki page events. diff --git a/docs/resources/project_issue.md b/docs/resources/project_issue.md index 2f997c6aa..67961fe8a 100644 --- a/docs/resources/project_issue.md +++ b/docs/resources/project_issue.md @@ -6,7 +6,7 @@ description: |- The gitlab_project_issue resource allows to manage the lifecycle of an issue within a project. -> During a terraform destroy this resource will close the issue. Set the delete_on_destroy flag to true to delete the issue instead of closing it. ~> Experimental While the base functionality of this resource works, it may be subject to minor change. - Upstream API: GitLab API docs https://docs.gitlab.com/ee/api/issues.html + Upstream API: GitLab API docs https://docs.gitlab.com/api/issues/ --- # gitlab_project_issue (Resource) @@ -17,7 +17,7 @@ The `gitlab_project_issue` resource allows to manage the lifecycle of an issue w ~> **Experimental** While the base functionality of this resource works, it may be subject to minor change. -**Upstream API**: [GitLab API docs](https://docs.gitlab.com/ee/api/issues.html) +**Upstream API**: [GitLab API docs](https://docs.gitlab.com/api/issues/) ## Example Usage diff --git a/docs/resources/project_issue_board.md b/docs/resources/project_issue_board.md index 47342978c..492498523 100644 --- a/docs/resources/project_issue_board.md +++ b/docs/resources/project_issue_board.md @@ -5,7 +5,7 @@ subcategory: "" description: |- The gitlab_project_issue_board resource allows to manage the lifecycle of a Project Issue Board. ~> NOTE: If the board lists are changed all lists will be recreated. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/boards.html + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/boards/ --- # gitlab_project_issue_board (Resource) @@ -14,7 +14,7 @@ The `gitlab_project_issue_board` resource allows to manage the lifecycle of a Pr ~> **NOTE:** If the board lists are changed all lists will be recreated. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/boards.html) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/boards/) ## Example Usage diff --git a/docs/resources/project_job_token_scope.md b/docs/resources/project_job_token_scope.md index e5d3f100c..7f67abb67 100644 --- a/docs/resources/project_job_token_scope.md +++ b/docs/resources/project_job_token_scope.md @@ -6,7 +6,7 @@ description: |- The gitlab_project_job_token_scope resource allows to manage the CI/CD Job Token scope in a project. Any projects added to the CI/CD Job Token scope outside of TF will be untouched by the resource. ~> Conflicts with the use of gitlab_project_job_token_scopes when used on the same project. Use one or the other to ensure the desired state. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/project_job_token_scopes.html + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/project_job_token_scopes/ --- # gitlab_project_job_token_scope (Resource) @@ -16,7 +16,7 @@ Any projects added to the CI/CD Job Token scope outside of TF will be untouched ~> Conflicts with the use of `gitlab_project_job_token_scopes` when used on the same project. Use one or the other to ensure the desired state. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/project_job_token_scopes.html) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/project_job_token_scopes/) ## Example Usage @@ -29,6 +29,7 @@ resource "gitlab_project_job_token_scope" "allowed_single_project" { # Allow multiple projects locals { allowed_project_ids = [123, 456, 789] + allowed_group_ids = [123, 456, 789] } data "gitlab_project" "deployment_project" { @@ -41,6 +42,13 @@ resource "gitlab_project_job_token_scope" "allowed_project" { project = data.gitlab_project.deployment_project.id target_project_id = each.key } + +resource "gitlab_project_job_token_scope" "allowed_group" { + for_each = toset(local.allowed_group_ids) + + project = data.gitlab_project.deployment_project.id + target_group_id = each.key +} ``` @@ -49,6 +57,10 @@ resource "gitlab_project_job_token_scope" "allowed_project" { ### Required - `project` (String) The ID or full path of the project. + +### Optional + +- `target_group_id` (Number) The ID of the group that is in the CI/CD job token inbound allowlist. - `target_project_id` (Number) The ID of the project that is in the CI/CD job token inbound allowlist. ### Read-Only diff --git a/docs/resources/project_job_token_scopes.md b/docs/resources/project_job_token_scopes.md index 4e37944f2..50bdd8afd 100644 --- a/docs/resources/project_job_token_scopes.md +++ b/docs/resources/project_job_token_scopes.md @@ -6,7 +6,7 @@ description: |- The gitlab_project_job_token_scopes resource allows to manage the CI/CD Job Token scopes in a project. Any project not within the defined set in this attribute will be removed, which allows this resource to be used as an explicit deny. ~> Conflicts with the use of gitlab_project_job_token_scope when used on the same project. Use one or the other to ensure the desired state. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/project_job_token_scopes.html + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/project_job_token_scopes/ --- # gitlab_project_job_token_scopes (Resource) @@ -16,7 +16,7 @@ Any project not within the defined set in this attribute will be removed, which ~> Conflicts with the use of `gitlab_project_job_token_scope` when used on the same project. Use one or the other to ensure the desired state. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/project_job_token_scopes.html) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/project_job_token_scopes/) ## Example Usage diff --git a/docs/resources/project_label.md b/docs/resources/project_label.md index 2e1a5fe17..f90358022 100644 --- a/docs/resources/project_label.md +++ b/docs/resources/project_label.md @@ -4,14 +4,14 @@ page_title: "gitlab_project_label Resource - terraform-provider-gitlab" subcategory: "" description: |- The gitlab_project_label resource allows to manage the lifecycle of a project label. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/labels.html#project-labels + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/labels/#project-labels --- # gitlab_project_label (Resource) The `gitlab_project_label` resource allows to manage the lifecycle of a project label. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/labels.html#project-labels) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/labels/#project-labels) ## Example Usage diff --git a/docs/resources/project_level_mr_approvals.md b/docs/resources/project_level_mr_approvals.md index 1c9367d02..2ce724a1e 100644 --- a/docs/resources/project_level_mr_approvals.md +++ b/docs/resources/project_level_mr_approvals.md @@ -5,7 +5,7 @@ subcategory: "" description: |- The gitlab_project_level_mr_approval_rule resource allows to manage the lifecycle of a Merge Request-level approval rule. -> This resource requires a GitLab Enterprise instance. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/merge_request_approvals.html#merge-request-level-mr-approvals + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/merge_request_approvals/#merge-request-level-mr-approvals --- # gitlab_project_level_mr_approvals (Resource) @@ -14,7 +14,7 @@ The `gitlab_project_level_mr_approval_rule` resource allows to manage the lifecy -> This resource requires a GitLab Enterprise instance. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/merge_request_approvals.html#merge-request-level-mr-approvals) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/merge_request_approvals/#merge-request-level-mr-approvals) ## Example Usage diff --git a/docs/resources/project_level_notifications.md b/docs/resources/project_level_notifications.md index 0a92dec49..9fc987632 100644 --- a/docs/resources/project_level_notifications.md +++ b/docs/resources/project_level_notifications.md @@ -5,7 +5,7 @@ subcategory: "" description: |- The gitlab_project_level_notifications resource allows to manage notifications for a project. ~> While the API supports both groups and projects, this resource only supports projects currently. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/notification_settings.html#group--project-level-notification-settings + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/notification_settings/#group--project-level-notification-settings --- # gitlab_project_level_notifications (Resource) @@ -14,7 +14,7 @@ The `gitlab_project_level_notifications` resource allows to manage notifications ~> While the API supports both groups and projects, this resource only supports projects currently. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/notification_settings.html#group--project-level-notification-settings) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/notification_settings/#group--project-level-notification-settings) diff --git a/docs/resources/project_membership.md b/docs/resources/project_membership.md index f329617a5..0fc485242 100644 --- a/docs/resources/project_membership.md +++ b/docs/resources/project_membership.md @@ -5,7 +5,7 @@ subcategory: "" description: |- The gitlab_project_membership resource allows to manage the lifecycle of a users project membership. -> If a project should grant membership to an entire group use the gitlab_project_share_group resource instead. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/members.html + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/members/ --- # gitlab_project_membership (Resource) @@ -14,7 +14,7 @@ The `gitlab_project_membership` resource allows to manage the lifecycle of a use -> If a project should grant membership to an entire group use the `gitlab_project_share_group` resource instead. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/members.html) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/members/) ## Example Usage @@ -45,6 +45,7 @@ resource "gitlab_project_membership" "example" { ### Optional - `expires_at` (String) Expiration date for the project membership. Format: `YYYY-MM-DD` +- `member_role_id` (Number) The ID of a custom member role. Only available for Ultimate instances. ### Read-Only diff --git a/docs/resources/project_milestone.md b/docs/resources/project_milestone.md index cc037f80f..75b5e02c7 100644 --- a/docs/resources/project_milestone.md +++ b/docs/resources/project_milestone.md @@ -4,14 +4,14 @@ page_title: "gitlab_project_milestone Resource - terraform-provider-gitlab" subcategory: "" description: |- The gitlab_project_milestone resource allows to manage the lifecycle of a project milestone. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/milestones.html + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/milestones/ --- # gitlab_project_milestone (Resource) The `gitlab_project_milestone` resource allows to manage the lifecycle of a project milestone. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/milestones.html) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/milestones/) ## Example Usage diff --git a/docs/resources/project_mirror.md b/docs/resources/project_mirror.md index c8670ac9c..fbe3e1023 100644 --- a/docs/resources/project_mirror.md +++ b/docs/resources/project_mirror.md @@ -9,10 +9,7 @@ description: |- -> Warning By default, the provider sets the keep_divergent_refs argument to True. If you manually set keep_divergent_refs to False, GitLab mirroring removes branches in the target that aren't in the source. This action can result in unexpected branch deletions. - -> Destroy Behavior GitLab 14.10 introduced an API endpoint to delete a project mirror. - Therefore, for GitLab 14.10 and newer the project mirror will be destroyed when the resource is destroyed. - For older versions, the mirror will be disabled and the resource will be destroyed. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/remote_mirrors.html + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/remote_mirrors/ --- # gitlab_project_mirror (Resource) @@ -26,11 +23,7 @@ import_url, mirror, and mirror_trigger_builds properties on the gitlab_project r If you manually set `keep_divergent_refs` to `False`, GitLab mirroring removes branches in the target that aren't in the source. This action can result in unexpected branch deletions. --> **Destroy Behavior** GitLab 14.10 introduced an API endpoint to delete a project mirror. - Therefore, for GitLab 14.10 and newer the project mirror will be destroyed when the resource is destroyed. - For older versions, the mirror will be disabled and the resource will be destroyed. - -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/remote_mirrors.html) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/remote_mirrors/) ## Example Usage @@ -57,7 +50,7 @@ resource "gitlab_project_mirror" "foo" { ### Read-Only -- `id` (String) The ID of this resource. +- `id` (String) The id of the project mirror. In the format of `project:mirror_id` - `mirror_id` (Number) Mirror ID. ## Import diff --git a/docs/resources/project_protected_environment.md b/docs/resources/project_protected_environment.md index 0f8498e91..ec9f1b3eb 100644 --- a/docs/resources/project_protected_environment.md +++ b/docs/resources/project_protected_environment.md @@ -9,7 +9,7 @@ description: |- You may use the gitlab_project_membership and gitlab_project_shared_group resources to achieve this. Unfortunately, the GitLab API does not complain about users and groups without access to the project and just ignores those. In case this happens you will get perpetual state diffs. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/protected_environments.html + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/protected_environments/ --- # gitlab_project_protected_environment (Resource) @@ -22,7 +22,7 @@ The `gitlab_project_protected_environment` resource allows to manage the lifecyc Unfortunately, the GitLab API does not complain about users and groups without access to the project and just ignores those. In case this happens you will get perpetual state diffs. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/protected_environments.html) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/protected_environments/) ## Example Usage diff --git a/docs/resources/project_push_rules.md b/docs/resources/project_push_rules.md index 5fd235a69..95bebf759 100644 --- a/docs/resources/project_push_rules.md +++ b/docs/resources/project_push_rules.md @@ -9,7 +9,7 @@ description: |- It is recommended to define push rules using this resource OR in the gitlab_project resource, but not in both as it may result in terraform identifying changes with every "plan" operation. -> This resource requires a GitLab Enterprise instance with a Premium license to set the push rules on a project. - Upstream API: GitLab API docs https://docs.gitlab.com/ee/api/projects.html#push-rules + Upstream API: GitLab API docs https://docs.gitlab.com/api/projects/#push-rules --- # gitlab_project_push_rules (Resource) @@ -23,7 +23,7 @@ The `gitlab_project_push_rules` resource allows to manage the lifecycle of push -> This resource requires a GitLab Enterprise instance with a Premium license to set the push rules on a project. -**Upstream API**: [GitLab API docs](https://docs.gitlab.com/ee/api/projects.html#push-rules) +**Upstream API**: [GitLab API docs](https://docs.gitlab.com/api/projects/#push-rules) ## Example Usage diff --git a/docs/resources/project_runner_enablement.md b/docs/resources/project_runner_enablement.md index 42474b6c8..cf076c9a6 100644 --- a/docs/resources/project_runner_enablement.md +++ b/docs/resources/project_runner_enablement.md @@ -4,14 +4,14 @@ page_title: "gitlab_project_runner_enablement Resource - terraform-provider-gitl subcategory: "" description: |- The gitlab_project_runner_enablement resource allows to enable a runner in a project. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/runners.html#enable-a-runner-in-project + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/runners/#enable-a-runner-in-project --- # gitlab_project_runner_enablement (Resource) The `gitlab_project_runner_enablement` resource allows to enable a runner in a project. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/runners.html#enable-a-runner-in-project) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/runners/#enable-a-runner-in-project) ## Example Usage diff --git a/docs/resources/project_security_policy_attachment.md b/docs/resources/project_security_policy_attachment.md index 08b89d0e6..b8720785a 100644 --- a/docs/resources/project_security_policy_attachment.md +++ b/docs/resources/project_security_policy_attachment.md @@ -4,17 +4,17 @@ page_title: "gitlab_project_security_policy_attachment Resource - terraform-prov subcategory: "" description: |- The gitlab_project_security_policy_attachment resource allows to attach a security policy project to a project. - ~> Policies https://docs.gitlab.com/ee/user/application_security/policies/ are files stored in a policy project as raw YAML, to allow maximum flexibility with support of all kind of policy and all their options. See the examples for how to create a policy project, add a policy, and link it. Use the gitlab_repository_file resource to create policies instead of a specific policy resource. This ensures all policy options are immediately via Terraform once released. - Upstream API: GitLab GraphQL API docs https://docs.gitlab.com/ee/api/graphql/reference/index.html#mutationsecuritypolicyprojectassign + ~> Policies https://docs.gitlab.com/user/application_security/policies/ are files stored in a policy project as raw YAML, to allow maximum flexibility with support of all kind of policy and all their options. See the examples for how to create a policy project, add a policy, and link it. Use the gitlab_repository_file resource to create policies instead of a specific policy resource. This ensures all policy options are immediately via Terraform once released. + Upstream API: GitLab GraphQL API docs https://docs.gitlab.com/api/graphql/reference/index/#mutationsecuritypolicyprojectassign --- # gitlab_project_security_policy_attachment (Resource) The `gitlab_project_security_policy_attachment` resource allows to attach a security policy project to a project. -~> [Policies](https://docs.gitlab.com/ee/user/application_security/policies/) are files stored in a policy project as raw YAML, to allow maximum flexibility with support of all kind of policy and all their options. See the examples for how to create a policy project, add a policy, and link it. Use the `gitlab_repository_file` resource to create policies instead of a specific policy resource. This ensures all policy options are immediately via Terraform once released. +~> [Policies](https://docs.gitlab.com/user/application_security/policies/) are files stored in a policy project as raw YAML, to allow maximum flexibility with support of all kind of policy and all their options. See the examples for how to create a policy project, add a policy, and link it. Use the `gitlab_repository_file` resource to create policies instead of a specific policy resource. This ensures all policy options are immediately via Terraform once released. -**Upstream API**: [GitLab GraphQL API docs](https://docs.gitlab.com/ee/api/graphql/reference/index.html#mutationsecuritypolicyprojectassign) +**Upstream API**: [GitLab GraphQL API docs](https://docs.gitlab.com/api/graphql/reference/index/#mutationsecuritypolicyprojectassign) ## Example Usage diff --git a/docs/resources/project_share_group.md b/docs/resources/project_share_group.md index c6c82fae9..b161690aa 100644 --- a/docs/resources/project_share_group.md +++ b/docs/resources/project_share_group.md @@ -4,14 +4,14 @@ page_title: "gitlab_project_share_group Resource - terraform-provider-gitlab" subcategory: "" description: |- The gitlab_project_share_group resource allows to manage the lifecycle of project shared with a group. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/projects.html#share-project-with-group + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/projects/#share-project-with-group --- # gitlab_project_share_group (Resource) The `gitlab_project_share_group` resource allows to manage the lifecycle of project shared with a group. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/projects.html#share-project-with-group) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/projects/#share-project-with-group) ## Example Usage diff --git a/docs/resources/project_tag.md b/docs/resources/project_tag.md index 2aac2f696..0473d72ae 100644 --- a/docs/resources/project_tag.md +++ b/docs/resources/project_tag.md @@ -4,14 +4,14 @@ page_title: "gitlab_project_tag Resource - terraform-provider-gitlab" subcategory: "" description: |- The gitlab_project_tag resource allows to manage the lifecycle of a tag in a project. - Upstream API: GitLab API docs https://docs.gitlab.com/ee/api/tags.html + Upstream API: GitLab API docs https://docs.gitlab.com/api/tags/ --- # gitlab_project_tag (Resource) The `gitlab_project_tag` resource allows to manage the lifecycle of a tag in a project. -**Upstream API**: [GitLab API docs](https://docs.gitlab.com/ee/api/tags.html) +**Upstream API**: [GitLab API docs](https://docs.gitlab.com/api/tags/) ## Example Usage diff --git a/docs/resources/project_variable.md b/docs/resources/project_variable.md index 3216f2a1c..9740d423e 100644 --- a/docs/resources/project_variable.md +++ b/docs/resources/project_variable.md @@ -3,18 +3,15 @@ page_title: "gitlab_project_variable Resource - terraform-provider-gitlab" subcategory: "" description: |- - The gitlab_project_variable resource allows to manage the lifecycle of a CI/CD variable for a project. - ~> Important: If your GitLab version is older than 13.4, you may see nondeterministic behavior when updating or deleting gitlab_project_variable resources with non-unique keys, for example if there is another variable with the same key and different environment scope. See this GitLab issue https://gitlab.com/gitlab-org/gitlab/-/issues/9912. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/project_level_variables.html + The gitlab_project_variable resource allows creating and managing a GitLab project level variable. + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/project_level_variables/ --- # gitlab_project_variable (Resource) -The `gitlab_project_variable` resource allows to manage the lifecycle of a CI/CD variable for a project. +The `gitlab_project_variable` resource allows creating and managing a GitLab project level variable. -~> **Important:** If your GitLab version is older than 13.4, you may see nondeterministic behavior when updating or deleting gitlab_project_variable resources with non-unique keys, for example if there is another variable with the same key and different environment scope. See [this GitLab issue](https://gitlab.com/gitlab-org/gitlab/-/issues/9912). - -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/project_level_variables.html) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/project_level_variables/) ## Example Usage @@ -40,14 +37,14 @@ resource "gitlab_project_variable" "example" { - `description` (String) The description of the variable. - `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`. +- `masked` (Boolean) If set to `true`, the value of the variable will be masked in job logs. The value must meet the [masking requirements](https://docs.gitlab.com/ee/ci/variables/#mask-a-cicd-variable). +- `protected` (Boolean) If set to `true`, the variable will be passed only to pipelines running on protected branches and tags. +- `raw` (Boolean) Whether the variable is treated as a raw string. When true, variables in the value are not expanded. +- `variable_type` (String) The type of a variable. Valid values are: `env_var`, `file`. ### Read-Only -- `id` (String) The ID of this resource. +- `id` (String) The ID of this Terraform resource. In the format of `::`. ## Import diff --git a/docs/resources/project_wiki_page.md b/docs/resources/project_wiki_page.md new file mode 100644 index 000000000..6dd452376 --- /dev/null +++ b/docs/resources/project_wiki_page.md @@ -0,0 +1,64 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "gitlab_project_wiki_page Resource - terraform-provider-gitlab" +subcategory: "" +description: |- + The gitlab_project_wiki_page resource allows managing the lifecycle of a project wiki page. + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/wikis/ +--- + +# gitlab_project_wiki_page (Resource) + +The `gitlab_project_wiki_page` resource allows managing the lifecycle of a project wiki page. + +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/wikis/) + +## Example Usage + +```terraform +resource "gitlab_project_wiki_page" "example" { + project = var.ProjectID # Specify your project path or ID + slug = "test-wiki-page" # Unique slug for the wiki page + title = "Test Wiki Page" + content = < +## Schema + +### Required + +- `content` (String) Content of the wiki page. Must be at least 1 character long. +- `project` (String) The ID or URL-encoded path of the project. +- `title` (String) Title of the wiki page. + +### Optional + +- `format` (String) Format of the wiki page (auto-generated if not provided). Valid values are: `markdown`, `rdoc`, `asciidoc`, `org`. + +### Read-Only + +- `encoding` (String) The encoding used for the wiki page content. +- `id` (String) The ID of this Terraform resource. +- `slug` (String) Slug of the wiki page. + +## Import + +Starting in Terraform v1.5.0 you can use an [import block](https://developer.hashicorp.com/terraform/language/import) to import `gitlab_project_wiki_page`. For example: +```terraform +import { + to = gitlab_project_wiki_page.example + id = "see CLI command below for ID" +} +``` + +Import using the CLI is supported using the following syntax: + +```shell +# You can import gitlab_project_wiki_page state using the project ID, e.g. +terraform import gitlab_project_wiki_page.test 12345:my-wiki-page +``` diff --git a/docs/resources/release.md b/docs/resources/release.md new file mode 100644 index 000000000..a3979229f --- /dev/null +++ b/docs/resources/release.md @@ -0,0 +1,133 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "gitlab_release Resource - terraform-provider-gitlab" +subcategory: "" +description: |- + The gitlab_release resource allows to manage the lifecycle of releases in gitlab. + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/releases/ +--- + +# gitlab_release (Resource) + +The `gitlab_release` resource allows to manage the lifecycle of releases in gitlab. + +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/releases/) + +## Example Usage + +```terraform +# Create a project +resource "gitlab_project" "example" { + name = "example" + description = "An example project" +} + +# Create a release +resource "gitlab_release" "example" { + project = gitlab_project.example.id + name = "test-release" + tag_name = "v1.0.0" + description = "Test release description" + ref = "main" +} +``` + + +## Schema + +### Required + +- `project` (String) The ID or full path of the project. +- `tag_name` (String) The tag where the release is created from. + +### Optional + +- `assets` (Attributes) The release assets. (see [below for nested schema](#nestedatt--assets)) +- `description` (String) The description of the release. You can use Markdown. +- `milestones` (Set of String) The title of each milestone the release is associated with. GitLab Premium customers can specify group milestones. +- `name` (String) The name of the release. +- `ref` (String) If a tag specified in tag_name doesn't exist, the release is created from ref and tagged with tag_name. It can be a commit SHA, another tag name, or a branch name. +- `released_at` (String) Date and time for the release. Defaults to the current time. Expected in ISO 8601 format (2019-03-15T08:00:00Z). Only provide this field if creating an upcoming or historical release. +- `tag_message` (String) Message to use if creating a new annotated tag. + +### Read-Only + +- `author` (Attributes) The author of the release. (see [below for nested schema](#nestedatt--author)) +- `commit` (Attributes) The release commit. (see [below for nested schema](#nestedatt--commit)) +- `commit_path` (String) The path to the commit +- `created_at` (String) Date and time the release was created. In ISO 8601 format (2019-03-15T08:00:00Z). +- `description_html` (String) HTML rendered Markdown of the release description. +- `id` (String) The ID of this Terraform resource. In the format of ``. +- `links` (Attributes) Links of the release (see [below for nested schema](#nestedatt--links)) +- `tag_path` (String) The path to the tag. +- `upcoming_release` (Boolean) Whether the release_at attribute is set to a future date. + + +### Nested Schema for `assets` + +Read-Only: + +- `count` (Number) The total count of assets in this release. + + + +### Nested Schema for `author` + +Read-Only: + +- `avatar_url` (String) The url of the author's' user avatar. +- `id` (Number) The ID of the author's user. +- `name` (String) The name of the author. +- `state` (String) The state of the author's user. +- `username` (String) The username of the author. +- `web_url` (String) The url to the author's user profile. + + + +### Nested Schema for `commit` + +Read-Only: + +- `author_email` (String) The email address of the commit author. +- `author_name` (String) The name of the commit author. +- `authored_date` (String) The date and time the commit was authored. In ISO 8601 format (2019-03-15T08:00:00Z). +- `committed_date` (String) The date and time the commit was made. In ISO 8601 format (2019-03-15T08:00:00Z). +- `committer_email` (String) The email address of the committer. +- `committer_name` (String) The name of the committer. +- `created_at` (String) The date and time the commit was created. In ISO 8601 format (2019-03-15T08:00:00Z). +- `id` (String) The git commit full SHA +- `message` (String) The commit message. +- `parent_ids` (Set of String) The full SHA of any parent commits. +- `short_id` (String) The git commit short SHA. +- `title` (String) The title of the commit. + + + +### Nested Schema for `links` + +Read-Only: + +- `closed_issues_url` (String) URL of the release's closed issues. +- `closed_merge_requests_url` (String) URL of the release's closed merge requests. +- `edit_url` (String) URL of the release's edit page. +- `merged_merge_requests_url` (String) URL of the release's merged merge requests. +- `opened_issues_url` (String) URL of the release's open issues. +- `opened_merge_requests_url` (String) URL of the release's open merge requests. +- `self` (String) URL of the release. + +## Import + +Starting in Terraform v1.5.0 you can use an [import block](https://developer.hashicorp.com/terraform/language/import) to import `gitlab_release`. For example: +```terraform +import { + to = gitlab_release.example + id = "see CLI command below for ID" +} +``` + +Import using the CLI is supported using the following syntax: + +```shell +# Gitlab release link can be imported with a key composed of `:`, e.g. +terraform import gitlab_release.example "12345:test" +``` diff --git a/docs/resources/release_link.md b/docs/resources/release_link.md index c22360f4f..b876fafed 100644 --- a/docs/resources/release_link.md +++ b/docs/resources/release_link.md @@ -4,14 +4,14 @@ page_title: "gitlab_release_link Resource - terraform-provider-gitlab" subcategory: "" description: |- The gitlab_release_link resource allows to manage the lifecycle of a release link. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/releases/links.html + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/releases/links/ --- # gitlab_release_link (Resource) The `gitlab_release_link` resource allows to manage the lifecycle of a release link. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/releases/links.html) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/releases/links/) ## Example Usage @@ -37,18 +37,18 @@ resource "gitlab_release_link" "example" { ### Required - `name` (String) The name of the link. Link names must be unique within the release. -- `project` (String) The ID or [URL-encoded path of the project](https://docs.gitlab.com/ee/api/index.html#namespaced-path-encoding). +- `project` (String) The ID or [URL-encoded path of the project](https://docs.gitlab.com/api/index/#namespaced-path-encoding). - `tag_name` (String) The tag associated with the Release. - `url` (String) The URL of the link. Link URLs must be unique within the release. ### Optional -- `filepath` (String) Relative path for a [Direct Asset link](https://docs.gitlab.com/ee/user/project/releases/index.html#permanent-links-to-release-assets). +- `filepath` (String) Relative path for a [Direct Asset link](https://docs.gitlab.com/user/project/releases/index/#permanent-links-to-release-assets). - `link_type` (String) The type of the link. Valid values are `other`, `runbook`, `image`, `package`. Defaults to other. ### Read-Only -- `direct_asset_url` (String) Full path for a [Direct Asset link](https://docs.gitlab.com/ee/user/project/releases/index.html#permanent-links-to-release-assets). +- `direct_asset_url` (String) Full path for a [Direct Asset link](https://docs.gitlab.com/user/project/releases/index/#permanent-links-to-release-assets). - `external` (Boolean) External or internal link. - `id` (String) The ID of this resource. - `link_id` (Number) The ID of the link. diff --git a/docs/resources/repository_file.md b/docs/resources/repository_file.md index be80b1d88..fcf29862d 100644 --- a/docs/resources/repository_file.md +++ b/docs/resources/repository_file.md @@ -9,7 +9,7 @@ description: |- Therefore, this resource queues every call to the repository files API no matter of the project, which may slow down the terraform execution time for some configurations. In addition, retries are performed in case a refresh is required because another application changed the repository at the same time. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/repository_files.html + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/repository_files/ --- # gitlab_repository_file (Resource) @@ -23,7 +23,7 @@ The `gitlab_repository_file` resource allows to manage the lifecycle of a file w execution time for some configurations. In addition, retries are performed in case a refresh is required because another application changed the repository at the same time. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/repository_files.html) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/repository_files/) ## Example Usage @@ -90,7 +90,7 @@ resource "gitlab_repository_file" "readme_for_dogs" { - `create_commit_message` (String) Create commit message. - `delete_commit_message` (String) Delete Commit message. - `encoding` (String) The file content encoding. Default value is `base64`. Valid values are: `base64`, `text`. -- `execute_filemode` (Boolean) Enables or disables the execute flag on the file. **Note**: requires GitLab 14.10 or newer. +- `execute_filemode` (Boolean) Enables or disables the execute flag on the file. - `overwrite_on_create` (Boolean) Enable overwriting existing files, defaults to `false`. This attribute is only used during `create` and must be use carefully. We suggest to use `imports` whenever possible and limit the use of this attribute for when the project was imported on the same `apply`. This attribute is not supported during a resource import. - `start_branch` (String) Name of the branch to start the new commit from. - `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts)) diff --git a/docs/resources/runner.md b/docs/resources/runner.md index eb146e348..034e500f2 100644 --- a/docs/resources/runner.md +++ b/docs/resources/runner.md @@ -8,7 +8,7 @@ description: |- The runner will be registered at a group level if the token used is from a group, or at an instance level if the token used is for the instance. ~ > Using this resource will register a runner using the deprecated registration_token flow. To use the new authentication_token flow instead, use the gitlab_user_runner resource! - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/runners.html#register-a-new-runner + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/runners/#register-a-new-runner --- # gitlab_runner (Resource) @@ -21,7 +21,7 @@ The runner will be registered at a group level if the token used is from a group ~ > Using this resource will register a runner using the deprecated `registration_token` flow. To use the new `authentication_token` flow instead, use the `gitlab_user_runner` resource! -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/runners.html#register-a-new-runner) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/runners/#register-a-new-runner) ## Example Usage @@ -67,7 +67,7 @@ resource "gitlab_runner" "my_runner" { # This creates a configuration for a local "shell" runner, but can be changed to generate whatever is needed. # Place this configuration file on a server at `/etc/gitlab-runner/config.toml`, then run `gitlab-runner start`. -# See https://docs.gitlab.com/runner/configuration/advanced-configuration.html for more information. +# See https://docs.gitlab.com/runner/configuration/advanced-configuration/ for more information. resource "local_file" "config" { filename = "${path.module}/config.toml" content = < This resource is deprecated. use gitlab_integration_custom_issue_trackerinstead! - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/integrations.html#custom-issue-tracker + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/integrations/#custom-issue-tracker --- # gitlab_service_custom_issue_tracker (Resource) @@ -14,7 +14,7 @@ The `gitlab_service_custom_issue_tracker` resource allows to manage the lifecycl ~> This resource is deprecated. use `gitlab_integration_custom_issue_tracker`instead! -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/integrations.html#custom-issue-tracker) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/integrations/#custom-issue-tracker) ## Example Usage diff --git a/docs/resources/service_emails_on_push.md b/docs/resources/service_emails_on_push.md index 7e1c19665..b891284f1 100644 --- a/docs/resources/service_emails_on_push.md +++ b/docs/resources/service_emails_on_push.md @@ -5,7 +5,7 @@ subcategory: "" description: |- The gitlab_service_emails_on_push resource allows to manage the lifecycle of a project integration with Emails on Push Service. ~> This resource is deprecated. Please use gitlab_integration_emails_on_push instead! - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/integrations.html#emails-on-push + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/integrations/#emails-on-push --- # gitlab_service_emails_on_push (Resource) @@ -14,7 +14,7 @@ The `gitlab_service_emails_on_push` resource allows to manage the lifecycle of a ~> This resource is deprecated. Please use `gitlab_integration_emails_on_push` instead! -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/integrations.html#emails-on-push) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/integrations/#emails-on-push) ## Example Usage diff --git a/docs/resources/service_external_wiki.md b/docs/resources/service_external_wiki.md index a443983cc..f4898143d 100644 --- a/docs/resources/service_external_wiki.md +++ b/docs/resources/service_external_wiki.md @@ -5,7 +5,7 @@ subcategory: "" description: |- The gitlab_service_external_wiki resource allows to manage the lifecycle of a project integration with External Wiki Service. ~> This resource is deprecated. use gitlab_integration_external_wikiinstead! - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/integrations.html#external-wiki + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/integrations/#external-wiki --- # gitlab_service_external_wiki (Resource) @@ -14,7 +14,7 @@ The `gitlab_service_external_wiki` resource allows to manage the lifecycle of a ~> This resource is deprecated. use `gitlab_integration_external_wiki`instead! -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/integrations.html#external-wiki) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/integrations/#external-wiki) ## Example Usage diff --git a/docs/resources/service_github.md b/docs/resources/service_github.md index a47dd28c6..5da8322bc 100644 --- a/docs/resources/service_github.md +++ b/docs/resources/service_github.md @@ -6,7 +6,7 @@ description: |- The gitlab_service_github resource allows to manage the lifecycle of a project integration with GitHub. -> This resource requires a GitLab Enterprise instance. ~> This resource is deprecated. use gitlab_integration_githubinstead! - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/integrations.html#github + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/integrations/#github --- # gitlab_service_github (Resource) @@ -17,7 +17,7 @@ The `gitlab_service_github` resource allows to manage the lifecycle of a project ~> This resource is deprecated. use `gitlab_integration_github`instead! -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/integrations.html#github) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/integrations/#github) ## Example Usage diff --git a/docs/resources/service_jira.md b/docs/resources/service_jira.md index dae3fb03f..5d416b5c9 100644 --- a/docs/resources/service_jira.md +++ b/docs/resources/service_jira.md @@ -5,7 +5,7 @@ subcategory: "" description: |- The gitlab_service_jira resource allows to manage the lifecycle of a project integration with Jira. ~> This resource is deprecated. use gitlab_integration_jirainstead! - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/integrations.html#jira + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/integrations/#jira --- # gitlab_service_jira (Resource) @@ -14,7 +14,7 @@ The `gitlab_service_jira` resource allows to manage the lifecycle of a project i ~> This resource is deprecated. use `gitlab_integration_jira`instead! -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/integrations.html#jira) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/integrations/#jira) ## Example Usage @@ -52,7 +52,7 @@ resource "gitlab_service_jira" "jira" { - `jira_issue_prefix` (String) Prefix to match Jira issue keys. - `jira_issue_regex` (String) Regular expression to match Jira issue keys. - `jira_issue_transition_automatic` (Boolean) Enable automatic issue transitions. Takes precedence over jira_issue_transition_id if enabled. Defaults to false. This value cannot be imported, and will not perform drift detection if changed outside Terraform. -- `jira_issue_transition_id` (String) The ID of a transition that moves issues to a closed state. You can find this number under the JIRA workflow administration (Administration > Issues > Workflows) by selecting View under Operations of the desired workflow of your project. By default, this ID is set to 2. *Note**: importing this field is only supported since GitLab 15.2. +- `jira_issue_transition_id` (String) The ID of a transition that moves issues to a closed state. You can find this number under the JIRA workflow administration (Administration > Issues > Workflows) by selecting View under Operations of the desired workflow of your project. By default, this ID is set to 2. - `merge_requests_events` (Boolean) Enable notifications for merge request events - `project_key` (String) The short identifier for your JIRA project, all uppercase, e.g., PROJ. - `project_keys` (List of String) Keys of Jira projects. When issues_enabled is true, this setting specifies which Jira projects to view issues from in GitLab. diff --git a/docs/resources/service_microsoft_teams.md b/docs/resources/service_microsoft_teams.md index 81fe06802..6b9a4147c 100644 --- a/docs/resources/service_microsoft_teams.md +++ b/docs/resources/service_microsoft_teams.md @@ -5,7 +5,7 @@ subcategory: "" description: |- The gitlab_service_microsoft_teams resource allows to manage the lifecycle of a project integration with Microsoft Teams. ~> This resource is deprecated. use gitlab_integration_microsoft_teamsinstead! - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/integrations.html#microsoft-teams + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/integrations/#microsoft-teams --- # gitlab_service_microsoft_teams (Resource) @@ -14,7 +14,7 @@ The `gitlab_service_microsoft_teams` resource allows to manage the lifecycle of ~> This resource is deprecated. use `gitlab_integration_microsoft_teams`instead! -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/integrations.html#microsoft-teams) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/integrations/#microsoft-teams) ## Example Usage diff --git a/docs/resources/service_pipelines_email.md b/docs/resources/service_pipelines_email.md index a4841c3ec..ea8b617ed 100644 --- a/docs/resources/service_pipelines_email.md +++ b/docs/resources/service_pipelines_email.md @@ -5,7 +5,7 @@ subcategory: "" description: |- The gitlab_service_pipelines_email resource allows to manage the lifecycle of a project integration with Pipeline Emails Service. ~> This resource is deprecated. use gitlab_integration_pipelines_emailinstead! - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/integrations.html#pipeline-emails + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/integrations/#pipeline-emails --- # gitlab_service_pipelines_email (Resource) @@ -14,7 +14,7 @@ The `gitlab_service_pipelines_email` resource allows to manage the lifecycle of ~> This resource is deprecated. use `gitlab_integration_pipelines_email`instead! -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/integrations.html#pipeline-emails) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/integrations/#pipeline-emails) ## Example Usage diff --git a/docs/resources/service_slack.md b/docs/resources/service_slack.md index 74c8aeba9..ef366fb90 100644 --- a/docs/resources/service_slack.md +++ b/docs/resources/service_slack.md @@ -5,7 +5,7 @@ subcategory: "" description: |- The gitlab_service_slack resource allows to manage the lifecycle of a project integration with Slack. ~> This resource is deprecated. use gitlab_integration_slackinstead! - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/integrations.html#slack-notifications + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/integrations/#slack-notifications --- # gitlab_service_slack (Resource) @@ -14,7 +14,7 @@ The `gitlab_service_slack` resource allows to manage the lifecycle of a project ~> This resource is deprecated. use `gitlab_integration_slack`instead! -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/integrations.html#slack-notifications) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/integrations/#slack-notifications) ## Example Usage diff --git a/docs/resources/system_hook.md b/docs/resources/system_hook.md index c4e3d7940..58685f915 100644 --- a/docs/resources/system_hook.md +++ b/docs/resources/system_hook.md @@ -4,17 +4,14 @@ page_title: "gitlab_system_hook Resource - terraform-provider-gitlab" subcategory: "" description: |- The gitlab_system_hook resource allows to manage the lifecycle of a system hook. - -> This resource requires GitLab 14.9 - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/system_hooks.html + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/system_hooks/ --- # gitlab_system_hook (Resource) The `gitlab_system_hook` resource allows to manage the lifecycle of a system hook. --> This resource requires GitLab 14.9 - -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/system_hooks.html) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/system_hooks/) ## Example Usage diff --git a/docs/resources/tag_protection.md b/docs/resources/tag_protection.md index ae31ef8dc..c496e8f6d 100644 --- a/docs/resources/tag_protection.md +++ b/docs/resources/tag_protection.md @@ -6,7 +6,7 @@ description: |- The gitlab_tag_protection resource allows to manage the lifecycle of a tag protection. ~> As tag protections cannot be updated, they are deleted and recreated when a change is requested. This means that if the deletion succeeds but the creation fails, tags will be left unprotected. If this is a potential issue for you, please use the create_before_destroy meta-argument: https://developer.hashicorp.com/terraform/language/meta-arguments/lifecycle - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/protected_tags.html + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/protected_tags/ --- # gitlab_tag_protection (Resource) @@ -16,7 +16,7 @@ The `gitlab_tag_protection` resource allows to manage the lifecycle of a tag pro ~> As tag protections cannot be updated, they are deleted and recreated when a change is requested. This means that if the deletion succeeds but the creation fails, tags will be left unprotected. If this is a potential issue for you, please use the `create_before_destroy` meta-argument: https://developer.hashicorp.com/terraform/language/meta-arguments/lifecycle -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/protected_tags.html) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/protected_tags/) ## Example Usage diff --git a/docs/resources/topic.md b/docs/resources/topic.md index aeb8457c8..3fc9cd8d1 100644 --- a/docs/resources/topic.md +++ b/docs/resources/topic.md @@ -6,7 +6,7 @@ description: |- The gitlab_topic resource allows to manage the lifecycle of topics that are then assignable to projects. -> Topics are the successors for project tags. Aside from avoiding terminology collisions with Git tags, they are more descriptive and better searchable. ~> Deleting a topic was implemented in GitLab 14.9. For older versions of GitLab set soft_destroy = true to empty out a topic instead of deleting it. - Upstream API: GitLab REST API docs for topics https://docs.gitlab.com/ee/api/topics.html + Upstream API: GitLab REST API docs for topics https://docs.gitlab.com/api/topics/ --- # gitlab_topic (Resource) @@ -17,7 +17,7 @@ The `gitlab_topic` resource allows to manage the lifecycle of topics that are th ~> Deleting a topic was implemented in GitLab 14.9. For older versions of GitLab set `soft_destroy = true` to empty out a topic instead of deleting it. -**Upstream API**: [GitLab REST API docs for topics](https://docs.gitlab.com/ee/api/topics.html) +**Upstream API**: [GitLab REST API docs for topics](https://docs.gitlab.com/api/topics/) ## Example Usage diff --git a/docs/resources/user.md b/docs/resources/user.md index f253dfbb1..5f22e3376 100644 --- a/docs/resources/user.md +++ b/docs/resources/user.md @@ -6,7 +6,7 @@ description: |- The gitlab_user resource allows to manage the lifecycle of a user. -> the provider needs to be configured with admin-level access for this resource to work. -> You must specify either password or reset_password. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/users.html + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/users/ --- # gitlab_user (Resource) @@ -17,7 +17,7 @@ The `gitlab_user` resource allows to manage the lifecycle of a user. -> You must specify either password or reset_password. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/users.html) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/users/) ## Example Usage @@ -51,7 +51,7 @@ resource "gitlab_user" "example" { - `external_provider` (String) String, the external provider. - `is_admin` (Boolean) Boolean, defaults to false. Whether to enable administrative privileges - `is_external` (Boolean) Boolean, defaults to false. Whether a user has access only to some internal or private projects. External users can only access projects to which they are explicitly granted access. -- `namespace_id` (Number) The ID of the user's namespace. Available since GitLab 14.10. +- `namespace_id` (Number) The ID of the user's namespace. - `note` (String) The note associated to the user. - `password` (String, Sensitive) The password of the user. - `projects_limit` (Number) Integer, defaults to 0. Number of projects user can create. diff --git a/docs/resources/user_custom_attribute.md b/docs/resources/user_custom_attribute.md index 1e0c89f89..b604c6a1f 100644 --- a/docs/resources/user_custom_attribute.md +++ b/docs/resources/user_custom_attribute.md @@ -4,14 +4,14 @@ page_title: "gitlab_user_custom_attribute Resource - terraform-provider-gitlab" subcategory: "" description: |- The gitlab_user_custom_attribute resource allows to manage custom attributes for a user. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/custom_attributes.html + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/custom_attributes/ --- # gitlab_user_custom_attribute (Resource) The `gitlab_user_custom_attribute` resource allows to manage custom attributes for a user. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/custom_attributes.html) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/custom_attributes/) ## Example Usage diff --git a/docs/resources/user_gpgkey.md b/docs/resources/user_gpgkey.md index 4f20be83c..326cc5f24 100644 --- a/docs/resources/user_gpgkey.md +++ b/docs/resources/user_gpgkey.md @@ -5,7 +5,7 @@ subcategory: "" description: |- The gitlab_user_gpgkey resource allows to manage the lifecycle of a GPG key assigned to the current user or a specific user. -> Managing GPG keys for arbitrary users requires admin privileges. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/users.html#get-a-specific-gpg-key + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/users/#get-a-specific-gpg-key --- # gitlab_user_gpgkey (Resource) @@ -14,7 +14,7 @@ The `gitlab_user_gpgkey` resource allows to manage the lifecycle of a GPG key as -> Managing GPG keys for arbitrary users requires admin privileges. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/users.html#get-a-specific-gpg-key) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/users/#get-a-specific-gpg-key) ## Example Usage diff --git a/docs/resources/user_impersonation_token.md b/docs/resources/user_impersonation_token.md index b332b4a36..780851bd5 100644 --- a/docs/resources/user_impersonation_token.md +++ b/docs/resources/user_impersonation_token.md @@ -5,7 +5,7 @@ subcategory: "" description: |- The gitlab_user_impersonation_token resource allows to manage impersonation tokens of users. Requires administrator access. Token values are returned once. You are only able to create impersonation tokens to impersonate the user and perform both API calls and Git reads and writes. The user can’t see these tokens in their profile settings page. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/users.html#create-an-impersonation-token + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/users/#create-an-impersonation-token --- # gitlab_user_impersonation_token (Resource) @@ -13,7 +13,7 @@ description: |- The `gitlab_user_impersonation_token` resource allows to manage impersonation tokens of users. Requires administrator access. Token values are returned once. You are only able to create impersonation tokens to impersonate the user and perform both API calls and Git reads and writes. The user can’t see these tokens in their profile settings page. -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/users.html#create-an-impersonation-token) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/users/#create-an-impersonation-token) ## Example Usage diff --git a/docs/resources/user_runner.md b/docs/resources/user_runner.md index 820f2b8df..0866684cc 100644 --- a/docs/resources/user_runner.md +++ b/docs/resources/user_runner.md @@ -3,15 +3,15 @@ page_title: "gitlab_user_runner Resource - terraform-provider-gitlab" subcategory: "" description: |- - The gitlab_user_runner resource allows creating a GitLab runner using the new GitLab Runner Registration Flow https://docs.gitlab.com/ee/ci/runners/new_creation_workflow.html. - Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/users.html#create-a-runner + The gitlab_user_runner resource allows creating a GitLab runner using the new GitLab Runner Registration Flow https://docs.gitlab.com/ci/runners/new_creation_workflow/. + Upstream API: GitLab REST API docs https://docs.gitlab.com/api/users/#create-a-runner --- # gitlab_user_runner (Resource) -The `gitlab_user_runner` resource allows creating a GitLab runner using the new [GitLab Runner Registration Flow](https://docs.gitlab.com/ee/ci/runners/new_creation_workflow.html). +The `gitlab_user_runner` resource allows creating a GitLab runner using the new [GitLab Runner Registration Flow](https://docs.gitlab.com/ci/runners/new_creation_workflow/). -**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/users.html#create-a-runner) +**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/api/users/#create-a-runner) ## Example Usage @@ -43,7 +43,7 @@ resource "gitlab_user_runner" "instance_runner" { # Create a configuration string you can write to a file file that can be used to start a gitlab-runner on a remote machine # This could be used in startup scripts in major cloud providers to automatically create a runner -# See GitLab Runner Advanced Configuration Options here: https://docs.gitlab.com/runner/configuration/advanced-configuration.html +# See GitLab Runner Advanced Configuration Options here: https://docs.gitlab.com/runner/configuration/advanced-configuration/ locals { config_toml = <<-EOT concurrent = 1 diff --git a/docs/resources/user_sshkey.md b/docs/resources/user_sshkey.md index 530a373b5..7d500c088 100644 --- a/docs/resources/user_sshkey.md +++ b/docs/resources/user_sshkey.md @@ -4,14 +4,14 @@ page_title: "gitlab_user_sshkey Resource - terraform-provider-gitlab" subcategory: "" description: |- The gitlab_user_sshkey resource allows to manage the lifecycle of an SSH key assigned to a user. - Upstream API: GitLab API docs https://docs.gitlab.com/ee/api/users.html#single-ssh-key + Upstream API: GitLab API docs https://docs.gitlab.com/api/users/#single-ssh-key --- # gitlab_user_sshkey (Resource) The `gitlab_user_sshkey` resource allows to manage the lifecycle of an SSH key assigned to a user. -**Upstream API**: [GitLab API docs](https://docs.gitlab.com/ee/api/users.html#single-ssh-key) +**Upstream API**: [GitLab API docs](https://docs.gitlab.com/api/users/#single-ssh-key) ## Example Usage diff --git a/docs/resources/value_stream_analytics.md b/docs/resources/value_stream_analytics.md index 8544e6a7c..85e8d6c93 100644 --- a/docs/resources/value_stream_analytics.md +++ b/docs/resources/value_stream_analytics.md @@ -5,7 +5,7 @@ subcategory: "" description: |- The gitlab_value_stream_analytics resource allows to manage the lifecycle of value stream analytics. -> This resource requires a GitLab Enterprise instance with a Premium license to create custom value stream analytics. - Upstream API: GitLab GraphQL API docs https://docs.gitlab.com/ee/api/graphql/reference/#mutationvaluestreamcreate + Upstream API: GitLab GraphQL API docs https://docs.gitlab.com/api/graphql/reference/#mutationvaluestreamcreate --- # gitlab_value_stream_analytics (Resource) @@ -14,7 +14,7 @@ The `gitlab_value_stream_analytics` resource allows to manage the lifecycle of v -> This resource requires a GitLab Enterprise instance with a Premium license to create custom value stream analytics. -**Upstream API**: [GitLab GraphQL API docs](https://docs.gitlab.com/ee/api/graphql/reference/#mutationvaluestreamcreate) +**Upstream API**: [GitLab GraphQL API docs](https://docs.gitlab.com/api/graphql/reference/#mutationvaluestreamcreate) ## Example Usage @@ -89,10 +89,10 @@ Required: Optional: - `custom` (Boolean) Boolean whether the stage is customized. If false, it assigns a built-in default stage by name. -- `end_event_identifier` (String) End event identifier. Valid values are: `CODE_STAGE_START`, `ISSUE_CLOSED`, `ISSUE_CREATED`, `ISSUE_DEPLOYED_TO_PRODUCTION`, `ISSUE_FIRST_ADDED_TO_BOARD`, `ISSUE_FIRST_ADDED_TO_ITERATION`, `ISSUE_FIRST_ASSIGNED_AT`, `ISSUE_FIRST_ASSOCIATED_WITH_MILESTONE`, `ISSUE_FIRST_MENTIONED_IN_COMMIT`, `ISSUE_LABEL_ADDED`, `ISSUE_LABEL_REMOVED`, `ISSUE_LAST_EDITED`, `ISSUE_STAGE_END`, `MERGE_REQUEST_CLOSED`, `MERGE_REQUEST_CREATED`, `MERGE_REQUEST_FIRST_ASSIGNED_AT`, `MERGE_REQUEST_FIRST_COMMIT_AT`, `MERGE_REQUEST_FIRST_DEPLOYTED_TO_PRODUCTION`, `MERGE_REQUEST_LABEL_ADDED`, `MERGE_REQUEST_LABEL_REMOVED`, `MERGE_REQUEST_LAST_BUILD_FINISHED`, `MERGE_REQUEST_LAST_BUILD_STARTED`, `MERGE_REQUEST_LAST_EDITED`, `MERGE_REQUEST_MERGED`, `MERGE_REQUEST_REVIEWER_FIRST_ASSIGNED`, `MERGE_REQUEST_PLAN_STAGE_START` +- `end_event_identifier` (String) End event identifier. Valid values are: `CODE_STAGE_START`, `ISSUE_CLOSED`, `ISSUE_CREATED`, `ISSUE_DEPLOYED_TO_PRODUCTION`, `ISSUE_FIRST_ADDED_TO_BOARD`, `ISSUE_FIRST_ADDED_TO_ITERATION`, `ISSUE_FIRST_ASSIGNED_AT`, `ISSUE_FIRST_ASSOCIATED_WITH_MILESTONE`, `ISSUE_FIRST_MENTIONED_IN_COMMIT`, `ISSUE_LABEL_ADDED`, `ISSUE_LABEL_REMOVED`, `ISSUE_LAST_EDITED`, `ISSUE_STAGE_END`, `MERGE_REQUEST_CLOSED`, `MERGE_REQUEST_CREATED`, `MERGE_REQUEST_FIRST_ASSIGNED_AT`, `MERGE_REQUEST_FIRST_COMMIT_AT`, `MERGE_REQUEST_FIRST_DEPLOYED_TO_PRODUCTION`, `MERGE_REQUEST_LABEL_ADDED`, `MERGE_REQUEST_LABEL_REMOVED`, `MERGE_REQUEST_LAST_BUILD_FINISHED`, `MERGE_REQUEST_LAST_BUILD_STARTED`, `MERGE_REQUEST_LAST_EDITED`, `MERGE_REQUEST_MERGED`, `MERGE_REQUEST_REVIEWER_FIRST_ASSIGNED`, `MERGE_REQUEST_PLAN_STAGE_START` - `end_event_label_id` (String) Label ID associated with the end event identifier. In the format of `gid://gitlab/GroupLabel/` or `gid://gitlab/ProjectLabel/` - `hidden` (Boolean) Boolean whether the stage is hidden, GitLab provided default stages are hidden by default. -- `start_event_identifier` (String) Start event identifier. Valid values are: `CODE_STAGE_START`, `ISSUE_CLOSED`, `ISSUE_CREATED`, `ISSUE_DEPLOYED_TO_PRODUCTION`, `ISSUE_FIRST_ADDED_TO_BOARD`, `ISSUE_FIRST_ADDED_TO_ITERATION`, `ISSUE_FIRST_ASSIGNED_AT`, `ISSUE_FIRST_ASSOCIATED_WITH_MILESTONE`, `ISSUE_FIRST_MENTIONED_IN_COMMIT`, `ISSUE_LABEL_ADDED`, `ISSUE_LABEL_REMOVED`, `ISSUE_LAST_EDITED`, `ISSUE_STAGE_END`, `MERGE_REQUEST_CLOSED`, `MERGE_REQUEST_CREATED`, `MERGE_REQUEST_FIRST_ASSIGNED_AT`, `MERGE_REQUEST_FIRST_COMMIT_AT`, `MERGE_REQUEST_FIRST_DEPLOYTED_TO_PRODUCTION`, `MERGE_REQUEST_LABEL_ADDED`, `MERGE_REQUEST_LABEL_REMOVED`, `MERGE_REQUEST_LAST_BUILD_FINISHED`, `MERGE_REQUEST_LAST_BUILD_STARTED`, `MERGE_REQUEST_LAST_EDITED`, `MERGE_REQUEST_MERGED`, `MERGE_REQUEST_REVIEWER_FIRST_ASSIGNED`, `MERGE_REQUEST_PLAN_STAGE_START` +- `start_event_identifier` (String) Start event identifier. Valid values are: `CODE_STAGE_START`, `ISSUE_CLOSED`, `ISSUE_CREATED`, `ISSUE_DEPLOYED_TO_PRODUCTION`, `ISSUE_FIRST_ADDED_TO_BOARD`, `ISSUE_FIRST_ADDED_TO_ITERATION`, `ISSUE_FIRST_ASSIGNED_AT`, `ISSUE_FIRST_ASSOCIATED_WITH_MILESTONE`, `ISSUE_FIRST_MENTIONED_IN_COMMIT`, `ISSUE_LABEL_ADDED`, `ISSUE_LABEL_REMOVED`, `ISSUE_LAST_EDITED`, `ISSUE_STAGE_END`, `MERGE_REQUEST_CLOSED`, `MERGE_REQUEST_CREATED`, `MERGE_REQUEST_FIRST_ASSIGNED_AT`, `MERGE_REQUEST_FIRST_COMMIT_AT`, `MERGE_REQUEST_FIRST_DEPLOYED_TO_PRODUCTION`, `MERGE_REQUEST_LABEL_ADDED`, `MERGE_REQUEST_LABEL_REMOVED`, `MERGE_REQUEST_LAST_BUILD_FINISHED`, `MERGE_REQUEST_LAST_BUILD_STARTED`, `MERGE_REQUEST_LAST_EDITED`, `MERGE_REQUEST_MERGED`, `MERGE_REQUEST_REVIEWER_FIRST_ASSIGNED`, `MERGE_REQUEST_PLAN_STAGE_START` - `start_event_label_id` (String) Label ID associated with the start event identifier. In the format of `gid://gitlab/GroupLabel/` or `gid://gitlab/ProjectLabel/` Read-Only: