github.com/kubernetes-incubator/kube-aws@v0.16.4/docs/cli-reference/README.md (about) 1 # CLI Reference 2 3 [AWS credentials](aws-credentials.md) need to be configured for commands that run against your AWS account. 4 5 # `init` 6 7 Initialize the base configuration for a cluster ready for customization prior to deployment. 8 9 | Flag | Description | Default | 10 | -- | -- | -- | 11 | `ami-id` | The AMI ID of Flatcar Container Linux to deploy | The latest AMI for the Container Linux release channel specified in `cluster.yaml` | 12 | `availability-zone` | The AWS availability-zone to deploy to. Note, this can be changed to multi AZ in `cluster.yaml` | none | 13 | `cluster-name` | The name of this cluster. This will be the name of the cloudformation stack | none | 14 | `external-dns-name` | The hostname that will route to the api server | none | 15 | `hosted-zone-id` | The hosted zone in which a Route53 record set for a k8s API endpoint is created | none | 16 | `key-name` | The AWS key-pair for SSH access to nodes | none | 17 | `kms-key-arn` | The ARN of the AWS KMS key for encrypting TLS assets | 18 | `no-record-set` | Instruct kube-aws to not manage Route53 record sets for your K8S API | `false` | 19 | `region` | The AWS region to deploy to | none | 20 | `s3-uri` | When your template is bigger than the [CloudFormation limit of 51,200 bytes](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cloudformation-limits.html), kube-aws needs to upload the template to S3 to perform the deploy/validate. The S3 location expressed as `s3://<bucket>/path/to/dir`. Most clusters will need this so it is mandatory. Multiple clusters can use the same S3 bucket. | none | 21 22 ### `init` example 23 24 ```bash 25 $ kube-aws init \ 26 --cluster-name=my-cluster \ 27 --region=us-west-1 \ 28 --availability-zone=us-west-1c \ 29 --hosted-zone-id=xxxxxxxxxxxxxx \ 30 --external-dns-name=my-cluster-endpoint.mydomain.com \ 31 --key-name=key-pair-name \ 32 --kms-key-arn="arn:aws:kms:us-west-1:xxxxxxxxxx:key/xxxxxxxxxxxxxxxxxxx" 33 --s3-uri=s3://my-kube-aws-assets-bucket 34 ``` 35 36 # `render credentials` 37 38 Render TLS credentials required for cluster administration and communication between cluster nodes. 39 40 | Flag | Description | Default | 41 | -- | -- | -- | 42 | `ca-cert-path` | Path to pem-encoded CA x509 certificate | `./credentials/ca.pem` | 43 | `ca-key-path` | Path to pem-encoded CA RSA key | `./credentials/ca-key.pem` | 44 | `generate-ca` | If generating credentials, generate root CA key and cert. **NOT RECOMMENDED FOR PRODUCTION USE**, use `-ca-key-path` and `-ca-cert-path` options to provide your own certificate authority assets. | `false` | 45 46 ### `render credentials` example 47 48 ```bash 49 $ kube-aws render credentials \ 50 --ca-cert-path=/path/to/ca-cert.pem 51 --ca-key-path=/path/to/ca-key.pem 52 ``` 53 54 # `render stack` 55 56 Render [CloudFormation](https://aws.amazon.com/cloudformation/) stack templates and [coreos-cloudinit](https://github.com/coreos/coreos-cloudinit) userdata ready for customization prior to deployment. 57 58 `render stack` has no CLI flags. 59 60 ### `render stack` example 61 62 ```bash 63 $ kube-aws render stack 64 ``` 65 66 # `show certificates` 67 68 Shows info about every certificate stored in `credentials` directory 69 70 `show certificates` has no CLI flags. 71 72 ```bash 73 $ kube-aws show certificates 74 ``` 75 76 # `validate` 77 78 Validate cluster assets prior to deployment. 79 80 | Flag | Description | Default | 81 | -- | -- | -- | 82 | `aws-debug` | Log debug information coming from the AWS SDK library | `false` | 83 | `profile` | Use AWS profile from credentials file | `empty` | 84 85 ### `validate` example 86 87 ```bash 88 $ kube-aws validate 89 ``` 90 91 # `kube-aws apply` 92 93 94 Deploy or Update an existing Kubernetes cluster that was created by kube-aws. 95 96 | Flag | Description | Default | 97 | -- | -- | -- | 98 | `aws-debug` | Log debug information coming from the AWS SDK library | `false` | 99 | `export` | Do not create cluster, instead export the CloudFormation stack file | `false` | 100 | `pretty-print` | Pretty print the resulting CloudFormation | `false` | 101 | `skip-wait` | Do not wait for the cluster components be ready before the CLI exits | `false` | 102 | `profile` | Use AWS profile from credentials file | `empty` | 103 104 ### `apply` example 105 106 ```bash 107 $ kube-aws apply 108 ``` 109 110 # `destroy` 111 112 Destroy an existing Kubernetes cluster that was created by kube-aws. 113 114 | Flag | Description | Default | 115 | -- | -- | -- | 116 | `aws-debug` | Log debug information coming from the AWS SDK library | `false` | 117 | `profile` | Use AWS profile from credentials file | `empty` | 118 119 ### `destroy` example 120 121 ```bash 122 $ kube-aws destory 123 ```