Deploy the AWS Orbit Foundation

Prerequisites

CLI installed
CodeSeeder installed

IMPORTANT
For the foundation, you may use an existing foundation. You must have defined the following:

VPC
Subnets (at least 2 public and 2 private)
Elastic File System (EFS)
- the Security Group on the EFS MUST allow all ingress traffic from the VPC CIDR
Cognito User Pool

If the above is defined, then you can populate the manifest with these values, removing the need to deploy a separate foundation.

Steps to Deploy a NEW foundation

There are two methods to deploy the foundation:

CLI and manifest (preferred method)
CLI and parameters (supported)

CLI and Manifest

The Orbit Workbench leverages manifests to define parameters. For the foundation, we will use a subset of the manifest as defined below. The ONLY required field is Name, all others are either set with a default or are None.

NOTE: the Name field is NOT the same as the Orbit Workbench Name!!

Name: <name>
Networking:
    Data:
        InternetAccessible: true         #Optional - defaults to true 
    Frontend:
        SslCertArn: <ARN of CERT>        #Optional
        CustomDomainName: <DOMAIN NAME>  #Optional
    MaxAvailabilityZones: 2              #Optional - defaults to 2

Here is an example of a valid foundation template named foundation_manifest.yaml:

Name: fdn
Networking:
    Data:
        InternetAccessible: true 

orbit deploy foundation -f foundation_manifest.yaml

CLI and Parameters

There are parameters that you can pass in without needing a manifest:

-n, --name TEXT                 The Name of the Orbit Foundation deployment
  --ssl-cert-arn TEXT             SSL Certificate to integrate the ALB with.
  --custom-domain-name TEXT       The Custom Domain Name to associate the
                                  orbit framework with

  --internet-accessibility / --no-internet-accessibility
                                  Configure for deployment to Private
                                  (internet accessibility) or Isolated (no
                                  internet accessibility) subnets.  [default:
                                  True]

  --max-availability-zones INTEGER
                                  The maximum number of Availability Zones to
                                  attempt to deploy in the VPC  [default: 2]

orbit deploy foundation -n <name_of_foundation> --custom-domain-name <something> \
--internet-accessibility --max-availability-zones <int>

Steps to Destroy

orbit destroy foundation -n <name_of_foundation>

Overview