AWS Orbit Workbench CLI

Contributing

1 - Requirements

• DockerHub account
• MacOS or Linux
• python 3.6+
• node.js

2 - Project Setting Up

Cloning the code base locally and enter the CLI component directory

• See Clone Repo

Setting up a development environment

• See Setup CLI

3 - Deploying and Destroying

Running static validations

• ./validate.sh

Generating template manifests

For deploy operations, the operator needs to provide a manifest. The following command generates sample manifests to allow quick initiation.

• See Manifest

Deploying Orbit Foundation

Orbit CLI can deploy required resources such as VPC, Cognito User Pool, File systems, etc.
Users can decide to deplot using existing resources, or use orbit to deploy these resources as follows:

• See Foundation

Destroying Orbit Foundation

• See Foundation

Deploying Orbit Environment

• See Environment

Destroying Orbit Environment

• See Environment

4 - Assuming Admin Role to Access EKS

• Install kubectl
• Go to the IAM console
• Find the Admin Role (arn:aws:iam::{ACCOUNT_ID}:role/orbit-{ENV_NAME}-admin).
• Add your user or role under the Trust Relationship tab.

{
    "Effect": "Allow",
    "Principal": {
        "AWS": "arn:aws:iam::{ACCOUNT_ID}:user/{USERNAME}"
    },
    "Action": "sts:AssumeRole"
},

• Open the temrinal and user the AWS CLI to configure your kubeconfig
• aws eks update-kubeconfig --name orbit-{ENV_NAME} --role-arn arn:aws:iam::{ACCOUNT_ID}:role/orbit-{ENV_NAME}-admin
• Validate you access
• kubectl get pod -A

5 - Visual Studio Code tips

Recommended extensions

• ms-python.python
• kddejong.vscode-cfn-lint

Recommended settings

{
    "cfnLint.ignoreRules": [
        "E1029",
        "E3031"
    ],
    "python.formatting.provider": "black",
    "python.linting.enabled": true,
    "python.linting.flake8Enabled": true,
    "python.linting.mypyEnabled": true,
    "python.linting.pylintEnabled": false
}