Skip to content

Commit 48e35f6

Browse files
Add changes in embed.EtcdServer struct for feature gate.
Signed-off-by: Siyuan Zhang <[email protected]>
1 parent 7dbc4bb commit 48e35f6

File tree

1 file changed

+38
-4
lines changed
  • content/en/docs/v3.6/feature-gates

1 file changed

+38
-4
lines changed

content/en/docs/v3.6/feature-gates/index.md

+38-4
Original file line numberDiff line numberDiff line change
@@ -34,16 +34,50 @@ Or specify `feature-gates` in YAML config file:
3434
feature-gates: ...,StopGRPCServiceOnDefrag=true
3535
```
3636

37-
The following tables are a summary of the feature gates that you can set on
38-
etcd.
37+
### Change in `embed.EtcdServer` struct
38+
39+
In 3.6, field `ServerFeatureGate` is added to `embed.Config`, and should be replacing the experimental fields listed below:
40+
41+
```diff
42+
package embed
43+
44+
type Config struct {
45+
// Deprecated: Use CompactHashCheck Feature Gate instead. Will be decommissioned in v3.7.
46+
ExperimentalCompactHashCheckEnabled bool `json:"experimental-compact-hash-check-enabled"`
47+
48+
// Deprecated: Use InitialCorruptCheck Feature Gate instead. Will be decommissioned in v3.7.
49+
ExperimentalInitialCorruptCheck bool `json:"experimental-initial-corrupt-check"`
50+
51+
// Deprecated: Use TxnModeWriteWithSharedBuffer Feature Gate instead. Will be decommissioned in v3.7.
52+
ExperimentalTxnModeWriteWithSharedBuffer bool `json:"experimental-txn-mode-write-with-shared-buffer"`
53+
54+
// Deprecated: Use StopGRPCServiceOnDefrag Feature Gate instead. Will be decommissioned in v3.7.
55+
ExperimentalStopGRPCServiceOnDefrag bool `json:"experimental-stop-grpc-service-on-defrag"`
56+
57+
// Deprecated: Use LeaseCheckpoint Feature Gate instead. Will be decommissioned in v3.7.
58+
ExperimentalEnableLeaseCheckpoint bool `json:"experimental-enable-lease-checkpoint"`
59+
60+
// Deprecated: Use LeaseCheckpointPersist Feature Gate instead. Will be decommissioned in v3.7.
61+
ExperimentalEnableLeaseCheckpointPersist bool `json:"experimental-enable-lease-checkpoint-persist"`
62+
63+
+ // ServerFeatureGate is a server level feature gate
64+
+ ServerFeatureGate featuregate.FeatureGate
65+
...
66+
```
3967

4068
### Feature gates for Alpha or Beta features
4169

70+
The following tables are a summary of the feature gates that you can set on
71+
etcd.
72+
4273
| Feature | Default | Stage | Details |
4374
|----------------------------------|---------|-------|--------------------------------------------------------------------------------------|
44-
| StopGRPCServiceOnDefrag | false | Alpha |Enables etcd gRPC service to stop serving client requests on defragmentation. |
45-
| InitialCorruptCheck | false | Alpha |Enables the write transaction to use a shared buffer in its readonly check operations.|
4675
| CompactHashCheck | false | Alpha |Enables to check data corruption before serving any client/peer traffic. |
76+
| InitialCorruptCheck | false | Alpha |Enables the write transaction to use a shared buffer in its readonly check operations.|
77+
| LeaseCheckpoint | false | Alpha |Enables leader to send regular checkpoints to other members to prevent reset of remaining TTL on leader change. |
78+
| LeaseCheckpointPersist | false | Alpha |Enables persisting remainingTTL to prevent indefinite auto-renewal of long lived leases. |
79+
| SetMemberLocalAddr | false | Alpha |Enables using the first specified and non-loopback local address from initial-advertise-peer-urls as the local address when communicating with a peer. |
80+
| StopGRPCServiceOnDefrag | false | Alpha |Enables etcd gRPC service to stop serving client requests on defragmentation. |
4781
| TxnModeWriteWithSharedBuffer | true | Beta |Enables leader to periodically check followers compaction hashes. |
4882

4983
## Using a feature

0 commit comments

Comments
 (0)