diff options
Diffstat (limited to 'doc/administration/terraform_state.md')
| -rw-r--r-- | doc/administration/terraform_state.md | 30 |
1 files changed, 22 insertions, 8 deletions
diff --git a/doc/administration/terraform_state.md b/doc/administration/terraform_state.md index d3b941bd129..3ac9a5fdce8 100644 --- a/doc/administration/terraform_state.md +++ b/doc/administration/terraform_state.md @@ -1,6 +1,6 @@ --- -stage: Configure -group: Configure +stage: Deploy +group: Environments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments --- @@ -22,9 +22,23 @@ Use [external object storage](https://docs.gitlab.com/charts/advanced/external-o ## Disabling Terraform state -To disable terraform state site-wide, follow the steps below. -A GitLab administrator may want to disable Terraform state to reduce disk space or if Terraform is not used in your instance. -To do so, follow the steps below according to your installation's type. +You can disable Terraform state across the entire instance. You might want to disable Terraform to reduce disk space, +or because your instance doesn't use Terraform. + +When Terraform state administration is disabled: + +- On the left sidebar, you cannot select **Infrastructure > Terraform states**. +- Any CI/CD jobs that access the Terraform state fail with this error: + + ```shell + Error refreshing state: HTTP remote state endpoint invalid auth + ``` + +To disable Terraform administration, follow the steps below according to your installation. + +Prerequisite: + +- You must be an administrator. **In Omnibus installations:** @@ -79,7 +93,7 @@ Terraform state files are stored locally, follow the steps below. ## Using object storage **(FREE SELF)** Instead of storing Terraform state files on disk, we recommend the use of -[one of the supported object storage options](object_storage.md#options). +[one of the supported object storage options](object_storage.md#supported-object-storage-providers). This configuration relies on valid credentials to be configured already. [Read more about using object storage with GitLab](object_storage.md). @@ -161,10 +175,10 @@ sudo find /var/opt/gitlab/gitlab-rails/shared/terraform_state -type f | grep -v ### S3-compatible connection settings In GitLab 13.2 and later, you should use the -[consolidated object storage settings](object_storage.md#consolidated-object-storage-configuration). +[consolidated object storage settings](object_storage.md#configure-a-single-storage-connection-for-all-object-types-consolidated-form). This section describes the earlier configuration format. -See [the available connection settings for different providers](object_storage.md#connection-settings). +See [the available connection settings for different providers](object_storage.md#configure-the-connection-settings). **In Omnibus installations:** |