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

📖 Update document regarding overrides #6551

Merged
merged 1 commit into from
Jun 27, 2022
Merged

📖 Update document regarding overrides #6551

merged 1 commit into from
Jun 27, 2022

Conversation

mukul-kr
Copy link
Contributor

What this PR does / why we need it:
Document the fact that overrides only provide file replacements; instead, provider version resolution is based only on the actual repository structure
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 #5818

@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented May 26, 2022 •
edited
Loading

CLA Signed

The committers listed above are authorized under a signed CLA.

  • ✅ login: Clash-ion / name: Mukul Kumar (783fa37)

@k8s-ci-robot k8s-ci-robot added the cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. label May 26, 2022
@k8s-ci-robot
Copy link
Contributor

Welcome @Clash-ion!

It looks like this is your first PR to kubernetes-sigs/cluster-api 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/cluster-api has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot k8s-ci-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label May 26, 2022
@k8s-ci-robot
Copy link
Contributor

Hi @Clash-ion. 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.

@k8s-ci-robot k8s-ci-robot added size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels May 26, 2022
@mukul-kr
Copy link
Contributor Author

are the above changes all right or they need some modification???

killianmuldoon
killianmuldoon reviewed May 26, 2022
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.

/retitle 🌱 Update document regarding overrides

@k8s-ci-robot k8s-ci-robot changed the title Update document regarding overrides 🌱 Update document regarding overrides May 26, 2022
@killianmuldoon
Copy link
Contributor

/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. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels May 26, 2022
@mukul-kr
Copy link
Contributor Author

/test

@k8s-ci-robot
Copy link
Contributor

@Clash-ion: The /test command needs one or more targets.
The following commands are available to trigger required jobs:

  • /test pull-cluster-api-build-main
  • /test pull-cluster-api-e2e-main
  • /test pull-cluster-api-test-main
  • /test pull-cluster-api-test-mink8s-main
  • /test pull-cluster-api-verify-main

The following commands are available to trigger optional jobs:

  • /test pull-cluster-api-apidiff-main
  • /test pull-cluster-api-e2e-full-main
  • /test pull-cluster-api-e2e-informing-ipv6-main
  • /test pull-cluster-api-e2e-informing-main
  • /test pull-cluster-api-e2e-workload-upgrade-1-24-latest-main

Use /test all to run the following jobs that were automatically triggered:

  • pull-cluster-api-apidiff-main
  • pull-cluster-api-build-main
  • pull-cluster-api-test-main
  • pull-cluster-api-test-mink8s-main
  • pull-cluster-api-verify-main

In response to this:

/test

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.

@mukul-kr
Copy link
Contributor Author

/retitle 🌱 Update document regarding overrides

what is the reason to put seedling emoji in title ?

@killianmuldoon
Copy link
Contributor

We use the emojis for our release note automation - it gives us a clean way to divide up the 'kind' of PR. Thinking again I put the wrong one here 😆

/retitle 📖 Update document regarding overrides

@k8s-ci-robot k8s-ci-robot changed the title 🌱 Update document regarding overrides 📖 Update document regarding overrides May 26, 2022
@killianmuldoon
Copy link
Contributor

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label May 26, 2022
@mukul-kr
Copy link
Contributor Author

We use the emojis for our release note automation - it gives us a clean way to divide up the 'kind' of PR. Thinking again I put the wrong one here 😆

/retitle 📖 Update document regarding overrides

ooo okay so that's what it is for...

@mukul-kr
Copy link
Contributor Author

/lgtm

hello, why did the pr check failed??

@sbueringer
Copy link
Member

sbueringer commented May 30, 2022 •
edited
Loading

/lgtm

hello, why did the pr check failed??

Which one? I didn't see it before but we have a check that verifies that the icon is in the PR title.

@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jun 13, 2022
fabriziopandini
fabriziopandini reviewed Jun 13, 2022
View reviewed changes
docs/book/src/clusterctl/configuration.md Outdated
Comment on lines 161 to 165
<aside class="note warning">
<h1> Warning! </h1>
Overrides only provide file replacements; instead, provider version resolution is based only on the actual repository structure.
</aside>
<br>
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
<aside class="note warning">
<h1> Warning! </h1>
Overrides only provide file replacements; instead, provider version resolution is based only on the actual repository structure.
</aside>
<br>
<aside class="note warning">
<h1> Warning! </h1>
Overrides only provide file replacements; instead, provider version resolution is based only on the actual repository structure.
</aside>
<br>

Because to make the output nicer (you can take a look in the preview)
Also, please squash commits

Copy link
Contributor Author

Choose a reason for hiding this comment

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

okay I ll do that

@fabriziopandini
Copy link
Member

fabriziopandini commented Jun 23, 2022 •
edited
Loading

@Clash-ion any chance you can address the last nit?

@mukul-kr
Copy link
Contributor Author

@Clash-ion any chance you can address the last nit?

yes i ll try will try to update my pr today

@k8s-ci-robot k8s-ci-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Jun 25, 2022
@mukul-kr mukul-kr force-pushed the improve_documentation branch from b00e6e3 to be37679 Compare June 25, 2022 04:57
@k8s-ci-robot k8s-ci-robot added needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Jun 25, 2022
@k8s-ci-robot
Copy link
Contributor

k8s-ci-robot commented Jun 25, 2022 •
edited
Loading

@Clash-ion: The following tests failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
pull-cluster-api-e2e-informing-ipv6-main be37679 link false /test pull-cluster-api-e2e-informing-ipv6-main
pull-cluster-api-e2e-main be37679 link true /test pull-cluster-api-e2e-main
pull-cluster-api-e2e-informing-main be37679 link false /test pull-cluster-api-e2e-informing-main

Full PR test history. Your PR dashboard. Please help us cut down on flakes by linking to an open issue when you hit one in your PR.

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. I understand the commands that are listed here.

@mukul-kr
Update document regarding overrides
93d46d9 
Update configuration.md in clusterctl
@mukul-kr mukul-kr force-pushed the improve_documentation branch from be37679 to 93d46d9 Compare June 25, 2022 05:03
@k8s-ci-robot k8s-ci-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Jun 25, 2022
@mukul-kr
Copy link
Contributor Author

@fabriziopandini I think this looks good enough, I mean I just used the way it was previously done for Image Overrides.

@sbueringer
Copy link
Member

/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 Jun 27, 2022
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: sbueringer

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 k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jun 27, 2022
@k8s-ci-robot k8s-ci-robot merged commit b947c03 into kubernetes-sigs:main Jun 27, 2022
@k8s-ci-robot k8s-ci-robot added this to the v1.3 milestone Jun 27, 2022
@sbueringer
Copy link
Member

/cherry-pick release-1.2

@k8s-infra-cherrypick-robot k8s-infra-cherrypick-robot mentioned this pull request Jun 27, 2022
Merged
@k8s-infra-cherrypick-robot
Copy link

@sbueringer: new pull request created: #6747

In response to this:

/cherry-pick release-1.2

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.

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

@killianmuldoon killianmuldoon killianmuldoon left review comments

@fabriziopandini fabriziopandini fabriziopandini left review comments

@sbueringer sbueringer Awaiting requested review from sbueringer

Assignees

@sbueringer sbueringer

@killianmuldoon killianmuldoon

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. 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/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Milestone
v1.3
Development

Successfully merging this pull request may close these issues.

clarify how clusterctl overrides works
6 participants
@mukul-kr @k8s-ci-robot @killianmuldoon @sbueringer @fabriziopandini @k8s-infra-cherrypick-robot