- Notifications
You must be signed in to change notification settings - Fork10.2k
etcd.conf.yml.sample: improve discovery v3 configuration documentation#20985
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
base:main
Are you sure you want to change the base?
Uh oh!
There was an error while loading.Please reload this page.
Conversation
Update the sample configuration file to properly document discovery v3options with correct nested structure and comprehensive comments.Changes:- Add properly structured discovery-config section with nested YAML- Document all discovery v3 client configuration options- Add default values in comments for timeout fields (in nanoseconds)- Include important notes about duration format requirements- Add security and authentication configuration options- Clarify that only one of initial-cluster, discovery-srv, or discovery-config can be used- Add CAUTION warning for insecure-skip-tls-verify optionThis addresses the common misconfiguration issue where users attemptto use flat discovery-* fields at the top level, which are silentlyignored in YAML config files. The flat fields only work as command-lineflags, while YAML requires the nested discovery-config structure.Fixes the documentation gap identified when investigating whydiscovery-token and discovery-endpoints were not being parsed fromYAML configuration files.Signed-off-by: xadips <ricardas.cubukinas@vinted.com>
k8s-ci-robot commentedDec 1, 2025
[APPROVALNOTIFIER] This PR isNOT APPROVED This pull-request has been approved by:xadips The full list of commands accepted by this bot can be foundhere. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
k8s-ci-robot commentedDec 1, 2025
Hi@xadips. Thanks for your PR. I'm waiting for agithub.com member to verify that this patch is reasonable to test. If it is, they should reply with Once the patch is verified, the new status will be reflected by the I understand the commands that are listedhere. DetailsInstructions for interacting with me using PR comments are availablehere. If you have questions or suggestions related to my behavior, please file an issue against thekubernetes-sigs/prow repository. |
Update the sample configuration file to properly document discovery v3 options with correct nested structure and comprehensive comments.
Changes:
This addresses the common misconfiguration issue where users attempt to use flat discovery-* fields at the top level, which are silently ignored in YAML config files. The flat fields only work as command-line flags, while YAML requires the nested discovery-config structure.
Fixes the documentation gap identified when investigating why discovery-token and discovery-endpoints were not being parsed from YAML configuration files.
Please readhttps://github.com/etcd-io/etcd/blob/main/CONTRIBUTING.md#contribution-flow.