Skip to content

Latest commit

 

History

History
194 lines (134 loc) · 4.86 KB

bootstrapping.md

File metadata and controls

194 lines (134 loc) · 4.86 KB
Raw

Bootstrapping

In the case of first execution or of a disaster, this repository might not work properly.

This document will detail how to use this repository for the initial setup, sharing detailed steps.

❗️ Important: In the case of a disaster, not all of these steps are necessary and following them to the letter might cause further loss.

Steps

  1. Create an ElephantSQL account and fetch an API key.

    Once the account is created, retrieve an API key store it under the ELEPHANTSQL_APIKEY environment variable:

    read -s ELEPHANTSQL_APIKEY
export ELEPHANTSQL_APIKEY

  2. Get the gandi.net API key.

    Retrieve the API key (and not a PAT), and save it under the GANDI_KEY environment variable:

    read -s GANDI_KEY
export GANDI_KEY

  3. Get an ImprovMX API key.

    Retrieve the API key , and save it under the IMPROVMX_API_TOKEN environment variable:

    read -s IMPROVMX_API_TOKEN
export IMPROVMX_API_TOKEN

  4. Switch into bootstrap mode

    Set the BOOTSTRAP environment variable to true:

    export BOOTSTRAP=true

  5. Create a github organization named powerd6.

    After creating it, fetch the organization ID from the api:

    export GH_ORG_ID=$(gh api /orgs/powerd6 | jq -r '.id')

    Once created, enable the usage of Personal access tokens for the organization with the following settings:

    • Allow access via fine-grained personal access tokens
    • Require administrator approval
    • Restrict access via personal access tokens (classic)

  6. Create a super-admin PAT for the GitHub organization

    This token will be used for the creation and management of multiple aspects of the project.

    It should have the following permissions:

    • Repository access: All repositories
    • Repository permissions:
      • Actions: Read and write
      • Administration: Read and write
      • Commit statuses: Read and write
      • Contents: Read and write
      • Environments: Read and write
      • Issues: Read and write
      • Metadata: Read-only
      • Pages: Read and write
      • Pull requests: Read and write
      • Secrets: Read and write
      • Workflows: Read and write
    • Organization permissions:
      • Administration: Read and write
      • Members: Read and write
      • Projects: Read and write
      • Secrets: Read and write
      • Variables: Read and write

    Store it under the GH_ADMIN_TOKEN environment variable:

    read -s GH_ADMIN_TOKEN
export GH_ADMIN_TOKEN

  7. Initialize all the modules

    From the root of the repository, run:

    terragrunt run-all init

    This step should work. If it fails, the error message will tell you why. Most likely, a variable that is required is not setup correctly.

  8. Import the existing GitHub organization into the state

    This is necessary because organizations cannot be created by terraform.

    cd stages/github
terragrunt import github_organization_settings.powerd6 $GH_ORG_ID
cd ../../

  9. Import the existing domain into the state

    This is necessary because domains cannot be created by terraform.

    cd stages/domain
terragrunt import gandi_domain.powerd6_org powerd6.org
cd ../../

  10. Delete the currently configured gandi.net DNS records

    This is necessary because DNS records cannot be imported.

  11. Import the existing email forwarding domain into the state

    This is necessary because domains cannot be created by terraform.

    cd stages/email
terragrunt import improvmx_domain.domain powerd6.org
cd ../../

  12. Apply all the modules

    From the root of the repository, run:

    terragrunt run-all apply

    This step should work. If it fails, the error message will tell you why. Most likely, a variable that is required is not setup correctly.

  13. Fetch the valid PSQL connection string

    Set the PG_CONN_STR environment variable with:

    cd stages/state
export PG_CONN_STR=$(terragrunt output -raw psql_url)
cd ../../

  14. Switch out of the bootstrap mode

    Unset the BOOTSTRAP environment variable:

    unset BOOTSTRAP

  15. Migrate all the modules

    From the root of the repository, run:

    terragrunt run-all init -migrate-state  -force-copy -lock=false

    This step should work. If it fails, the error message will tell you why. Most likely, a variable that is required is not setup correctly.

  16. Apply all the modules

    From the root of the repository, run:

    terragrunt run-all apply

    This step should work and show no changes. If it does, then you are done!