etcd-io / etcd-io/website

Add or Update configuration options flags

Open
#1,074 2 comments 0 reactions 0 assignees View on GitHub
Dominant language
HTML
Stars
194
Forks
354
Avg merge
9d 12h
Merged PRs (30d)
3

Description

## Problem
The configuration options on the [website](https://etcd.io/docs/v3.6/op-guide/configuration/) are not up to date with the config.go [code](https://github.com/etcd-io/etcd/blob/main/server/embed/config.go).

This parent issue aims to update configuration flags to reflect these changes on the website.

## Proposal
I propose to create or update existing sections in order to update the configurations of the website to help users configure etcd. [ref](https://github.com/etcd-io/website/issues/532) . It is still a manual process though not optimal. I am happy to hear if there is an automated way.

### Member flags to be updated to reflect the website
https://github.com/etcd-io/etcd/blob/main/server/embed/config.go#L599-L638

### Raft connection flags (a new section in the website needs to be added for this)
https://github.com/etcd-io/etcd/blob/main/server/embed/config.go#L599-L638

### Clustering flags to be added or updated
https://github.com/etcd-io/etcd/blob/main/server/embed/config.go#L645-L681

### Security flags to be added or updated
https://github.com/etcd-io/etcd/blob/main/server/embed/config.go#L684-L714

### Logging flags to be added or updated
[ ] https://github.com/etcd-io/etcd/blob/main/server/embed/config.go#L717-L725 - PR https://github.com/etcd-io/website/pull/1104

### pprof profiler via HTTP
https://github.com/etcd-io/etcd/blob/main/server/embed/config.go#L728

### Additional metrics
https://github.com/etcd-io/etcd/blob/main/server/embed/config.go#L731-L737

### Auth
https://github.com/etcd-io/etcd/blob/main/server/embed/config.go#L740-L742

### Gateway
https://github.com/etcd-io/etcd/blob/main/server/embed/config.go#L745-L758

### Unsafe features
https://github.com/etcd-io/etcd/blob/main/server/embed/config.go#L761-L762

### Feature gates
https://github.com/etcd-io/etcd/blob/main/server/embed/config.go#L765

I will send PRs for this, contributions are welcomed.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.