diff options
Diffstat (limited to 'doc/user/infrastructure')
| -rw-r--r-- | doc/user/infrastructure/index.md | 10 | ||||
| -rw-r--r-- | doc/user/infrastructure/mr_integration.md | 6 | ||||
| -rw-r--r-- | doc/user/infrastructure/terraform_state.md | 8 |
3 files changed, 15 insertions, 9 deletions
diff --git a/doc/user/infrastructure/index.md b/doc/user/infrastructure/index.md index 4af18873798..4c012fbf1d9 100644 --- a/doc/user/infrastructure/index.md +++ b/doc/user/infrastructure/index.md @@ -1,7 +1,7 @@ --- stage: Configure group: Configure -info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#designated-technical-writers +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- # Infrastructure as code with Terraform and GitLab @@ -9,7 +9,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w ## Motivation The Terraform integration features within GitLab enable your GitOps / Infrastructure-as-Code (IaC) -workflows to tie into GitLab's authentication and authorization. These features focus on +workflows to tie into GitLab authentication and authorization. These features focus on lowering the barrier to entry for teams to adopt Terraform, collaborate effectively within GitLab, and support Terraform best practices. @@ -31,6 +31,12 @@ Amazon S3 or Google Cloud Storage. Its features include: Read more on setting up and [using GitLab Managed Terraform states](terraform_state.md) +WARNING: +Like any other job artifact, Terraform plan data is [viewable by anyone with Guest access](../permissions.md) to the repository. +Neither Terraform nor GitLab encrypts the plan file by default. If your Terraform plan +includes sensitive data such as passwords, access tokens, or certificates, GitLab strongly +recommends encrypting plan output or modifying the project visibility settings. + ## Terraform integration in Merge Requests Collaborating around Infrastructure as Code (IaC) changes requires both code changes and expected infrastructure changes to be checked and approved. GitLab provides a solution to help collaboration around Terraform code changes and their expected effects using the Merge Request pages. This way users don't have to build custom tools or rely on 3rd party solutions to streamline their IaC workflows. diff --git a/doc/user/infrastructure/mr_integration.md b/doc/user/infrastructure/mr_integration.md index 7d9a036cac8..c86e5ddf1db 100644 --- a/doc/user/infrastructure/mr_integration.md +++ b/doc/user/infrastructure/mr_integration.md @@ -1,7 +1,7 @@ --- stage: Configure group: Configure -info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#designated-technical-writers +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- # Terraform integration in Merge Requests @@ -17,7 +17,7 @@ modifies, or destroys. ## Setup -NOTE: **Note:** +NOTE: GitLab ships with a [pre-built CI template](index.md#quick-start) that uses GitLab Managed Terraform state and integrates Terraform changes into merge requests. We recommend customizing the pre-built image and relying on the `gitlab-terraform` helper provided within for a quick setup. To manually configure a GitLab Terraform Report artifact requires the following steps: @@ -42,7 +42,7 @@ To manually configure a GitLab Terraform Report artifact requires the following - alias convert_report="jq -r '([.resource_changes[]?.change.actions?]|flatten)|{\"create\":(map(select(.==\"create\"))|length),\"update\":(map(select(.==\"update\"))|length),\"delete\":(map(select(.==\"delete\"))|length)}'" ``` - NOTE: **Note:** + NOTE: In distributions that use Bash (for example, Ubuntu), `alias` statements are not expanded in non-interactive mode. If your pipelines fail with the error `convert_report: command not found`, alias expansion can be activated explicitly diff --git a/doc/user/infrastructure/terraform_state.md b/doc/user/infrastructure/terraform_state.md index ef36f0217be..cbd2a63524d 100644 --- a/doc/user/infrastructure/terraform_state.md +++ b/doc/user/infrastructure/terraform_state.md @@ -1,7 +1,7 @@ --- stage: Configure group: Configure -info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#designated-technical-writers +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- # GitLab managed Terraform State @@ -186,7 +186,7 @@ and the CI YAML file: The output from the above `terraform` commands should be viewable in the job logs. -CAUTION: **Caution:** +WARNING: Like any other job artifact, Terraform plan data is [viewable by anyone with Guest access](../permissions.md) to the repository. Neither Terraform nor GitLab encrypts the plan file by default. If your Terraform plan includes sensitive data such as passwords, access tokens, or certificates, GitLab strongly @@ -344,7 +344,7 @@ location. You can then go back to running it from within GitLab CI. ## Managing state files -NOTE: **Note:** +NOTE: We are currently working on [providing a graphical interface for managing state files](https://gitlab.com/groups/gitlab-org/-/epics/4563).  @@ -356,5 +356,5 @@ The state files attached to a project can be found under Operations / Terraform. You can only remove a state file by making a request to the API, like the following example: ```shell -curl --header "Private-Token: <your_access_token>" --request DELETE "https://gitlab.example.com/api/v4/projects/<your_project_id/terraform/state/<your_state_name>" +curl --header "Private-Token: <your_access_token>" --request DELETE "https://gitlab.example.com/api/v4/projects/<your_project_id>/terraform/state/<your_state_name>" ``` |