Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add backend configs for terraform remote state storage #561

Merged
merged 6 commits into from
Aug 2, 2021
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 6 additions & 14 deletions docs/howto/operate/new-tf-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Once you have created this file, open a Pull Request to the `pilot-hubs` repo fo

## Initialising Terraform

The terraform state is located centrally in our `two-eye-two-see-org` GCP project, therefore you must authenticate `gcloud` to your `@2i2c.org` account before initialising terraform.
Our default terraform state is located centrally in our `two-eye-two-see-org` GCP project, therefore you must authenticate `gcloud` to your `@2i2c.org` account before initialising terraform.

```bash
gcloud auth application-default login
Expand All @@ -41,26 +41,18 @@ Then you can change into the terraform directory and initialise

```bash
cd terraform
terraform init
terraform init -backend-config=backends/default-backend.hcl
```

````{note}
If you are deploying a cluster to a project you have access to via a different account, such as a university-affliated account, there are a few extra steps to take.
Hopefully, this will be a rare scenario.
If you are working on a project which you cannot access with your 2i2c account, there are other backend config files stored in `terraform/backends` that will configure a different storage bucket to read/write the remote terraform state.
This saves us the pain of having to handle multiple authentications as these storage buckets are within the project we are trying to deploy to.

First, you will need to provide terraform with an [access token](https://www.terraform.io/docs/language/settings/backends/gcs.html#configuration-variables) to use the state files.
You can generate one using the below commands and logging in with your 2i2c.org account.
For example, to work with Pangeo you would initialise terraform like so:

```bash
gcloud auth application-default login
gcloud auth application-default print-access-token
terraform init -backend-config=pangeo-backend.hcl
```

Add the access token to the [terraform backend block](https://github.com/2i2c-org/pilot-hubs/blob/2ef8a4bf35bb5ee9bf04ab3db1218b8c183c5da2/terraform/main.tf#L2-L5) in `main.tf`.
**DO NOT COMMIT THIS CHANGE.**
Then run `terraform init` or `terraform init -reconfigure`.

You can now login to your other gcloud account and proceed with the guide.
````

## Creating a new terraform workspace
sgibson91 marked this conversation as resolved.
Show resolved Hide resolved
Expand Down
19 changes: 18 additions & 1 deletion docs/topic/terraform.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,21 @@ file with variable definitions for that cluster.

Workspaces are stored centrally in the `two-eye-two-see-org` GCP project, even
when we use Terraform for projects running on AWS / Azure. You must have
access to this project before you can use terraform for our infrastructure.
access to this project before you can use terraform for our infrastructure.

You can initialise using the following command

```bash
terraform init -backend-config=backends/default-backend.hcl
```

## Other remote state storage

For some projects where we don't have access to using our 2i2c accounts, e.g. universities that require us to have specific university-affiliated identities, we can configure different backends to access the terraform state stored in those projects.
Working this way saves us the pain of trying to work with terraform using two different authentications.
The backend configs are stored in [`terraform/backends`](https://github.com/2i2c-org/pilot-hubs/tree/master/terraform/backends) and can be used by running `terraform init -backend-config=backends/NAME_OF_CHOSEN_BACKEND`.
For example, for our Pangeo projects, run:

```bash
terraform init -backend-config=backends/pangeo-backend.hcl
```
2 changes: 2 additions & 0 deletions terraform/backends/default-backend.hcl
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
bucket = "two-eye-two-see-org-terraform-state"
prefix = "terraform/state/pilot-hubs"
2 changes: 2 additions & 0 deletions terraform/backends/pangeo-backend.hcl
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
bucket = "pangeo-terraform-state"
prefix = "terraform/state"
5 changes: 1 addition & 4 deletions terraform/main.tf
Original file line number Diff line number Diff line change
@@ -1,8 +1,5 @@
terraform {
backend "gcs" {
bucket = "two-eye-two-see-org-terraform-state"
prefix = "terraform/state/pilot-hubs"
}
backend "gcs" {}
}

// Service account used by all the nodes and pods in our cluster
Expand Down