Document etcd volume options

This commit adds documentation around the options for the etcd volumes:
volumeType and volumeIops, in addition to the already existing documentation for
volumeSize

Fixes https://github.com/kubernetes/kops/issues/4557
This commit is contained in:
Vlad Ionescu 2018-11-02 16:01:30 +02:00
parent e5b2b9eddb
commit b2b07cf045
No known key found for this signature in database
GPG Key ID: 2D9C4486A1602F1C
1 changed files with 7 additions and 3 deletions

View File

@ -85,19 +85,23 @@ etcdClusters:
> __Note:__ The images for etcd that kops uses are from the Google Cloud Repository. Google doesn't release every version of etcd to the gcr. Check that the version of etcd you want to use is available [at the gcr](https://console.cloud.google.com/gcr/images/google-containers/GLOBAL/etcd?gcrImageListsize=50) before using it in your cluster spec.
By default, the Volumes created for the etcd clusters are 20GB each. They can be adjusted via the `volumeSize` parameter.
By default, the Volumes created for the etcd clusters are `gp2` and 20GB each. The volume size, type and Iops( for `io1`) can be configured via their parameters. Conversion between `gp2` and `io1` is not supported, nor are size changes.
```yaml
etcdClusters:
- etcdMembers:
- instanceGroup: master-us-east-1a
name: a
volumeSize: 5
volumeType: gp2
volumeSize: 20
name: main
- etcdMembers:
- instanceGroup: master-us-east-1a
name: a
volumeSize: 5
volumeType: io1
# WARNING: bear in mind that the Iops to volume size ratio has a maximum of 50 on AWS!
volumeIops: 100
volumeSize: 21
name: events
```