Skip to content

Commit

Permalink
Mention minimum etcd versions (#10208)
Browse files Browse the repository at this point in the history
  • Loading branch information
erictune authored and k8s-ci-robot committed Sep 10, 2018
1 parent 53b5165 commit 726ce50
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 8 deletions.
11 changes: 3 additions & 8 deletions content/en/docs/setup/scratch.md
Original file line number Diff line number Diff line change
Expand Up @@ -194,18 +194,13 @@ You have several choices for Kubernetes images:
- You can verify if the image is loaded successfully with the right repository and tag using
command like `docker images`

For etcd, you can:

- Use images hosted on Google Container Registry (GCR), such as `k8s.gcr.io/etcd:2.2.1`
- Use images hosted on [Docker Hub](https://hub.docker.com/search/?q=etcd) or [Quay.io](https://quay.io/repository/coreos/etcd), such as `quay.io/coreos/etcd:v2.2.1`
- Use etcd binary included in your OS distro.
- Build your own image
- You can do: `cd kubernetes/cluster/images/etcd; make`

We recommend that you use the etcd version which is provided in the Kubernetes binary distribution. The Kubernetes binaries in the release
were tested extensively with this version of etcd and not with any other version.
The recommended version number can also be found as the value of `TAG` in `kubernetes/cluster/images/etcd/Makefile`.

For the miniumum recommended version of etcd, please refer to
[Configuring and Updating etcd](/docs/tasks/administer-cluster/configure-upgrade-etcd/)

The remainder of the document assumes that the image identifiers have been chosen and stored in corresponding env vars. Examples (replace with latest tags and appropriate registry):

- `HYPERKUBE_IMAGE=k8s.gcr.io/hyperkube:$TAG`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,8 @@ content_template: templates/task

* Keeping stable etcd clusters is critical to the stability of Kubernetes clusters. Therefore, run etcd clusters on dedicated machines or isolated environments for [guaranteed resource requirements](https://github.com/coreos/etcd/blob/master/Documentation/op-guide/hardware.md#hardware-recommendations).

* The minimum recommended version of etcd to run in production is `3.2.10+`.

## Resource requirements

Operating etcd with limited resources is suitable only for testing purposes. For deploying in production, advanced hardware configuration is required. Before deploying etcd in production, see [resource requirement reference documentation](https://github.com/coreos/etcd/blob/master/Documentation/op-guide/hardware.md#example-hardware-configurations).
Expand Down Expand Up @@ -388,6 +390,8 @@ TARGET_VERSION=2.2.1
STORAGE_MEDIA_TYPE=application/json
```

** Note: this upgrade procedure is for getting from 2.x to 3.x. Version `3.0.17` is not recommended for running in production (see [prerequisites](#prereqisites) for minimum recommended etcd versions.

## Notes for etcd Version 2.2.1

### Default configuration
Expand Down

0 comments on commit 726ce50

Please sign in to comment.