-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add new docs scaffolding to wiki
- Loading branch information
1 parent
91b7b37
commit 753c2b9
Showing
3 changed files
with
61 additions
and
35 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# Generating AWS and GitHub access tokens | ||
|
||
On this page... |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,40 +1,47 @@ | ||
![aws-eks-ec2 Banner Image](_assets/banner.svg) | ||
![aws-eks-ec2 Banner Image](https://raw.githubusercontent.com/wiki/workflows-sh/aws-eks-ec2-asg-cdk/_assets/banner.svg) | ||
|
||
# Docs for AWS-EKS-EC2-ASG-CDK Workflow Stack | ||
# AWS-EKS-EC2-ASG-CDK Workflow Stack Documentation | ||
|
||
### Set Up your Account on CTO.ai | ||
## Add environment variables to Secrets Store | ||
|
||
Before you can deploy this Workflow, you need to [Setup your account on CTO.ai](https://cto.ai/docs/setup-flow) | ||
> Resource: [Using Secrets and Configs via Dashboard](https://cto.ai/docs/secrets-and-configs-dashboard) | ||
### Create Secrets from Settings | ||
Create new environment variables via your Secrets Store on the CTO.ai Dashboard, one for each of the following keys: | ||
|
||
Secrets are encrypted environment variables that CTO.ai utilizes within your workflow to build and run your application and deployments. [Follow this guide to create secrets from settings.](https://cto.ai/docs/aws-eks-ec2#create-secret-from-settings), and also [generate your Github token](https://cto.ai/docs/aws-eks-ec2#generate-github-token) | ||
- `AWS_ACCESS_KEY_ID` | ||
- `AWS_SECRET_ACCESS_KEY` | ||
- `AWS_ACCOUNT_NUMBER` | ||
- `GITHUB_TOKEN` | ||
|
||
### View Auto Scaling groups | ||
This wiki has more information on [generating your AWS and GitHub credentials](https://github.com/workflows-sh/aws-eks-ec2-asg-cdk/wiki/Generating-access-tokens). | ||
|
||
Schedule the scaling [actions that proactively increases and decreases capacity to match the load forecast](https://cto.ai/docs/aws-eks-ec2#view-auto-scaling-groups) | ||
## Install the repo locally | ||
|
||
Follow the following steps below to configure and deploy your AWS EC2-Elastic Kubernetes Service Workflow | ||
Clone the GitHub repository for this workflow stack locally, then change in to the directory: | ||
|
||
### Build and Run Pipelines | ||
```bash | ||
git clone https://github.com/workflows-sh/aws-eks-ec2-asg-cdk.git | ||
cd aws-eks-ec2-asg-cdk | ||
``` | ||
|
||
- [Build Pipelines locally with the Workflow CLI](https://cto.ai/docs/aws-eks-ec2#build-pipelines-locally-with-the-ctoai-cli) | ||
## Build Pipelines locally with CTO.ai CLI | ||
|
||
- [Run Pipelines locally with the Workflow CLI](https://cto.ai/docs/aws-eks-ec2#run-pipelines-locally-with-the-ctoai-cli) | ||
Run the following CLI command to build the repo's Pipelines workflow locally: | ||
|
||
### Run and Setup your Infrastructure | ||
```bash | ||
ops build . | ||
``` | ||
|
||
In your AWS EKS EC2 workflow, [build and set up your infrastructure using the `ops run -b .` command. This will provision your AWS-EKS EC2 stacks using Cloud Formation](https://cto.ai/docs/aws-eks-ec2#run-and-setup-your-infrastructure) | ||
Then, when prompted, select the `sample-app-pipeline` workflow from the list. This will build the workflow locally (for use or sharing) and build the workflow's Docker image from its `Dockerfile`. | ||
|
||
### View changes on CloudFormation | ||
The resulting Docker image will be tagged with the name and version specified in the workflow's `ops.yml` file. | ||
|
||
- [Get a detailed overview of your entire Stack on CloudFormation](https://cto.ai/docs/aws-eks-ec2#view-changes-on-aws-cloudformation) | ||
## Run Pipelines locally with CTO.ai CLI | ||
|
||
### View EC2 instances on AWS | ||
Run the following CLI command to run the repo's Pipelines workflow locally: | ||
|
||
Get insights to your EC2 instances on AWS. [View EC2 instances on AWS](https://cto.ai/docs/aws-eks-ec2#view-ec2-instances-on-aws) | ||
```bash | ||
ops run . | ||
``` | ||
|
||
|
||
### View Elastic Kubernetes Service Cluster | ||
|
||
See your [EKS Cluster resources, deployments, and authentication](https://cto.ai/docs/aws-eks-ec2#view-elastic-kubernetes-service-cluster) | ||
Then, when prompted, select the `sample-app-pipeline` workflow from the list. This will run the workflow locally, using the Docker image built in the previous step. |