-
Notifications
You must be signed in to change notification settings - Fork 300
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add feature gates doc for etcd #941
Open
gangli113
wants to merge
5
commits into
etcd-io:main
Choose a base branch
from
gangli113:addFeatureGatesDoc
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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 |
---|---|---|
@@ -0,0 +1,88 @@ | ||
--- | ||
title: Feature Gates | ||
weight: 10 | ||
content_type: concept | ||
card: | ||
name: reference | ||
weight: 60 | ||
--- | ||
|
||
<!-- overview --> | ||
This page contains an overview of the various feature gates an administrator | ||
can specify on ETCD. | ||
|
||
See [feature stages](#feature-stages) for an explanation of the stages for a feature. | ||
|
||
|
||
<!-- body --> | ||
## Overview | ||
|
||
Feature gates are a set of key=value pairs that describe ETCD features. | ||
You can turn these features on or off using the `--feature-gates` command line flag | ||
on ETCD. | ||
|
||
ETCD lets you enable or disable a set of feature gates. | ||
Use `-h` flag to see a full set of feature gates. | ||
To set feature gates, use the `--feature-gates` flag assigned to a list of feature pairs: | ||
|
||
```shell | ||
--feature-gates=...,StopGRPCServiceOnDefrag=true | ||
``` | ||
|
||
The following tables are a summary of the feature gates that you can set on | ||
ETCD. | ||
|
||
### Feature gates for Alpha or Beta features | ||
|
||
| Feature | Default | Stage | | ||
|----------------------------------|---------|-------| | ||
| StopGRPCServiceOnDefrag | false | Alpha | | ||
| InitialCorruptCheck | false | Alpha | | ||
| CompactHashCheck | false | Alpha | | ||
| TxnModeWriteWithSharedBuffer | true | Beta | | ||
|
||
## Using a feature | ||
|
||
### Feature stages | ||
gangli113 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
A feature can be in *Alpha*, *Beta* or *GA* stage. | ||
An *Alpha* feature means: | ||
|
||
* Disabled by default. | ||
* Might be buggy. Enabling the feature may expose bugs. | ||
* Support for feature may be dropped at any time without notice. | ||
* The API may change in incompatible ways in a later software release without notice. | ||
* Recommended for use only in short-lived testing clusters, due to increased | ||
risk of bugs and lack of long-term support. | ||
|
||
A *Beta* feature means: | ||
|
||
* Enabled by default. | ||
* The feature is well tested. Enabling the feature is considered safe. | ||
* Support for the overall feature will not be dropped, though details may change. | ||
* Recommended for only non-business-critical uses because of potential for | ||
discovering new hard-to-spot bugs through wider adoption. | ||
|
||
**Note:** | ||
Please do try *Beta* features and give feedback on them! | ||
After they exit beta, it may not be practical for us to make more changes. | ||
|
||
A *General Availability* (GA) feature is also referred to as a *stable* feature. It means: | ||
|
||
* The feature is always enabled; you cannot disable it. | ||
* The corresponding feature gate is no longer needed. | ||
* Stable versions of features will appear in released software for many subsequent versions. | ||
ahrtr marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
A *Deprecated* feature means: | ||
|
||
* The feature gate is no longer in use. | ||
* The feature has graduated to GA or been removed. | ||
|
||
## List of feature gates {#feature-gates} | ||
|
||
Each feature gate is designed for enabling/disabling a specific feature. | ||
|
||
* `StopGRPCServiceOnDefrag`: Enable etcd gRPC service to stop serving client requests on defragmentation. | ||
* `TxnModeWriteWithSharedBuffer`: Enables the write transaction to use a shared buffer in its readonly check operations. | ||
* `InitialCorruptCheck`: Enable to check data corruption before serving any client/peer traffic. | ||
* `CompactHashCheck`: Enable leader to periodically check followers compaction hashes. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@gangli113 thanks! Please use small cap etcd instead of ETCD, here and everywhere.