Name | Date | Size | #Lines | LOC | ||
---|---|---|---|---|---|---|
.. | 28-Mar-2021 | - | ||||
benchmarks/ | H | 28-Mar-2021 | - | 508 | 370 | |
dev-guide/ | H | 28-Mar-2021 | - | 4,522 | 3,863 | |
dev-internal/ | H | 28-Mar-2021 | - | 272 | 179 | |
learning/ | H | 28-Mar-2021 | - | 878 | 614 | |
op-guide/ | H | 03-May-2022 | - | 3,805 | 3,031 | |
platforms/ | H | 28-Mar-2021 | - | 342 | 245 | |
rfc/ | H | 28-Mar-2021 | - | 217 | 181 | |
upgrades/ | H | 28-Mar-2021 | - | 1,288 | 881 | |
README.md | H A D | 28-Mar-2021 | 4.3 KiB | 119 | 97 | |
_index.md | H A D | 28-Mar-2021 | 35 | 4 | 3 | |
branch_management.md | H A D | 28-Mar-2021 | 1.3 KiB | 29 | 17 | |
demo.md | H A D | 28-Mar-2021 | 13.1 KiB | 457 | 338 | |
dl_build.md | H A D | 28-Mar-2021 | 2.2 KiB | 70 | 48 | |
docs.md | H A D | 28-Mar-2021 | 4.3 KiB | 119 | 97 | |
faq.md | H A D | 28-Mar-2021 | 15.5 KiB | 154 | 91 | |
integrations.md | H A D | 28-Mar-2021 | 9.1 KiB | 161 | 115 | |
metrics.md | H A D | 28-Mar-2021 | 8.5 KiB | 118 | 75 | |
production-users.md | H A D | 28-Mar-2021 | 9.3 KiB | 242 | 182 | |
reporting_bugs.md | H A D | 28-Mar-2021 | 2.3 KiB | 48 | 29 | |
tuning.md | H A D | 28-Mar-2021 | 5.6 KiB | 85 | 54 |
README.md
1# Documentation 2 3etcd 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. 4 5## Getting started 6 7New etcd users and developers should get started by [downloading and building][download_build] etcd. After getting etcd, follow this [quick demo][demo] to see the basics of creating and working with an etcd cluster. 8 9## Developing with etcd 10 11The easiest way to get started using etcd as a distributed key-value store is to [set up a local cluster][local_cluster]. 12 13 - [Setting up local clusters][local_cluster] 14 - [Interacting with etcd][interacting] 15 - gRPC [etcd core][api_ref] and [etcd concurrency][api_concurrency_ref] API references 16 - [HTTP JSON API through the gRPC gateway][api_grpc_gateway] 17 - [gRPC naming and discovery][grpc_naming] 18 - [Client][namespace_client] and [proxy][namespace_proxy] namespacing 19 - [Embedding etcd][embed_etcd] 20 - [Experimental features and APIs][experimental] 21 - [System limits][system-limit] 22 23## Operating etcd clusters 24 25Administrators who need to create reliable and scalable key-value stores for the developers they support should begin with a [cluster on multiple machines][clustering]. 26 27 - [Setting up etcd clusters][clustering] 28 - [Setting up etcd gateways][gateway] 29 - [Setting up etcd gRPC proxy][grpc_proxy] 30 - [Hardware recommendations][hardware] 31 - [Configuration][conf] 32 - [Security][security] 33 - [Authentication][authentication] 34 - [Monitoring][monitoring] 35 - [Maintenance][maintenance] 36 - [Understand failures][failures] 37 - [Disaster recovery][recovery] 38 - [Performance][performance] 39 - [Versioning][versioning] 40 41### Platform guides 42 43 - [Supported systems][supported_platforms] 44 - [Docker container][container_docker] 45 - [Container Linux, systemd][container_linux_platform] 46 - [rkt container][container_rkt] 47 - [Amazon Web Services][aws_platform] 48 - [FreeBSD][freebsd_platform] 49 50### Security 51 52 - [TLS][security] 53 - [Role-based access control][authentication] 54 55### Maintenance and troubleshooting 56 57 - [Frequently asked questions][common questions] 58 - [Monitoring][monitoring] 59 - [Maintenance][maintenance] 60 - [Failure modes][failures] 61 - [Disaster recovery][recovery] 62 - [Upgrading][upgrading] 63 64## Learning 65 66To learn more about the concepts and internals behind etcd, read the following pages: 67 68 - [Why etcd?][why] 69 - [Understand data model][data_model] 70 - [Understand APIs][understand_apis] 71 - [Glossary][glossary] 72 - Internals 73 - [Auth subsystem][auth_design] 74 75## Frequently Asked Questions (FAQ) 76 77Answers to [common questions] about etcd. 78 79[api_ref]: dev-guide/api_reference_v3.md 80[api_concurrency_ref]: dev-guide/api_concurrency_reference_v3.md 81[api_grpc_gateway]: dev-guide/api_grpc_gateway.md 82[clustering]: op-guide/clustering.md 83[conf]: op-guide/configuration.md 84[system-limit]: dev-guide/limit.md 85[common questions]: faq.md 86[why]: learning/why.md 87[data_model]: learning/data_model.md 88[demo]: demo.md 89[download_build]: dl_build.md 90[embed_etcd]: https://godoc.org/github.com/coreos/etcd/embed 91[grpc_naming]: dev-guide/grpc_naming.md 92[failures]: op-guide/failures.md 93[gateway]: op-guide/gateway.md 94[glossary]: learning/glossary.md 95[namespace_client]: https://godoc.org/github.com/coreos/etcd/clientv3/namespace 96[namespace_proxy]: op-guide/grpc_proxy.md#namespacing 97[grpc_proxy]: op-guide/grpc_proxy.md 98[hardware]: op-guide/hardware.md 99[interacting]: dev-guide/interacting_v3.md 100[local_cluster]: dev-guide/local_cluster.md 101[performance]: op-guide/performance.md 102[recovery]: op-guide/recovery.md 103[maintenance]: op-guide/maintenance.md 104[security]: op-guide/security.md 105[monitoring]: op-guide/monitoring.md 106[v2_migration]: op-guide/v2-migration.md 107[container_rkt]: op-guide/container.md#rkt 108[container_docker]: op-guide/container.md#docker 109[understand_apis]: learning/api.md 110[versioning]: op-guide/versioning.md 111[supported_platforms]: op-guide/supported-platform.md 112[container_linux_platform]: platforms/container-linux-systemd.md 113[freebsd_platform]: platforms/freebsd.md 114[aws_platform]: platforms/aws.md 115[experimental]: dev-guide/experimental_apis.md 116[authentication]: op-guide/authentication.md 117[auth_design]: learning/auth_design.md 118[upgrading]: upgrades/upgrading-etcd.md 119