Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adds steps to install terraform and configure AWS credentials #196

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Adds steps to install terraform and configure AWS credentials #196

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion docs/getting-start.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,12 @@ The integration test GitHub actions workflow installs terraform, builds the agen
to the configured S3 bucket, so all you need to do is configure the secrets in the GitHub repo in order to allow the
actions to run.

## Prerequisites
You need to install terraform and configure AWS credential to run terraform commands.
1. Install `terraform` on your local machine ([download](https://www.terraform.io/downloads))
2. Install [AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html) on your local machine
3. [Configure your AWS credentials](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-quickstart.html#getting-started-quickstart-new)

## 0. vCPU limit
Newer accounts have lowered default vCPU limits which constrains workflow (eg. running CWAgent GitHub actions on personal forks).
If you haven't for the choice of your AWS account, do
Expand Down Expand Up @@ -281,7 +287,7 @@ Outputs:
[reference of how to create role](https://github.com/aws-actions/configure-aws-credentials)

## 7. Setup the integration test resources
1. Navigate to your fork
1. Fork amazon-cloudwatch-agent-test(or you can just download the terraform folder)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should probably be clarified. Also, I don't think there's really any good reason to download the folder itself, without setting up the git repo locally.

2. Run the following command to setup all the resources being used for integration test (e.g vpc, iam, etc)
```shell
cd terraform/setup # assuming you are still in the ./terraform
Expand Down