Skip to content

Conversation

@xadips
Copy link

@xadips xadips commented Dec 1, 2025

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 read https://github.com/etcd-io/etcd/blob/main/CONTRIBUTING.md#contribution-flow.

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>
@k8s-ci-robot
Copy link

[APPROVALNOTIFIER] This PR is NOT APPROVED

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

The full list of commands accepted by this bot can be found here.

Needs 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 a github.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 should join the org to skip this step.

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

I understand the commands that are listed here.

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

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

Development

Successfully merging this pull request may close these issues.

2 participants