Update AWS quick-start guide (#89)

k0rdent · Jan 20, 2025 · e4005a5 · e4005a5
1 parent c8645f6
commit e4005a5
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 7 deletions.
diff --git a/docs/clustertemplates/aws/hosted-control-plane.md b/docs/clustertemplates/aws/hosted-control-plane.md
@@ -72,7 +72,7 @@ kind: ClusterDeployment
 metadata:
   name: aws-hosted-cp
 spec:
-  template: aws-hosted-cp-0-0-3
+  template: aws-hosted-cp-0-0-4
   credential: aws-credential
   config:
     vpcID: vpc-0a000000000000000
@@ -108,7 +108,7 @@ kind: ClusterDeployment
 metadata:
   name: aws-hosted
 spec:
-  template: aws-hosted-cp-0-0-3
+  template: aws-hosted-cp-0-0-4
   credential: aws-credential
   config:
     vpcID: "{{.spec.network.vpc.id}}"

diff --git a/docs/clustertemplates/aws/template-parameters.md b/docs/clustertemplates/aws/template-parameters.md
@@ -64,7 +64,7 @@ kind: ClusterDeployment
 metadata:
   name: cluster-1
 spec:
-  template: aws-standalone-cp-0-0-2
+  template: aws-standalone-cp-0-0-5
   credential: aws-cred
   config:
     sshKeyName: foobar
@@ -88,7 +88,7 @@ kind: ClusterDeployment
 metadata:
   name: cluster-1
 spec:
-  template: aws-eks-0-0-2
+  template: aws-eks-0-0-3
   credential: aws-cred
   config:
     sshKeyName: foobar

diff --git a/docs/quick-start/aws.md b/docs/quick-start/aws.md
@@ -36,7 +36,8 @@ with the necessary IAM policies and service account.
     export AWS_REGION=<aws-region>
     export AWS_ACCESS_KEY_ID=<admin-user-access-key>
     export AWS_SECRET_ACCESS_KEY=<admin-user-secret-access-key>
-    export AWS_SESSION_TOKEN=<session-token> # Optional. If you are using Multi-Factor Auth.
+    # AWS_SESSION_TOKEN is optional when using Multi-Factor Auth.
+    export AWS_SESSION_TOKEN=<session-token>
     ```
 
 2. After these are set, run this command to create the IAM CloudFormation stack:
@@ -79,6 +80,9 @@ type: Opaque
 stringData:
   AccessKeyID: AKIAQF+EXAMPLE
   SecretAccessKey: EdJfFar6+example
+  # SessionToken is optional when using Multi-Factor Auth.
+  # SessionToken: IQoJb3JpZ2luX2VjEK7//+example
+
 ```
 
 Apply the YAML to your cluster using the following command:
@@ -144,6 +148,7 @@ spec:
     apiVersion: infrastructure.cluster.x-k8s.io/v1beta2
     kind: AWSClusterStaticIdentity
     name: aws-cluster-identity
+    namespace: kcm-system
 ```
 
 Apply the YAML to your cluster:
@@ -166,16 +171,20 @@ metadata:
   name: my-aws-clusterdeployment1
   namespace: kcm-system
 spec:
-  template: aws-standalone-cp-0-0-4
+  template: aws-standalone-cp-0-0-5
   credential: aws-cluster-identity-cred
   config:
-    region: us-west-2
+    region: us-east-2
     controlPlane:
       instanceType: t3.small
     worker:
       instanceType: t3.small
 ```
 
+> WARNING:
+> Don't forget to set proper AWS Region.
+>
+
 > NOTE:
 > To see available versions for `AWS` template run `kubectl get clustertemplate -n kcm-system`.
 >