Skip to content

Commit

Permalink
Address comments on wording in README
Browse files Browse the repository at this point in the history
Signed-off-by: Mikkel Oscar Lyderik Larsen <mikkel.larsen@zalando.de>
  • Loading branch information
mikkeloscar committed Jun 5, 2019
1 parent 8352db6 commit f313164
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ can inject the required configuration automatically.
### Setting up AWS IAM roles

The controller does not take care of AWS IAM role provisioning and assumes that
the user provisions AWS IAM roles manually for instance via
the user provisions AWS IAM roles manually, for instance via
[CloudFormation](https://aws.amazon.com/cloudformation/) or
[Terraform](https://www.terraform.io/).

Expand Down Expand Up @@ -150,7 +150,7 @@ Resources:
The role could be created via:

```sh
# $ASSUME_ROLE_ARN is the arn of the role used by the kube-aws-iam-controller deployment
# $ASSUME_ROLE_ARN is the ARN of the role used by the kube-aws-iam-controller deployment
$ aws cloudformation create-stack --stack-name aws-iam-example \
--parameters "ParameterKey=AssumeRoleARN,ParameterValue=$ASSUME_ROLE_ARN" \
--template-body=file://iam-role.yaml --capabilities CAPABILITY_NAMED_IAM
Expand Down Expand Up @@ -199,7 +199,9 @@ controller allows specifying such a role via the

In this case the `<instance-role>` will only be used for the initial assuming
of the `<controller-role>` and all `<app-role>s` are assumed by the
`<controller-role>`. If you don't specify `--assume-role` then the
`<controller-role>`. This makes it possible to have many different
`<instance-role>s` while the `<app-role>s` only have to trust the single static
`<controller-role>`. If you don't specify `--assume-role` then the
`<instance-role>` would have to assume the `<app-role>s`.

Here is an example of the AWS IAM roles defined for this set-up to work:
Expand Down

0 comments on commit f313164

Please sign in to comment.