mirror of https://github.com/k3s-io/k3s
84 lines
3.0 KiB
Markdown
84 lines
3.0 KiB
Markdown
<!-- BEGIN MUNGE: UNVERSIONED_WARNING -->
|
|
|
|
<!-- BEGIN STRIP_FOR_RELEASE -->
|
|
|
|
<img src="http://kubernetes.io/img/warning.png" alt="WARNING"
|
|
width="25" height="25">
|
|
<img src="http://kubernetes.io/img/warning.png" alt="WARNING"
|
|
width="25" height="25">
|
|
<img src="http://kubernetes.io/img/warning.png" alt="WARNING"
|
|
width="25" height="25">
|
|
<img src="http://kubernetes.io/img/warning.png" alt="WARNING"
|
|
width="25" height="25">
|
|
<img src="http://kubernetes.io/img/warning.png" alt="WARNING"
|
|
width="25" height="25">
|
|
|
|
<h2>PLEASE NOTE: This document applies to the HEAD of the source tree</h2>
|
|
|
|
If you are using a released version of Kubernetes, you should
|
|
refer to the docs that go with that version.
|
|
|
|
<strong>
|
|
The latest 1.0.x release of this document can be found
|
|
[here](http://releases.k8s.io/release-1.0/docs/admin/etcd.md).
|
|
|
|
Documentation for other releases can be found at
|
|
[releases.k8s.io](http://releases.k8s.io).
|
|
</strong>
|
|
--
|
|
|
|
<!-- END STRIP_FOR_RELEASE -->
|
|
|
|
<!-- END MUNGE: UNVERSIONED_WARNING -->
|
|
|
|
# etcd
|
|
|
|
[etcd](https://coreos.com/etcd/docs/2.0.12/) is a highly-available key value
|
|
store which Kubernetes uses for persistent storage of all of its REST API
|
|
objects.
|
|
|
|
## Configuration: high-level goals
|
|
|
|
Access Control: give *only* kube-apiserver read/write access to etcd. You do not
|
|
want apiserver's etcd exposed to every node in your cluster (or worse, to the
|
|
internet at large), because access to etcd is equivilent to root in your
|
|
cluster.
|
|
|
|
Data Reliability: for reasonable safety, either etcd needs to be run as a
|
|
[cluster](high-availability.md#clustering-etcd) (multiple machines each running
|
|
etcd) or etcd's data directory should be located on durable storage (e.g., GCE's
|
|
persistent disk). In either case, if high availability is required--as it might
|
|
be in a production cluster--the data directory ought to be [backed up
|
|
periodically](https://coreos.com/etcd/docs/2.0.12/admin_guide.html#disaster-recovery),
|
|
to reduce downtime in case of corruption.
|
|
|
|
## Default configuration
|
|
|
|
The default setup scripts use kubelet's file-based static pods feature to run etcd in a
|
|
[pod](http://releases.k8s.io/HEAD/cluster/saltbase/salt/etcd/etcd.manifest). This manifest should only
|
|
be run on master VMs. The default location that kubelet scans for manifests is
|
|
`/etc/kubernetes/manifests/`.
|
|
|
|
## Kubernetes's usage of etcd
|
|
|
|
By default, Kubernetes objects are stored under the `/registry` key in etcd.
|
|
This path can be prefixed by using the [kube-apiserver](kube-apiserver.md) flag
|
|
`--etcd-prefix="/foo"`.
|
|
|
|
`etcd` is the only place that Kubernetes keeps state.
|
|
|
|
## Troubleshooting
|
|
|
|
To test whether `etcd` is running correctly, you can try writing a value to a
|
|
test key. On your master VM (or somewhere with firewalls configured such that
|
|
you can talk to your cluster's etcd), try:
|
|
|
|
```sh
|
|
curl -fs -X PUT "http://${host}:${port}/v2/keys/_test"
|
|
```
|
|
|
|
|
|
<!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
|
|
[]()
|
|
<!-- END MUNGE: GENERATED_ANALYTICS -->
|