Skip to content

Commit f583ca6

Browse files
committed
Create new assembly and files for etcd overview
1 parent b94d57a commit f583ca6

File tree

2 files changed

+45
-1
lines changed

2 files changed

+45
-1
lines changed

etcd/etcd-overview.adoc

+24-1
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,27 @@ include::_attributes/common-attributes.adoc[]
44
= Overview of etcd
55
:context: etcd-overview
66

7-
// This assembly will contain modules to provide an overview of etcd.
7+
toc::[]
8+
9+
etcd (pronounced et-see-dee) is a consistent, distributed key-value store that stores small amounts of data across a cluster of machines that can fit entirely in memory. Although etcd is a core component of many projects, it is the primary data store for Kubernetes, which is the standard system for container orchestration.
10+
11+
By using etcd, you can benefit in several ways:
12+
13+
* Maintain consistent uptime for your cloud-native applications, and keep them working even if individual servers fail
14+
* Store and replicate all cluster states for Kubernetes
15+
* Distribute configuration data to offer redundancy and resiliency for the configuration of nodes
16+
17+
The etcd Operator creates and maintains highly-available etcd clusters on Kubernetes, allowing you to easily deploy and manage etcd clusters for your applications.
18+
19+
[IMPORTANT]
20+
====
21+
The default etcd configuration optimizes container orchestration. Use it as prescribed for the best experience.
22+
====
23+
24+
// How etcd works
25+
include::modules/how-etcd-works.adoc[leveloffset=+1]
26+
27+
// [role="_additional-resources"]
28+
// .Additional resources
29+
// * xref:../etcd-practices.adoc#etcd-practices[Recommended etcd practices]
30+
// * xref:../etcd-backup.adoc#etcd-backup[Backing up and restoring etcd data]

modules/how-etcd-works.adoc

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
// Module included in the following assemblies:
2+
// * etcd/etcd-overview.adoc
3+
4+
:_mod-docs-content-type: CONCEPT
5+
[id="how-etcd-works_{context}"]
6+
= How etcd works
7+
8+
To ensure a reliable approach to cluster configuration and management, etcd uses the etcd Operator. The Operator simplifies the use of etcd on a Kubernetes container platform such as {product-title}. With the etcd Operator, you can complete the following tasks:
9+
10+
* Create or delete etcd members
11+
* Resize clusters
12+
* Perform backups
13+
* Upgrade etcd
14+
15+
Additionally, use the etcd Operator to deploy and manage etcd clusters for your applications. The etcd Operator:
16+
17+
* Observes the cluster state by using the Kubernetes API.
18+
* Analyzes differences between the current state and the desired state.
19+
* Corrects the differences through the etcd cluster management APIs, the Kubernetes API, or both.
20+
21+
etcd holds the cluster state, which is constantly updated. This state is continuously persisted, which leads to a high number of small changes at high frequency. As a result, it is critical to back up the etcd cluster member with fast, low-latency I/O. For more information about best practices for etcd, see _Recommended etcd practices_.

0 commit comments

Comments
 (0)