forked from kubernetes/website
-
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.
Merge pull request kubernetes#57 from lucperkins/lperkins/v2
Make separate docs version for v2
- Loading branch information
Showing
48 changed files
with
6,479 additions
and
2 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
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 |
---|---|---|
@@ -0,0 +1,37 @@ | ||
--- | ||
title: Snapshot Migration | ||
--- | ||
|
||
**This is the documentation for etcd2 releases. Read [etcd3 doc][v3-docs] for etcd3 releases.** | ||
|
||
[v3-docs]: ../docs.md#documentation | ||
|
||
You can migrate a snapshot of your data from a v0.4.9+ cluster into a new etcd 2.2 cluster using a snapshot migration. After snapshot migration, the etcd indexes of your data will change. Many etcd applications rely on these indexes to behave correctly. This operation should only be done while all etcd applications are stopped. | ||
|
||
To get started get the newest data snapshot from the 0.4.9+ cluster: | ||
|
||
``` | ||
curl http://cluster.example.com:4001/v2/migration/snapshot > backup.snap | ||
``` | ||
|
||
Now, import the snapshot into your new cluster: | ||
|
||
``` | ||
etcdctl --endpoint new_cluster.example.com import --snap backup.snap | ||
``` | ||
|
||
If you have a large amount of data, you can specify more concurrent works to copy data in parallel by using `-c` flag. | ||
If you have hidden keys to copy, you can use `--hidden` flag to specify. For example fleet uses `/_coreos.com/fleet` so to import those keys use `--hidden /_coreos.com`. | ||
|
||
And the data will quickly copy into the new cluster: | ||
|
||
``` | ||
entering dir: / | ||
entering dir: /foo | ||
entering dir: /foo/bar | ||
copying key: /foo/bar/1 1 | ||
entering dir: / | ||
entering dir: /foo2 | ||
entering dir: /foo2/bar2 | ||
copying key: /foo2/bar2/2 2 | ||
``` |
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 |
---|---|---|
@@ -0,0 +1,87 @@ | ||
--- | ||
title: 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]. | ||
|
||
## Communicating with etcd v2 | ||
|
||
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. | ||
|
||
### Reading and Writing | ||
|
||
- [Client API Documentation][api] | ||
- [Libraries, Tools, and Language Bindings][libraries] | ||
- [Admin API Documentation][admin-api] | ||
- [Members API][members-api] | ||
|
||
### Security, Auth, Access control | ||
|
||
- [Security Model][security] | ||
- [Auth and Security][auth_api] | ||
- [Authentication Guide][authentication] | ||
|
||
## etcd v2 Cluster Administration | ||
|
||
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. | ||
|
||
### General Info | ||
|
||
- [etcd Proxies][proxy] | ||
- [Production Users][production-users] | ||
- [Admin Guide][admin_guide] | ||
- [Configuration Flags][configuration] | ||
- [Frequently Asked Questions][faq] | ||
|
||
### Initial Setup | ||
|
||
- [Tuning etcd Clusters][tuning] | ||
- [Discovery Service Protocol][discovery_protocol] | ||
- [Running etcd under Docker][docker_guide] | ||
|
||
### Live Reconfiguration | ||
|
||
- [Runtime Configuration][runtime-configuration] | ||
|
||
### Debugging etcd | ||
|
||
- [Metrics Collection][metrics] | ||
- [Error Code][errorcode] | ||
- [Reporting Bugs][reporting_bugs] | ||
|
||
### Migration | ||
|
||
- [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] | ||
|
||
|
||
[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 |
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 |
---|---|---|
@@ -0,0 +1,5 @@ | ||
--- | ||
title: etcd version 2 | ||
--- | ||
|
||
These docs cover everything from setting up and running an etcd cluster to using etcd in your applications. Improvements to these docs are encouraged through [pull requests](https://help.github.com/en/articles/about-pull-requests) to the [etcd project](https://github.com/etcd-io/etcd) on GitHub. |
Oops, something went wrong.