Commit 36d749e6 authored by Pierre Smeyers's avatar Pierre Smeyers
Browse files

docs:fix GitLab casing

parent f69b484d

README.md

+1 −1
Original line number Diff line number Diff line
@@ -315,7 +315,7 @@ Be aware of the following: 
* each of those variables support the value `auto`: in that case, the template will use the dynamic [`$environment_slug` value](#deployment-context-variables) as workspace name,

* if the specified workspace doesn't exist, the template will create it,

* HTTP backend doesn't support Workspaces. [See supported backends here](https://developer.hashicorp.com/terraform/language/state/workspaces#backends-supporting-multiple-workspaces).

* corollary as Gitlab http backend is on by default workspace selection is explicitly bypassed

* corollary as GitLab http backend is on by default workspace selection is explicitly bypassed

  unless `gitlab-backend-disabled` / `TF_GITLAB_BACKEND_DISABLED` is set to `true`.

  If kept enabled and if any of the `TF_WORKSPACE` variable is set the template will warn about it.

* if using another (non-Gitlab) http backend nothing will prevent from  trying to use workspaces, in

templates/gitlab-ci-terraform.yml

+4 −4
Original line number Diff line number Diff line
@@ -699,13 +699,13 @@ stages: 
        fail "terraform < 0.13.2 doesn't support environment variables to configure http backend"

      fi



      # Gitlab Terraform state storage uses the http backend and this does not support workspaces.

      # With TBC the Gitlab http backend configuration is scoped by environment.

      # GitLab Terraform state storage uses the http backend and this does not support workspaces.

      # With TBC the GitLab http backend configuration is scoped by environment.

      # If you require another state-scoping scheme to implement

      # workspace-like storage with the Gitlab backend, you can do so

      # workspace-like storage with the GitLab backend, you can do so

      # by overriding the TF_HTTP_ADDRESS variable to match your use-case.

      if [[ -n "${ENV_WORKSPACE:-$TF_WORKSPACE}" ]]; then

          log_warn "Using Terraform workspace with Gitlab backend is not supported, unsetting (was '${ENV_WORKSPACE:-$TF_WORKSPACE}') ..."

          log_warn "Using Terraform workspace with GitLab backend is not supported, unsetting (was '${ENV_WORKSPACE:-$TF_WORKSPACE}') ..."

          unset TF_WORKSPACE ENV_WORKSPACE

      fi