Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

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

Open
xadips wants to merge1 commit intoetcd-io:main
base:main
Choose a base branch
Loading
fromxadips:docs/improve-sample-config-discovery-v3

Conversation

@xadips
Copy link

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.

Please readhttps://github.com/etcd-io/etcd/blob/main/CONTRIBUTING.md#contribution-flow.

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
Copy link

[APPROVALNOTIFIER] This PR isNOT APPROVED

This pull-request has been approved by:xadips
Once this PR has been reviewed and has the lgtm label, please assignahrtr for approval. For more information seethe Code Review Process.

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/approve in a comment
Approvers can cancel approval by writing/approve cancel in a comment

@k8s-ci-robot
Copy link

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/ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors shouldjoin the org to skip this step.

Once the patch is verified, the new status will be reflected by theok-to-test label.

I understand the commands that are listedhere.

Details

Instructions 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.

Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@xadips@k8s-ci-robot

[8]ページ先頭

©2009-2025 Movatter.jp