github
/
k3s
mirror of https://github.com/k3s-io/k3s
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
k3s/cluster/aws/options.md

55 lines
2.1 KiB
Markdown
Raw Normal View History

Initial WIP on documenting options for AWS clusters Very incomplete, but a start.
2015-03-12 17:49:07 +00:00
# AWS specific configuration options
These options can be set as environment variables to customize how your cluster is created. Only options
More options documentation
2015-03-19 17:05:31 +00:00
specific to AWS are documented here, for cross-provider options see [this document](../options.md).
Initial WIP on documenting options for AWS clusters Very incomplete, but a start.
2015-03-12 17:49:07 +00:00
This is a work-in-progress; not all options are documented yet!
Change AWS_ZONE to ZONE, for compatibility with e2e tests
2015-03-27 15:53:17 +00:00
## ZONE
Fix AWS region vs zone We were specifying a region, but naming it as a zone in util.sh The zone matters just as much as the region, e.g. for EBS volumes. We also change the config to require a Zone, not a Region. But we fallback to get the information from the metadata service.
2015-03-26 19:47:49 +00:00
Fix typo in docs
2015-03-30 13:01:00 +00:00
The AWS availability zone to deploy to. Defaults to us-west-2a.
Fix AWS region vs zone We were specifying a region, but naming it as a zone in util.sh The zone matters just as much as the region, e.g. for EBS volumes. We also change the config to require a Zone, not a Region. But we fallback to get the information from the metadata service.
2015-03-26 19:47:49 +00:00
Initial WIP on documenting options for AWS clusters Very incomplete, but a start.
2015-03-12 17:49:07 +00:00
## AWS_IMAGE
The AMI to use. If not specified, the image will be selected based on the AWS region.
More options documentation
2015-03-19 17:05:31 +00:00
**AWS_S3_BUCKET**, **AWS_S3_REGION**
Initial WIP on documenting options for AWS clusters Very incomplete, but a start.
2015-03-12 17:49:07 +00:00
The bucket name to use, and the region where the bucket should be created, or where the bucket is located if it exists already.
If not specified, defaults to AWS_S3_REGION us-east-1, because buckets are globally named and you probably
want to share a bucket across all regions; us-east-1 is a sensible (relatively arbitrary) default.
AWS_S3_BUCKET will default to a uniquely generated name, so you won't collide with other kubernetes users.
(Currently this uses the hash of your AWS Access key to produce a per-user unique value).
It is not a bad idea to set AWS_S3_BUCKET to something more human friendly.
AWS_S3_REGION is useful for people that want to control their data location, because of regulatory restrictions for example.
More options documentation
2015-03-19 17:05:31 +00:00
**MASTER_SIZE**, **MINION_SIZE**
The instance type to use for creating the master/minion. Defaults to t2.micro.
For production usage, we recommend bigger instances, for example:
```
export MASTER_SIZE=c4.large
export MINION_SIZE=r3.large
AWS: added docs for KUBE_ENABLE_MINION_PUBLIC_IP option
2015-05-08 14:56:06 +00:00
```
**KUBE_ENABLE_MINION_PUBLIC_IP**
Should a public IP automatically assigned to the minions? "true" or "false"
Defaults to: "true"
Please note: Do not set this to "false" unless you...
- ... already configured a NAT instance in the kubernetes VPC that will enable internet access for the new minions
- ... already configured a route for "0.0.0.0/0" to this NAT instance
- ... already configured a route for "YOUR_IP/32" to an AWS internet gateway (for the master instance to reach your
client directly during setup)
Add ga-beacon analytics to gendocs scripts hack/run-gendocs.sh puts ga-beacon analytics link into all md files, hack/verify-gendocs.sh verifies presence of link.
2015-05-14 22:12:45 +00:00
[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/cluster/aws/options.md?pixel)]()