etcd-io · spzala · Dec 23, 2020 · Dec 4, 2020
diff --git a/Documentation/benchmarks/_index.md b/Documentation/benchmarks/_index.md
@@ -1,4 +1,5 @@
 ---
 title: Benchmarks
 weight: 5000
+description: Performance measures for etcd
 ---
diff --git a/Documentation/benchmarks/etcd-2-1-0-alpha-benchmarks.md b/Documentation/benchmarks/etcd-2-1-0-alpha-benchmarks.md
@@ -1,5 +1,7 @@
 ---
 title: Benchmarking etcd v2.1.0
+weight: 5875
+description: Performance measures for etcd v2.1.0
 ---
 
 ## Physical machines

diff --git a/Documentation/benchmarks/etcd-2-2-0-benchmarks.md b/Documentation/benchmarks/etcd-2-2-0-benchmarks.md
@@ -1,5 +1,7 @@
 ---
 title: Benchmarking etcd v2.2.0
+weight: 5750
+description: Performance measures for etcd v2.2.0
 ---
 
 ## Physical Machines

diff --git a/Documentation/benchmarks/etcd-2-2-0-rc-benchmarks.md b/Documentation/benchmarks/etcd-2-2-0-rc-benchmarks.md
@@ -1,5 +1,7 @@
 ---
 title: Benchmarking etcd v2.2.0-rc
+weight: 5625
+description: Performance measures for etcd v2.2.0-rc
 ---
 
 ## Physical machine

diff --git a/Documentation/benchmarks/etcd-2-2-0-rc-memory-benchmarks.md b/Documentation/benchmarks/etcd-2-2-0-rc-memory-benchmarks.md
@@ -1,5 +1,7 @@
 ---
 title: Benchmarking etcd v2.2.0-rc-memory
+weight: 5500
+description: Performance measures for etcd v2.2.0-rc-memory
 ---
 
 ## Physical machine

diff --git a/Documentation/benchmarks/etcd-3-demo-benchmarks.md b/Documentation/benchmarks/etcd-3-demo-benchmarks.md
@@ -1,5 +1,7 @@
 ---
 title: Benchmarking etcd v3
+weight: 5375
+description: Performance measures for etcd v3
 ---
 
 ## Physical machines

diff --git a/Documentation/benchmarks/etcd-3-watch-memory-benchmark.md b/Documentation/benchmarks/etcd-3-watch-memory-benchmark.md
@@ -1,5 +1,7 @@
 ---
 title: Watch Memory Usage Benchmark
+weight: 5250
+description: Performance measures for etcd watchers
 ---
 
 *NOTE*: The watch features are under active development, and their memory usage may change as that development progresses. We do not expect it to significantly increase beyond the figures stated below.

diff --git a/Documentation/benchmarks/etcd-storage-memory-benchmark.md b/Documentation/benchmarks/etcd-storage-memory-benchmark.md
@@ -1,5 +1,7 @@
 ---
 title: Storage Memory Usage Benchmark
+weight: 5125
+description: Performance measures for etcd storage (in-memory index & page cache)
 ---
 
 <!---todo: link storage to storage design doc-->

diff --git a/Documentation/branch-management.md b/Documentation/branch-management.md
@@ -1,6 +1,7 @@
 ---
 title: Branch management
-weight: 1
+weight: 1250
+description: etcd branch management
 ---
 
 ## Guide

diff --git a/Documentation/demo.md b/Documentation/demo.md
@@ -1,6 +1,7 @@
 ---
 title: Demo
-weight: 1
+weight: 1100
+description: Procedures for working with an etcd cluster
 ---
 
 This series of examples shows the basic procedures for working with an etcd cluster.

diff --git a/Documentation/dev-guide/_index.md b/Documentation/dev-guide/_index.md
@@ -1,4 +1,5 @@
 ---
 title: Developer guide
 weight: 3000
+description: Guides for developers using ectd
 ---
diff --git a/Documentation/dev-guide/api_grpc_gateway.md b/Documentation/dev-guide/api_grpc_gateway.md
@@ -1,5 +1,7 @@
 ---
 title: Why gRPC gateway
+weight: 3375
+description: Why you should consider using the gRPC gateway
 ---
 
 etcd v3 uses [gRPC][grpc] for its messaging protocol. The etcd project includes a gRPC-based [Go client][go-client] and a command line utility, [etcdctl][etcdctl], for communicating with an etcd cluster through gRPC. For languages with no gRPC support, etcd provides a JSON [gRPC gateway][grpc-gateway]. This gateway serves a RESTful proxy that translates HTTP/JSON requests into gRPC messages.

diff --git a/Documentation/dev-guide/experimental_apis.md b/Documentation/dev-guide/experimental_apis.md
@@ -1,5 +1,7 @@
 ---
 title: Experimental APIs and features
+weight: 3750
+description: New (and potentially unstable) APIs and features in etcd
 ---
 
 For the most part, the etcd project is stable, but we are still moving fast! We believe in the release fast philosophy. We want to get early feedback on features still in development and stabilizing. Thus, there are, and will be more, experimental features and APIs. We plan to improve these features based on the early feedback from the community, or abandon them if there is little interest, in the next few releases. Please do not rely on any experimental features or APIs in production environment.

diff --git a/Documentation/dev-guide/grpc_naming.md b/Documentation/dev-guide/grpc_naming.md
@@ -1,5 +1,7 @@
 ---
 title: gRPC naming and discovery
+weight: 3500
+description: "go-grpc: for resolving gRPC endpoints with an etcd backend"
 ---
 
 etcd provides a gRPC resolver to support an alternative name system that fetches endpoints from etcd for discovering gRPC services. The underlying mechanism is based on watching updates to keys prefixed with the service name.

diff --git a/Documentation/dev-guide/interacting_v3.md b/Documentation/dev-guide/interacting_v3.md
@@ -1,5 +1,7 @@
 ---
 title: Interacting with etcd
+weight: 3250
+description: "etcdctl: a command line tool for interacting with the etcd server"
 ---
 
 Users mostly interact with etcd by putting or getting the value of a key. This section describes how to do that by using etcdctl, a command line tool for interacting with etcd server. The concepts described here should apply to the gRPC APIs or client library APIs.

diff --git a/Documentation/dev-guide/limit.md b/Documentation/dev-guide/limit.md
@@ -1,5 +1,7 @@
 ---
 title: System limits
+weight: 3625
+description: "etcd limits: requests and storage"
 ---
 
 ## Request size limit

diff --git a/Documentation/dev-guide/local_cluster.md b/Documentation/dev-guide/local_cluster.md
@@ -1,5 +1,7 @@
 ---
 title: Set up a local cluster
+weight: 3125
+description: Configuring local clusters for testing and development 
 ---
 
 For testing and development deployments, the quickest and easiest way is to configure a local cluster. For a production deployment, refer to the [clustering][clustering] section.

diff --git a/Documentation/dev-internal/discovery_protocol.md b/Documentation/dev-internal/discovery_protocol.md
@@ -1,5 +1,7 @@
 ---
 title: Discovery service protocol
+weight: 1500
+description: Discover other etcd members in a cluster bootstrap phase
 ---
 
 Discovery service protocol helps new etcd member to discover all other members in cluster bootstrap phase using a shared discovery URL.

diff --git a/Documentation/dev-internal/logging.md b/Documentation/dev-internal/logging.md
@@ -1,5 +1,7 @@
 ---
 title: Logging conventions
+weight: 1600
+description: Logging level categories
 ---
 
 etcd uses the [capnslog][capnslog] library for logging application output categorized into *levels*. A log message's level is determined according to these conventions:

diff --git a/Documentation/dev-internal/modules.md b/Documentation/dev-internal/modules.md
@@ -1,5 +1,7 @@
 ---
 title: Golang modules
+weight: 1650
+description: Organization of the etcd project's golang modules
 ---
 
 The etcd project (since version 3.5) is organized into multiple 
@@ -92,4 +94,4 @@ This assumes:
     etcd storage files.
   - Splitting etcd-proxy out of ./etcd binary, as it contains more experimental code
     so carries additional risk & dependencies.
-  - Deprecation of support for v2 protocol. 
+  - Deprecation of support for v2 protocol. 
diff --git a/Documentation/dev-internal/release.md b/Documentation/dev-internal/release.md
@@ -1,5 +1,7 @@
 ---
 title: etcd release guide
+weight: 1550
+description: How to release a new version of etcd
 ---
 
 The guide talks about how to release a new version of etcd.

diff --git a/Documentation/dl-build.md b/Documentation/dl-build.md
@@ -1,5 +1,7 @@
 ---
 title: Download and build
+weight: 1150
+description: Instructions for downloading and building different versions of etcd
 ---
 
 ## System requirements

diff --git a/Documentation/faq.md b/Documentation/faq.md
@@ -1,5 +1,7 @@
 ---
-title: Frequently Asked Questions (FAQ)
+title: FAQ
+weight: 1200
+description: Frequently asked questions
 ---
 
 ## etcd, general

diff --git a/Documentation/integrations.md b/Documentation/integrations.md
@@ -1,5 +1,7 @@
 ---
 title: Libraries and tools
+weight: 1300
+description: A listing of etcd tools and client libraries
 ---
 
 ## Tools

diff --git a/Documentation/learning/_index.md b/Documentation/learning/_index.md
@@ -1,4 +1,5 @@
 ---
 title: Learning
 weight: 2000
+description: Learning resources
 ---
diff --git a/Documentation/learning/api.md b/Documentation/learning/api.md
@@ -1,5 +1,7 @@
 ---
 title: etcd3 API
+weight: 2625
+description: etcd3 API central design overview
 ---
 
 This document is meant to give an overview of the etcd3 API's central design. It is by no means all encompassing, but intended to focus on the basic ideas needed to understand etcd without the distraction of less common API calls. All etcd3 API's are defined in [gRPC services][grpc-service], which categorize remote procedure calls (RPCs) understood by the etcd server. A full listing of all etcd RPCs are documented in markdown in the [gRPC API listing][grpc-api].

diff --git a/Documentation/learning/api_guarantees.md b/Documentation/learning/api_guarantees.md
@@ -1,5 +1,7 @@
 ---
 title: KV API guarantees
+weight: 2750
+description: KV API guarantees made by etcd
 ---
 
 etcd is a consistent and durable key value store with [mini-transaction][txn] support. The key value store is exposed through the KV APIs. etcd tries to ensure the strongest consistency and durability guarantees for a distributed system. This specification enumerates the KV API guarantees made by etcd.

diff --git a/Documentation/learning/data_model.md b/Documentation/learning/data_model.md
@@ -1,5 +1,7 @@
 ---
 title: Data model
+weight: 2125
+description: etcd data storage methodologies
 ---
 
 etcd is designed to reliably store infrequently updated data and provide reliable watch queries. etcd exposes previous versions of key-value pairs to support inexpensive snapshots and watch history events (“time travel queries”). A persistent, multi-version, concurrency-control data model is a good fit for these use cases.

diff --git a/Documentation/learning/design-auth-v3.md b/Documentation/learning/design-auth-v3.md
@@ -1,5 +1,7 @@
 ---
 title: etcd v3 authentication design
+weight: 2500
+description: etcd v3 authentication
 ---
 
 ## Why not reuse the v2 auth system?

diff --git a/Documentation/learning/design-client.md b/Documentation/learning/design-client.md
@@ -1,5 +1,7 @@
 ---
 title: etcd client design
+weight: 2250
+description: Client architectural decisions & their implementation details
 ---
 
 etcd Client Design

diff --git a/Documentation/learning/design-learner.md b/Documentation/learning/design-learner.md
@@ -1,5 +1,7 @@
 ---
 title: etcd learner design
+weight: 2375
+description: Mitigating common challenges with membership reconfiguration
 ---
 
 etcd Learner

diff --git a/Documentation/learning/glossary.md b/Documentation/learning/glossary.md
@@ -1,5 +1,7 @@
 ---
 title: Glossary
+weight: 2900
+description: Terms used in etcd documentation, command line, and source code
 ---
 
 This document defines the various terms used in etcd documentation, command line and source code.

diff --git a/Documentation/learning/why.md b/Documentation/learning/why.md
@@ -1,5 +1,7 @@
 ---
 title: etcd versus other key-value stores
+weight: 2875
+description: History and use of etcd & comparison with other tools
 ---
 
 The name "etcd" originated from two ideas, the unix "/etc" folder and "d"istributed systems. The "/etc" folder is a place to store configuration data for a single system whereas etcd stores configuration information for large scale distributed systems. Hence, a "d"istributed "/etc" is "etcd".

diff --git a/Documentation/metrics.md b/Documentation/metrics.md
@@ -1,5 +1,7 @@
 ---
 title: Metrics
+weight: 1350
+description: Metrics for real-time monitoring and debugging
 ---
 
 etcd uses [Prometheus][prometheus] for metrics reporting. The metrics can be used for real-time monitoring and debugging. etcd does not persist its metrics; if a member restarts, the metrics will be reset.

diff --git a/Documentation/op-guide/_index.md b/Documentation/op-guide/_index.md
@@ -1,4 +1,5 @@
 ---
 title: Operations guide
 weight: 4000
+description: etcd installation, maintenance, and troubleshooting guides
 ---
diff --git a/Documentation/op-guide/authentication.md b/Documentation/op-guide/authentication.md
@@ -1,5 +1,7 @@
 ---
 title: Role-based access control
+weight: 4100
+description: A basic authentication and role-based access control guide
 ---
 
 ## Overview

diff --git a/Documentation/op-guide/clustering.md b/Documentation/op-guide/clustering.md
@@ -1,5 +1,7 @@
 ---
 title: Clustering Guide
+weight: 4150
+description: "Bootstrapping an etcd cluster: Static, etcd Discovery, and DNS Discovery"
 ---
 
 ## Overview

diff --git a/Documentation/op-guide/configuration.md b/Documentation/op-guide/configuration.md
@@ -1,5 +1,7 @@
 ---
 title: Configuration flags
+weight: 4050
+description: "etcd configuration: files, flags, and environment variables"
 ---
 
 etcd is configurable through a configuration file, various command-line flags, and environment variables.

diff --git a/Documentation/op-guide/container.md b/Documentation/op-guide/container.md
@@ -1,5 +1,7 @@
 ---
 title: Run etcd clusters inside containers
+weight: 4200
+description: Running etcd with rkt and Docker using static bootstrapping
 ---
 
 The following guide shows how to run etcd with rkt and Docker using the [static bootstrap process](clustering.md#static).

diff --git a/Documentation/op-guide/failures.md b/Documentation/op-guide/failures.md
@@ -1,5 +1,7 @@
 ---
 title: Failure modes
+weight: 4250
+description: Kinds of failures and ectd's tolerance for them
 ---
 
 Failures are common in a large deployment of machines. A machine fails when its hardware or software malfunctions. Multiple machines fail together when there are power failures or network issues. Multiple kinds of failures can also happen at once; it is almost impossible to enumerate all possible failure cases. 

diff --git a/Documentation/op-guide/gateway.md b/Documentation/op-guide/gateway.md
@@ -1,5 +1,7 @@
 ---
 title: etcd gateway
+weight: 4300
+description: etcd gateway, when to use it, and how to set it up
 ---
 
 ## What is etcd gateway

diff --git a/Documentation/op-guide/grpc_proxy.md b/Documentation/op-guide/grpc_proxy.md
@@ -1,5 +1,7 @@
 ---
 title: gRPC proxy
+weight: 4350
+description: A stateless etcd reverse proxy operating at the gRPC layer
 ---
 
 The gRPC proxy is a stateless etcd reverse proxy operating at the gRPC layer (L7). The proxy is designed to reduce the total processing load on the core etcd cluster. For horizontal scalability, it coalesces watch and lease API requests. To protect the cluster against abusive clients, it caches key range requests.

diff --git a/Documentation/op-guide/hardware.md b/Documentation/op-guide/hardware.md
@@ -1,5 +1,7 @@
 ---
 title: Hardware recommendations
+weight: 4400
+description: Hardware guidelines for administering etcd clusters
 ---
 
 etcd usually runs well with limited resources for development or testing purposes; it’s common to develop with etcd on a  laptop or a cheap cloud machine. However, when running etcd clusters in production, some hardware guidelines are useful for proper administration. These suggestions are not hard rules; they serve as a good starting point for a robust production deployment. As always, deployments should be tested with simulated workloads before running in production.

diff --git a/Documentation/op-guide/maintenance.md b/Documentation/op-guide/maintenance.md
@@ -1,5 +1,7 @@
 ---
 title: Maintenance
+weight: 4450
+description: Periodic etcd cluster maintenance guide
 ---
 
 ## Overview

diff --git a/Documentation/op-guide/monitoring.md b/Documentation/op-guide/monitoring.md
@@ -1,5 +1,7 @@
 ---
 title: Monitoring etcd
+weight: 4500
+description: Monitoring etcd for system health & cluster debugging
 ---
 
 Each etcd server provides local monitoring information on its client port through http endpoints. The monitoring data is useful for both system health checking and cluster debugging.

diff --git a/Documentation/op-guide/performance.md b/Documentation/op-guide/performance.md
@@ -1,5 +1,7 @@
 ---
 title: Performance
+weight: 4550
+description: "Understanding performance: latency & throughput"
 ---
 
 ## Understanding performance

diff --git a/Documentation/op-guide/recovery.md b/Documentation/op-guide/recovery.md
@@ -1,5 +1,7 @@
 ---
 title: Disaster recovery
+weight: 4275
+description: etcd v3 snapshot & restore facilities
 ---
 
 etcd is designed to withstand machine failures. An etcd cluster automatically recovers from temporary failures (e.g., machine reboots) and tolerates up to *(N-1)/2* permanent failures for a cluster of N members. When a member permanently fails, whether due to hardware failure or disk corruption, it loses access to the cluster. If the cluster permanently loses more than *(N-1)/2* members then it disastrously fails, irrevocably losing quorum. Once quorum is lost, the cluster cannot reach consensus and therefore cannot continue accepting updates.

diff --git a/Documentation/op-guide/runtime-configuration.md b/Documentation/op-guide/runtime-configuration.md
@@ -1,5 +1,7 @@
 ---
 title: Runtime reconfiguration
+weight: 4700
+description: etcd incremental runtime reconfiguration support
 ---
 
 etcd comes with support for incremental runtime reconfiguration, which allows users to update the membership of the cluster at run time.

diff --git a/Documentation/op-guide/runtime-reconf-design.md b/Documentation/op-guide/runtime-reconf-design.md
@@ -1,5 +1,7 @@
 ---
 title: Design of runtime reconfiguration
+weight: 4650
+description: The design of etcd’s runtime reconfiguration commands
 ---
 
 Runtime reconfiguration is one of the hardest and most error prone features in a distributed system, especially in a consensus based system like etcd.