Skip to content

Latest commit

 

History

History
64 lines (43 loc) · 4.13 KB

set-up-app-env.md

File metadata and controls

64 lines (43 loc) · 4.13 KB

Set up Application Environment

The application environment setup process will:

  1. Configure a new application environment and create the infrastructure resources for the application in that environment

Requirements

Before setting up the application's environments you'll need to have:

  1. A compatible application in the app folder
  2. Set up the AWS account that this environment is going to use.
  3. Configure the app in infra/<APP_NAME>/app-config/main.tf.
    1. Make sure you update has_database to true or false (defaults to true) depending on whether or not your application has a database to integrate with.
    2. Make sure you update has_external_non_aws_service to true or false depending on whether your application utilizes any non-AWS services. Other applications within the same git repo count as external services, so if your application makes API calls to another application service in the same git repo, set has_external_non_aws_service to true.
    3. If you're configuring your production environment, make sure to update the service_cpu, service_memory, and service_desired_instance_count settings based on the project's needs. If your application is sensitive to performance, consider doing a load test.
    4. Make sure your application environment is using the network/AWS Account you want to use by checking the network_name property in the environment configuration and what account it maps to in the project configuration. Update the values if necessary.
  4. Create a nondefault VPC to be used by the application
  5. (If the application has external non-AWS services) Set up network access to the public internet
  6. (If the application has a database) Set up the database for the application
  7. (If you have an incident management service) Set up monitoring
  8. Set up the application build repository

1. Configure backend

To create the tfbackend and tfvars files for the new application environment, run

make infra-configure-app-service APP_NAME=<APP_NAME> ENVIRONMENT=<ENVIRONMENT>

APP_NAME needs to be the name of the application folder within the infra folder. ENVIRONMENT needs to be the name of the environment you are creating. This will create a file called <ENVIRONMENT>.s3.tfbackend in the infra/<APP_NAME>/service module directory.

Depending on the value of has_database in the app-config module (infra/<APP_NAME>/app-config/main.tf), the application will be configured with or without database access.

2. Build and publish the application to the application build repository

Before creating the application resources, you'll need to first build and publish at least one image to the application build repository.

There are two ways to do this:

  1. Trigger the "Build and Publish" workflow from your repo's GitHub Actions tab. This option requires that the role-to-assume GitHub workflow variable has already been set up as part of the overall infra account setup process.

  2. Alternatively, run the following from the root directory. This option can take much longer than the GitHub workflow, depending on your machine's architecture.

    make release-build APP_NAME=<APP_NAME>
make release-publish APP_NAME=<APP_NAME>

Copy the image tag name that was published. You'll need this in the next step.

3. Create application resources with the image tag that was published

Now run the following commands to create the resources, using the image tag that was published in the previous step. Review the terraform before confirming "yes" to apply the changes.

TF_CLI_ARGS_apply="-var=image_tag=<IMAGE_TAG>" make infra-update-app-service APP_NAME=<APP_NAME> ENVIRONMENT=<ENVIRONMENT>

4. Configure monitoring alerts

Configure email alerts, external incident management service integration and additional CloudWatch Alerts. Configure monitoring module