Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Mention minimum etcd versions #10208

Merged
merged 1 commit into from
Sep 10, 2018
Merged

Mention minimum etcd versions #10208

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 3 additions & 8 deletions content/en/docs/setup/scratch.md
View file
Open in desktop
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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@erictune 👋 Thanks for making these updates! For future reference, omit "please" per the style guide.

/cc @tengqm

[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
4 changes: 4 additions & 0 deletions content/en/docs/tasks/administer-cluster/configure-upgrade-etcd.md
View file
Open in desktop
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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great!

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why single out 3.0.17? The guidance I had been seeing previously said just get it above 3.0.10. https://groups.google.com/forum/#!topic/etcd-dev/nZQl17RjxHQ dumps on all of 3.0 --- and more emphatically than I am seeing here. Somewhere there should be maintained an evergreen doc for general etcd use like https://groups.google.com/forum/#!topic/etcd-dev/nZQl17RjxHQ

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just saying 3.0 here sounds fine.

@MikeSpreitzer For the evergreen doc, that would be for the etcd docs? We should probably move discussion to github.com/etcd-io/etcd.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, @jpbetz , I think the etcd docs should include a maintained statement like what you sent out in email.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't want to change the tested upgrade procedure.
I updated the advice to not single out 3.0.17, and just suggest further upgrading to the recommended version of etcd.


## Notes for etcd Version 2.2.1

### Default configuration
Expand Down