Skip to content

add 'getting started' section to README.md #671

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

Merged
merged 3 commits into from
Aug 16, 2022
Merged

add 'getting started' section to README.md #671

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2ae45ca
add 'getting started' section to README.md
cjerad Aug 12, 2022
c76c268
grammatical edits
cjerad Aug 16, 2022
53a0051
update version placeholder in urls
cjerad Aug 16, 2022
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
Prev Previous commit
update version placeholder in urls
  • Loading branch information
@cjerad
cjerad committed Aug 16, 2022
commit 53a0051ce8dac70caeceb9392d9cbe22ce4cd3d9
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Your EKS cluster must have an IAM OIDC Provider. Follow the steps in [Create an

##### 1.2.1. Create the IAM Policy

Download the service account policy template for AWS CloudFormation at https://github.com/aws/aws-node-termination-handler/releases/download/VERSION/infrastructure.yaml
Download the service account policy template for AWS CloudFormation at https://github.com/aws/aws-node-termination-handler/releases/download/v2.0.0-alpha/infrastructure.yaml

Then create the IAM Policy by deploying the AWS CloudFormation stack:
```sh
Expand Down Expand Up @@ -96,7 +96,7 @@ NTH reads events from one or more SQS Queues. If you already have an SQS Queue a

*Note:* Multiple Terminators may read from a single SQS Queue. A Terminator will only delete a message if a matching node was found in the cluster. The SQS Queue's visibility window setting can help to ensure that a message is delivered to only one Terminator at a time.

You may create your own SQS Queue but an AWS CloudFormation template is available that will create an SQS Queue and commonly used rules for AWS EventBridge. Download from https://github.com/aws/aws-node-termination-handler/releases/download/VERSION/queue-infrastructure.yaml
You may create your own SQS Queue but an AWS CloudFormation template is available that will create an SQS Queue and commonly used rules for AWS EventBridge. Download from https://github.com/aws/aws-node-termination-handler/releases/download/v2.0.0-alpha/queue-infrastructure.yaml

```sh
aws cloudformation deploy \
Expand All @@ -109,7 +109,7 @@ aws cloudformation deploy \

#### 3.2. Define and deploy a Terminator

You may download a template file from https://github.com/aws/aws-node-termination-handler/releases/download/VERSION/terminator.yaml.tmpl. Edit the file with the required fields and desired configuration.
You may download a template file from https://github.com/aws/aws-node-termination-handler/releases/download/v2.0.0-alpha/terminator.yaml.tmpl. Edit the file with the required fields and desired configuration.

Deploy the Terminator:
```sh
Expand Down