environments

Gateway environments

We currently manage one environment: Belgium.

Provision a new environment

1. Add the Terraform Cloud workspace for the new environment in the main workspace and push the changes to the main branch. See tf-workspace/environments.tf.

2. Create a new Terraform workspace in this directory and push it to main. This workspace MUST initialise the gateway module. You could start by copying an existing workspace.

3. Go to GCB and run the trigger for the new environment. You will have to connect the GitHub repository first.

   The first build might fail if the MongoDB Atlas VPC peering connection isn't ready (the connection string won't be available). If this happens:

   1. Go to MongoDB Atlas and wait until the peering connection is available.
   2. Go to Terraform Cloud and trigger another run.
   3. Run the GCB trigger again.

4. Configure CI by registering the new environment in cloud-oss.

5. Configure Error Reporting notifications by going to the console and clicking "Configure Notifications". Unfortunately, we're unable to automate this.

6. Add to dependabot.yml.

7. Add to CI.

Deprovision an environment

Deprovisioning isn't currently as automated as it can be, so the following manual steps are needed:

1. Deactivate CI by removing the environment from cloud-oss.
2. Alter Terraform resources to allow destruction by setting the prevent_destruction in the module to false.
3. Go to Terraform Cloud and destroy the workspace from the settings.
4. Delete the Terraform Cloud workspace from the main workspace, by removing the respective module from tf-workspace/environments.tf in the main branch.
5. Delete the module from the current directory.