Skip to content
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.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

📖 Add a line about the format of key for clusterctl config #9513

Merged
merged 1 commit into from
Oct 3, 2023
Merged

📖 Add a line about the format of key for clusterctl config #9513

merged 1 commit into from
Oct 3, 2023

Conversation

musaprg
Copy link
Member

@musaprg musaprg commented Oct 1, 2023 •
edited

What this PR does / why we need it:
This PR adds a line in the docs to describe the format of keys for clusterctl config substitution.
The format comes from the Viper's behavior that doesn't accept lowercase letters. Users should know the required format regardless of whether it's the Viper's expected behavior or not.

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Fixes #8097

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. do-not-merge/needs-area PR is missing an area label needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Oct 1, 2023
@k8s-ci-robot
Copy link
Contributor

Hi @musaprg. Thanks for your PR.

I'm waiting for a kubernetes-sigs 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/test-infra repository.

@musaprg
Copy link
Member Author

musaprg commented Oct 1, 2023

/kind documentation

@k8s-ci-robot k8s-ci-robot added the kind/documentation Categorizes issue or PR as related to documentation. label Oct 1, 2023
@musaprg
Copy link
Member Author

musaprg commented Oct 1, 2023

/area clusterctl

@k8s-ci-robot k8s-ci-robot added area/clusterctl Issues or PRs related to clusterctl and removed do-not-merge/needs-area PR is missing an area label labels Oct 1, 2023
killianmuldoon
killianmuldoon reviewed Oct 1, 2023
View reviewed changes
Copy link
Contributor

@killianmuldoon killianmuldoon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/area documentation
/ok-to-test

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. area/documentation Issues or PRs related to documentation and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Oct 1, 2023
@killianmuldoon killianmuldoon removed the area/clusterctl Issues or PRs related to clusterctl label Oct 1, 2023
@killianmuldoon
Copy link
Contributor

Thanks!

Could you squash the commits when you have a chance?

/hold

@k8s-ci-robot k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Oct 1, 2023
@musaprg musaprg force-pushed the 8097-add-note-about-format-of-env-in-clusterctl branch from 3b03724 to a4ca183 Compare October 2, 2023 07:16
@musaprg
Copy link
Member Author

musaprg commented Oct 2, 2023

@killianmuldoon OK, I squashed the commits. Could you PTAL at the change? Thanks!

killianmuldoon
killianmuldoon reviewed Oct 2, 2023
View reviewed changes
Copy link
Contributor

@killianmuldoon killianmuldoon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/hold cancel

Thanks!

@k8s-ci-robot k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Oct 2, 2023
@musaprg musaprg force-pushed the 8097-add-note-about-format-of-env-in-clusterctl branch from aeebcfe to bb5bacf Compare October 2, 2023 13:43
@musaprg @fabriziopandini
Add a line about the format of key for clusterctl config
de68eae 
Signed-off-by: Kotaro Inoue <inoue.kotaro@linecorp.com>

Update docs/book/src/clusterctl/configuration.md

Co-authored-by: killianmuldoon <47175296+killianmuldoon@users.noreply.github.com>

Update docs/book/src/clusterctl/configuration.md

Co-authored-by: Fabrizio Pandini <fabrizio.pandini@gmail.com>
@musaprg musaprg force-pushed the 8097-add-note-about-format-of-env-in-clusterctl branch from bb5bacf to de68eae Compare October 2, 2023 13:46
fabriziopandini
fabriziopandini reviewed Oct 3, 2023
View reviewed changes
Copy link
Member

@fabriziopandini fabriziopandini left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm
/approve

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Oct 3, 2023
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: fabriziopandini

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

The pull request process is described 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
Contributor

LGTM label has been added.

Git tree hash: 7e5ff00c4aa3ef5ee77a0ec3e47604ce90cd01c2

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Oct 3, 2023
@k8s-ci-robot k8s-ci-robot merged commit 646933b into kubernetes-sigs:main Oct 3, 2023
18 checks passed
@k8s-ci-robot k8s-ci-robot added this to the v1.6 milestone Oct 3, 2023
@killianmuldoon
Copy link
Contributor

/cherry-pick release-1.5

@k8s-infra-cherrypick-robot k8s-infra-cherrypick-robot mentioned this pull request Oct 3, 2023
Merged
@k8s-infra-cherrypick-robot
Copy link

@killianmuldoon: new pull request created: #9518

In response to this:

/cherry-pick release-1.5

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/test-infra repository.

@musaprg musaprg deleted the 8097-add-note-about-format-of-env-in-clusterctl branch October 3, 2023 12:49
@musaprg musaprg mentioned this pull request Oct 17, 2023
Closed
9 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@fabriziopandini fabriziopandini fabriziopandini left review comments

@chrischdi chrischdi Awaiting requested review from chrischdi

@jackfrancis jackfrancis Awaiting requested review from jackfrancis

@killianmuldoon killianmuldoon Awaiting requested review from killianmuldoon

Assignees

@fabriziopandini fabriziopandini

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. area/documentation Issues or PRs related to documentation cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/documentation Categorizes issue or PR as related to documentation. lgtm "Looks good to me", indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Milestone
v1.6
Development

Successfully merging this pull request may close these issues.

clusterctl generate not accepting environment variable
5 participants
@musaprg @k8s-ci-robot @killianmuldoon @k8s-infra-cherrypick-robot @fabriziopandini