etcd.conf.yml.sample: improve discovery v3 configuration documentation#20985
etcd.conf.yml.sample: improve discovery v3 configuration documentation#20985xadips wants to merge 1 commit intoetcd-io:mainfrom
Conversation
Update the sample configuration file to properly document discovery v3 options 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 option 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. Signed-off-by: xadips <ricardas.cubukinas@vinted.com>
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: xadips The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
|
Hi @xadips. Thanks for your PR. I'm waiting for a github.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 listed here. DetailsInstructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
|
This pull request has been automatically marked as stale because it has not had recent activity. It will be closed after 21 days if no further activity occurs. Thank you for your contributions. |
|
Is this stale? The config is still outdated. |
2 participants
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 read https://github.com/etcd-io/etcd/blob/main/CONTRIBUTING.md#contribution-flow.