Skip to content

Commit 3586b3b

Browse files
authored
Merge pull request #3877 from rsadowsk/development-doc-update
docs: updated Developer Guide with changes to make it more accurate
2 parents c42112b + 40075c8 commit 3586b3b

File tree

2 files changed

+11
-5
lines changed

2 files changed

+11
-5
lines changed

docs/book/src/development/development.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,12 @@
1818
6. Install make.
1919
7. Install direnv
2020
- `brew install direnv` on macOS.
21+
8. Set AWS Environment variable for an IAM Admin user
22+
- ```bash
23+
export AWS_ACCESS_KEY_ID=ADMID
24+
export AWS_SECRET_ACCESS_KEY=ADMKEY
25+
export AWS_REGION=eu-west-1
26+
```
2127

2228
### Get the source
2329

@@ -38,9 +44,9 @@ git fetch upstream
3844
Build `clusterawsadm` in `cluster-api-provider-aws`:
3945

4046
```bash
41-
cd "$(go env GOPATH)"/src/sigs.k8s.io/cluster-api-provider-aws/v2
47+
cd "$(go env GOPATH)"/src/sigs.k8s.io/cluster-api-provider-aws/
4248
make clusterawsadm
43-
mv ./bin/clusterawsadm /usr/local/bin/clusterawsadm
49+
sudo mv ./bin/clusterawsadm /usr/local/bin/clusterawsadm
4450
```
4551

4652
### Setup AWS Environment
@@ -80,7 +86,7 @@ spec:
8086
Use the configuration file to create the additional IAM role:
8187

8288
```bash
83-
$ ./bin/clusterawsadm bootstrap iam create-cloudformation-stack --config=config-bootstrap.yaml
89+
$ clusterawsadm bootstrap iam create-cloudformation-stack --config=config-bootstrap.yaml
8490
Attempting to create AWS CloudFormation stack cluster-api-provider-aws-sigs-k8s-io
8591
```
8692

docs/book/src/development/tilt-setup.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Also, visit the [Cluster API documentation on Tilt][cluster_api_tilt] for more i
1414
First, make sure you have a kind cluster and that your `KUBECONFIG` is set up correctly:
1515

1616
``` bash
17-
kind create cluster
17+
kind create cluster --name=capi-test
1818
```
1919

2020
This local cluster will be running all the cluster api controllers and become the management cluster which then can be used to spin up workload clusters on AWS.
@@ -24,7 +24,7 @@ This local cluster will be running all the cluster api controllers and become th
2424
Get the source for core cluster-api for development with Tilt along with cluster-api-provider-aws.
2525

2626
```bash
27-
cd "$(go env GOPATH)"
27+
cd "$(go env GOPATH)"/src
2828
mkdir sigs.k8s.io
2929
cd sigs.k8s.io/
3030
git clone [email protected]:kubernetes-sigs/cluster-api.git

0 commit comments

Comments
 (0)