Skip to content
This repository was archived by the owner on Nov 30, 2021. It is now read-only.

Commit ea8c7a6

Browse files
committed
docs(src/quickstart/provider/aws): Changes from code review.
Adding in AWS cli instructions. Wordsmithing IAM policy. Fixing possessive apostrophes. Backticks on commands. No breaking changes.
1 parent 5c16b82 commit ea8c7a6

File tree

1 file changed

+34
-11
lines changed

1 file changed

+34
-11
lines changed

src/quickstart/provider/aws/boot.md

Lines changed: 34 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -46,13 +46,34 @@ $ sudo mv kubectl /usr/local/bin/kops
4646

4747
## Setup your AWS account
4848

49-
#### Setup an IAM user for kops
49+
### Install the `awscli` tool
5050

51-
In order to build clusters within AWS we'll create a dedicated IAM user for
52-
`kops`. This user requires API credentials in order to use `kops`. Create
53-
the user, and credentials, using the [AWS console](http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSGettingStartedGuide/AWSCredentials.html).
51+
The officially supported way of installing the tool is with `pip` as in
5452

55-
The `kops` user will require the following IAM permissions to function properly
53+
```bash
54+
$ pip install awscli
55+
```
56+
57+
You can also grab the tool with homebrew (for macOS users **only**), although this is not officially supported by AWS.
58+
59+
```bash
60+
$ brew update && brew install awscli
61+
```
62+
63+
#### Configure the `awscli` tool
64+
65+
The first thing you need to do is get valid AWS credentials out of the console. See [the official documentation](http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html#Using_CreateAccessKey) on how to find your *SecretAccessKey* and *AccessKeyID*.
66+
67+
Once you have those you can configure the `awscli` tool with
68+
69+
```bash
70+
$ aws configure # Input your credentials here
71+
```
72+
73+
74+
#### Setting up IAM permission for kops
75+
76+
The recommended practice is to use a dedicated IAM user for kops. At a minimum `kops` will require the following IAM permissions to function properly.
5677

5778
- AmazonEC2FullAccess
5879
- This is used to deploy to instances in EC2
@@ -61,16 +82,18 @@ The `kops` user will require the following IAM permissions to function properly
6182
- AmazonS3FullAccess
6283
- This is used to store meta configuration about your cluster. We will need read/write here to use S3 as a virtual filesystem in kops.
6384
- IAMFullAccess
64-
- This is used because kops will create new IAM users for some of it's resources. Those resources will have permissions managed securely by kops.
85+
- This is used because kops will create new IAM users for some of its resources. Those resources will have permissions managed securely by kops.
6586
- AmazonVPCFullAccess
6687
- This used to create a VPC which serves as the foundation of all networking components in kops. Without a VPC, kops wouldn't be able to deploy any resources dependent on a network.
6788

68-
#### Create the IAM user from the command line
89+
90+
#### (Optional) Create a dedicated IAM user from the command line
91+
92+
**Note**: This can only be done **AFTER** you already have valid aws credentials in place. We will use the official `kops` provided convenience script to configure a new user with the following syntax: `sh new-iam-user.sh $group $user`
6993

7094
```bash
7195
$ curl -O https://raw.githubusercontent.com/kubernetes/kops/master/hack/new-iam-user.sh
72-
$ sh new-iam-user.sh <group> <user>
73-
$ aws iam list-users
96+
$ sh new-iam-user.sh kops-group kops-user
7497
```
7598

7699
Note the *SecretAccessKey* and *AccessKeyID* so you can enter them in the following commands
@@ -188,7 +211,7 @@ for some of these instructions.
188211
$ ID=$(uuidgen) && aws route53 create-hosted-zone --name subdomain.kubernetes.com --caller-reference $ID | jq .DelegationSet.NameServers
189212
```
190213

191-
* You will now go to your registrars page and log in. You will need to create a
214+
* You will now go to your registrar's page and log in. You will need to create a
192215
new **SUBDOMAIN**, and use the 4 NS records listed above for the new
193216
**SUBDOMAIN**. This **MUST** be done in order to use your cluster. Do **NOT**
194217
change your top level NS record, or you might take your site offline.
@@ -212,7 +235,7 @@ $ kops create cluster --dns private $NAME
212235

213236
#### Testing your DNS setup
214237

215-
You should now able to dig your domain (or subdomain) and see the AWS Name
238+
You should now able to `dig` your domain (or subdomain) and see the AWS Name
216239
Servers on the other end.
217240

218241
```bash

0 commit comments

Comments
 (0)