forked from etcd-io/etcd
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: revising to match sidebar structure.
- Loading branch information
Showing
1 changed file
with
63 additions
and
148 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,170 +1,85 @@ | ||
| **This is the documentation for etcd2 releases. Read [etcd3 doc][v3-docs] for etcd3 releases.** | ||
| # Documentation | ||
|
|
||
| [v3-docs]: ../docs.md#documentation | ||
| etcd is a distributed key-value store designed to reliably and quickly preserve and provide access to critical data. It enables reliable distributed coordination through distributed locking, leader elections, and write barriers. An etcd cluster is intended for high availability and permanent data storage and retrieval. | ||
|
|
||
| This is the etcd v2 documentation set. For more recent versions, please see the [etcd v3 guides][etcd-v3]. | ||
|
|
||
| # etcd2 | ||
| ## Communicating with etcd v2 | ||
|
|
||
| [](https://goreportcard.com/report/github.com/coreos/etcd) | ||
| [](https://travis-ci.org/coreos/etcd) | ||
| [](https://semaphoreci.com/coreos/etcd) | ||
| [](https://quay.io/repository/coreos/etcd-git) | ||
| Reading and writing into the etcd keyspace is done via a simple, RESTful HTTP API, or using language-specific libraries that wrap the HTTP API with higher level primitives. | ||
|
|
||
| **Note**: The `master` branch may be in an *unstable or even broken state* during development. Please use [releases][github-release] instead of the `master` branch in order to get stable binaries. | ||
| ### Reading and Writing | ||
|
|
||
|  | ||
| - [Client API Documentation][api] | ||
| - [Libraries, Tools, and Language Bindings][libraries] | ||
| - [Admin API Documentation][admin-api] | ||
| - [Members API][members-api] | ||
|
|
||
| etcd is a distributed, consistent key-value store for shared configuration and service discovery, with a focus on being: | ||
| ### Security, Auth, Access control | ||
|
|
||
| * *Simple*: curl'able user-facing API (HTTP+JSON) | ||
| * *Secure*: optional SSL client cert authentication | ||
| * *Fast*: benchmarked 1000s of writes/s per instance | ||
| * *Reliable*: properly distributed using Raft | ||
| - [Security Model][security] | ||
| - [Auth and Security][auth_api] | ||
| - [Authentication Guide][authentication] | ||
|
|
||
| etcd is written in Go and uses the [Raft][raft] consensus algorithm to manage a highly-available replicated log. | ||
| ## etcd v2 Cluster Administration | ||
|
|
||
| etcd is used [in production by many companies](./production-users.md), and the development team stands behind it in critical deployment scenarios, where etcd is frequently teamed with applications such as [Kubernetes][k8s], [fleet][fleet], [locksmith][locksmith], [vulcand][vulcand], and many others. | ||
| Configuration values are distributed within the cluster for your applications to read. Values can be changed programmatically and smart applications can reconfigure automatically. You'll never again have to run a configuration management tool on every machine in order to change a single config value. | ||
|
|
||
| See [etcdctl][etcdctl] for a simple command line client. | ||
| Or feel free to just use `curl`, as in the examples below. | ||
| ### General Info | ||
|
|
||
| [raft]: https://raft.github.io/ | ||
| [k8s]: http://kubernetes.io/ | ||
| [fleet]: https://github.com/coreos/fleet | ||
| [locksmith]: https://github.com/coreos/locksmith | ||
| [vulcand]: https://github.com/vulcand/vulcand | ||
| [etcdctl]: https://github.com/coreos/etcd/tree/master/etcdctl | ||
| - [etcd Proxies][proxy] | ||
| - [Production Users][production-users] | ||
| - [Admin Guide][admin_guide] | ||
| - [Configuration Flags][configuration] | ||
| - [Frequently Asked Questions][faq] | ||
|
|
||
| ## Getting Started | ||
| ### Initial Setup | ||
|
|
||
| ### Getting etcd | ||
| - [Tuning etcd Clusters][tuning] | ||
| - [Discovery Service Protocol][discovery_protocol] | ||
| - [Running etcd under Docker][docker_guide] | ||
|
|
||
| The easiest way to get etcd is to use one of the pre-built release binaries which are available for OSX, Linux, Windows, AppC (ACI), and Docker. Instructions for using these binaries are on the [GitHub releases page][github-release]. | ||
| ### Live Reconfiguration | ||
|
|
||
| For those wanting to try the very latest version, you can build the latest version of etcd from the `master` branch. | ||
| You will first need [*Go*](https://golang.org/) installed on your machine (version 1.5+ is required). | ||
| All development occurs on `master`, including new features and bug fixes. | ||
| Bug fixes are first targeted at `master` and subsequently ported to release branches, as described in the [branch management][branch-management] guide. | ||
| - [Runtime Configuration][runtime-configuration] | ||
|
|
||
| [github-release]: https://github.com/coreos/etcd/releases/ | ||
| [branch-management]: branch_management.md | ||
| ### Debugging etcd | ||
|
|
||
| ### Running etcd | ||
| - [Metrics Collection][metrics] | ||
| - [Error Code][errorcode] | ||
| - [Reporting Bugs][reporting_bugs] | ||
|
|
||
| First start a single-member cluster of etcd: | ||
| ### Migration | ||
|
|
||
| ```sh | ||
| ./bin/etcd | ||
| ``` | ||
| - [Upgrade etcd to 2.3][upgrade_2_3] | ||
| - [Upgrade etcd to 2.2][upgrade_2_2] | ||
| - [Upgrade to etcd 2.1][upgrade_2_1] | ||
| - [Snapshot Migration (0.4.x to 2.x)][04_to_2_snapshot_migration] | ||
| - [Backward Compatibility][backward_compatibility] | ||
|
|
||
| This will bring up etcd listening on port 2379 for client communication and on port 2380 for server-to-server communication. | ||
|
|
||
| Next, let's set a single key, and then retrieve it: | ||
|
|
||
| ``` | ||
| curl -L http://127.0.0.1:2379/v2/keys/mykey -XPUT -d value="this is awesome" | ||
| curl -L http://127.0.0.1:2379/v2/keys/mykey | ||
| ``` | ||
|
|
||
| You have successfully started an etcd and written a key to the store. | ||
|
|
||
| ### etcd TCP ports | ||
|
|
||
| The [official etcd ports][iana-ports] are 2379 for client requests, and 2380 for peer communication. To maintain compatibility, some etcd configuration and documentation continues to refer to the legacy ports 4001 and 7001, but all new etcd use and discussion should adopt the IANA-assigned ports. The legacy ports 4001 and 7001 will be fully deprecated, and support for their use removed, in future etcd releases. | ||
|
|
||
| [iana-ports]: http://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.txt | ||
|
|
||
| ### Running local etcd cluster | ||
|
|
||
| First install [goreman](https://github.com/mattn/goreman), which manages Procfile-based applications. | ||
|
|
||
| Our [Procfile script](../../V2Procfile) will set up a local example cluster. You can start it with: | ||
|
|
||
| ```sh | ||
| goreman start | ||
| ``` | ||
|
|
||
| This will bring up 3 etcd members `infra1`, `infra2` and `infra3` and etcd proxy `proxy`, which runs locally and composes a cluster. | ||
|
|
||
| You can write a key to the cluster and retrieve the value back from any member or proxy. | ||
|
|
||
| ### Next Steps | ||
|
|
||
| Now it's time to dig into the full etcd API and other guides. | ||
|
|
||
| - Explore the full [API][api]. | ||
| - Set up a [multi-machine cluster][clustering]. | ||
| - Learn the [config format, env variables and flags][configuration]. | ||
| - Find [language bindings and tools][libraries-and-tools]. | ||
| - Use TLS to [secure an etcd cluster][security]. | ||
| - [Tune etcd][tuning]. | ||
| - [Upgrade from 0.4.9+ to 2.2.0][upgrade]. | ||
|
|
||
| [api]: ./api.md | ||
| [clustering]: ./clustering.md | ||
| [configuration]: ./configuration.md | ||
| [libraries-and-tools]: ./libraries-and-tools.md | ||
| [security]: ./security.md | ||
| [tuning]: ./tuning.md | ||
| [upgrade]: ./04_to_2_snapshot_migration.md | ||
|
|
||
| ## Contact | ||
|
|
||
| - Mailing list: [etcd-dev](https://groups.google.com/forum/?hl=en#!forum/etcd-dev) | ||
| - IRC: #[etcd](irc://irc.freenode.org:6667/#etcd) on freenode.org | ||
| - Planning/Roadmap: [milestones](https://github.com/coreos/etcd/milestones), [roadmap](../../ROADMAP.md) | ||
| - Bugs: [issues](https://github.com/coreos/etcd/issues) | ||
|
|
||
| ## Contributing | ||
|
|
||
| See [CONTRIBUTING](../../CONTRIBUTING.md) for details on submitting patches and the contribution workflow. | ||
|
|
||
| ## Reporting bugs | ||
|
|
||
| See [reporting bugs](reporting_bugs.md) for details about reporting any issue you may encounter. | ||
|
|
||
| ## Known bugs | ||
|
|
||
| [GH518](https://github.com/coreos/etcd/issues/518) is a known bug. Issue is that: | ||
|
|
||
| ``` | ||
| curl http://127.0.0.1:2379/v2/keys/foo -XPUT -d value=bar | ||
| curl http://127.0.0.1:2379/v2/keys/foo -XPUT -d dir=true -d prevExist=true | ||
| ``` | ||
|
|
||
| If the previous node is a key and client tries to overwrite it with `dir=true`, it does not give warnings such as `Not a directory`. Instead, the key is set to empty value. | ||
|
|
||
| ## Project Details | ||
|
|
||
| ### Versioning | ||
|
|
||
| #### Service Versioning | ||
|
|
||
| etcd uses [semantic versioning](http://semver.org) | ||
| New minor versions may add additional features to the API. | ||
|
|
||
| You can get the version of etcd by issuing a request to /version: | ||
|
|
||
| ```sh | ||
| curl -L http://127.0.0.1:2379/version | ||
| ``` | ||
|
|
||
| #### API Versioning | ||
|
|
||
| The `v2` API responses should not change after the 2.0.0 release but new features will be added over time. | ||
|
|
||
| #### 32-bit and other unsupported systems | ||
|
|
||
| etcd has known issues on 32-bit systems due to a bug in the Go runtime. See #[358][358] for more information. | ||
|
|
||
| To avoid inadvertently running a possibly unstable etcd server, `etcd` on unsupported architectures will print | ||
| a warning message and immediately exit if the environment variable `ETCD_UNSUPPORTED_ARCH` is not set to | ||
| the target architecture. | ||
|
|
||
| Currently only the amd64 architecture is officially supported by `etcd`. | ||
|
|
||
| [358]: https://github.com/coreos/etcd/issues/358 | ||
|
|
||
| ### License | ||
|
|
||
| etcd is under the Apache 2.0 license. See the [LICENSE](../../LICENSE) file for details. | ||
| [etcd-v3]: ../docs.md | ||
| [api]: api.md | ||
| [libraries]: libraries-and-tools.md | ||
| [admin-api]: other_apis.md | ||
| [members-api]: members_api.md | ||
| [security]: security.md | ||
| [auth_api]: auth_api.md | ||
| [authentication]: authentication.md | ||
| [proxy]: proxy.md | ||
| [production-users]: production-users.md | ||
| [admin_guide]: admin_guide.md | ||
| [configuration]: configuration.md | ||
| [faq]: faq.md | ||
| [tuning]: tuning.md | ||
| [discovery_protocol]: discovery_protocol.md | ||
| [docker_guide]: docker_guide.md | ||
| [runtime-configuration]: runtime-configuration.md | ||
| [metrics]: metrics.md | ||
| [errorcode]: errorcode.md | ||
| [reporting_bugs]: reporting_bugs.md | ||
| [upgrade_2_3]: upgrade_2_3.md | ||
| [upgrade_2_2]: upgrade_2_2.md | ||
| [upgrade_2_1]: upgrade_2_1.md | ||
| [04_to_2_snapshot_migration]: 04_to_2_snapshot_migration.md | ||
| [backward_compatibility]: backward_compatibility.md |