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.

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

Already on GitHub? Sign in to your account

馃尡 Add k3s providers to cluster-api book #9577

Merged

Conversation

zawachte
Copy link
Contributor

What this PR does / why we need it:
Adds https://github.com/cluster-api-provider-k3s/cluster-api-k3s to the cluster-api book.
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 #
No existing issue ... can create one if needed.

@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 labels Oct 19, 2023
@k8s-ci-robot
Copy link
Contributor

Welcome @zawachte!

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

Hi @zawachte. 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 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 19, 2023
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.

Justa couple of questions:

  • Do you also want to add this provider to clusterctl?
  • Do you know what the differences are between this provider and the kubekey k3s provider? - added here @24sama who added that last year.

/area documentation
/ok-to-test

@k8s-ci-robot k8s-ci-robot added area/documentation Issues or PRs related to documentation 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. do-not-merge/needs-area PR is missing an area label labels Oct 19, 2023
@zawachte
Copy link
Contributor Author

zawachte commented Oct 19, 2023

  • Do you also want to add this provider to clusterctl?

If that is allowed ... would love to.

I don't. I agree with the concern, it would be good to understand the overlap.

@24sama
Copy link
Contributor

24sama commented Oct 20, 2023

Hi @zawachte @killianmuldoon
The kubekey k3s provider basically forks the cluster-api-k3s-provider and optimizes some logic to accommodate kubekey use.

For example:
cluster-api-k3s-provider may download k3s-install.sh script from the internet. But kubekey k3s provider uses the script that is already exists in the machine's directory because kubekey core provider will prepares these scripts, binaries, etc., on the machine.

@killianmuldoon
Copy link
Contributor

The kubekey k3s provider basically forks the cluster-api-k3s-provider and optimizes some logic to accommodate kubekey use.

Would there be any way to upstream those changes and deduplicate the effort? Seems like it would be good for everyone.

Either way I think it's fine to add the k3s providers to the book. @fabriziopandini WDYT about adding this provider to clusterctl given the duplication?

@CecileRobertMichon
Copy link
Contributor

+1 to adding k3s to both the book and clusterctl

Agree with @killianmuldoon that it would be best to make the changes to the k3s provider instead of maintaining a separate provider, if the kubekey changes are generic enough that they can benefit all

@24sama
Copy link
Contributor

24sama commented Oct 24, 2023

Agree with @killianmuldoon, but kubekey changes are not very generic, so we may spend some time contributing these changes upstream.

And for this PR, +1 to adding k3s provider to the book.

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.

/lgtm
/approve

The duplication definitely shouldn't prevent this provider from being in the CAPI book - but it would be great if there could be some joint effort to merge the two providers.

Thanks @zawachte and @24sama for helping me understand the current state.

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

LGTM label has been added.

Git tree hash: 65bfadbb1bef050f3ea742e1b7e1cdc5121e3e9a

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: killianmuldoon

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 Nov 6, 2023
@k8s-ci-robot k8s-ci-robot merged commit 5f43703 into kubernetes-sigs:main Nov 6, 2023
23 checks passed
@k8s-ci-robot k8s-ci-robot added this to the v1.6 milestone Nov 6, 2023
@zawachte
Copy link
Contributor Author

zawachte commented Nov 6, 2023

Thanks @killianmuldoon. I will raise a follow up for the clusterctl support.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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. 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
Development

Successfully merging this pull request may close these issues.

None yet

5 participants