do-foundations

Foundations for DigitalOcean-based services

This repository defines a do-foundations service whose purpose is to provide the necessary interfaces to seamlessly deploy other services to DigitalOcean.

In particular, an <environment> instance of do-foundations provides:

• A do-foundations-<environment>-terraform DigitalOcean Spaces Object Storage bucket for Terraform state.

Deployment

Automatic deployment

The service is continuously deployed by GitHub Actions.

Manual deployment

Prefer to make changes via PR and continuous deployment, but manual deployment is possible if necessary.

Prerequisites

Tools

• AWS CLI

  Note that AWS itself is not used, but DigitalOcean's CLI does not support Spaces operations.

• Terraform CLI

Environment

• The AWS CLI must be able to interact with the DigitalOcean Spaces API. This can be configured by obtaining a Spaces Key for your target account.

  Conventionally, these should be configured in an AWS credentials profile in ~/.aws/credentials, e.g.:

  [DO-<team slug>-<user email>]
  aws_access_key_id = <your access key>
  aws_secret_access_key = <your secret key>

  You will also need a corresponding AWS configuration profile defined in ~/.aws/config, e.g.:

  [profile DO-<team slug>-<user email>]
  region = <region>
  services = digitalocean-<region>
  
  [services digitalocean-<region>]
  s3 =
    endpoint_url = https://<region>.digitaloceanspaces.com

  You can then configure most AWS tools to use that profile by setting AWS_PROFILE=DO-<team slug>-<user email>.

  Note that DigitalOcean's access boundary is the team, so if you want strong isolation between environments you must create a team per environment.

Steps

1. Run the deployment script:

   ./deploy.sh '<env>'

You can alternatively use the terraform-env.sh script to set up environment variables for working directly with Terraform:

eval "$(./terraform-env.sh do-foundations '<env>')"
terraform ...