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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add installation instructions for Scoop and Winget #3376

Conversation

ste93cry
Copy link
Contributor

Since kind is now installable via both Scoop and Winget, the Quick Start guide should mention the installation instructions for those package managers.

@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented Sep 30, 2023

CLA Signed

The committers listed above are authorized under a signed CLA.

  • ✅ login: ste93cry / name: Stefano Arlandini (ca9d450)

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

Welcome @ste93cry!

It looks like this is your first PR to kubernetes-sigs/kind 🎉. 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/kind 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 Sep 30, 2023
@k8s-ci-robot
Copy link
Contributor

Hi @ste93cry. 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/S Denotes a PR that changes 10-29 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 Sep 30, 2023
@BenTheElder
Copy link
Member

blocked on #3379
/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 Nov 29, 2023
@ste93cry
Copy link
Contributor Author

ste93cry commented Nov 29, 2023

I understand that you may not want to maintain the Winget manifest, but I still think it's worth documenting at least the ability to install the package as is possible with other package managers. Tools like kubectl and minikube are already available in Winget, and now that kind is too, it doesn't sound too bad to let people know about it. I don't know who maintains the homebrew formula, but if it's community-driven I wonder why Winget should receive a different treatment just because it arrived late to the party 🤔 Regarding Scoop, as far as I understand the manifest is automatically updated, so it should always be up-to-date and no human intervention is needed.

@stmcginnis
Copy link
Contributor

This should be done the same way as kubectl: https://github.com/microsoft/winget-pkgs/tree/master/manifests/k/Kubernetes/kubectl

Even though it would be "automated", there is still maintenance overhead. Nothing stays static, so it's inevitable that something would change or break and it would need attention to troubleshoot - in an area most of the maintainers are not familiar with - and identify what needs to be updated. This is best kept out of kind itself and managed by winget-pkgs.

@stmcginnis
Copy link
Contributor

@ste93cry
Copy link
Contributor Author

ste93cry commented Dec 6, 2023

This is best kept out of kind itself and managed by winget-pkgs.

I understand the reasons you don't want to maintain the manifest, but this has nothing to do with mentioning in the documentation that the tool can be installed with these package managers, right?

@stmcginnis
Copy link
Contributor

I understand the reasons you don't want to maintain the manifest, but this has nothing to do with mentioning in the documentation that the tool can be installed with these package managers, right?

I see what you're saying, and I guess I agree. We don't maintain the brew or chocolatey packages, but we do have them listed in the documentation as possible ways to install kind. It almost feels like we should note a caveat there that the project has involvement in those packages and cannot vouch for their quality, but we've gone this long without it, so I don't see why these should be gated on doing something like that. If we even should.

So sorry for the long delay, but I do think this could be useful for someone to have in the docs.

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jun 3, 2024
@BenTheElder
Copy link
Member

BenTheElder commented Jun 4, 2024

We don't maintain the brew or chocolatey packages, but we do have them listed in the documentation as possible ways to install kind.

I'm in touch with the brew maintainers (heck somewhere there's a photo of me sitting with christoph at KubeCon while we developed the package on his laptop) and keep an eye on this one.

It's true that the chocolatey package has this issue.

We should split these into vetted and use at your own risk.
Making a mistake in the past doesn't mean we should repeat it.

KIND is used to manage privileged containers and must run with escalated permissions, kind itself is bad enough, but telling users to install packages we don't control is even worse and should be treated carefully.

@BenTheElder
Copy link
Member

Let's add these, but follow-up by splitting first and third party and clarifying (more detailed proposal at #3644)

Sorry for the delay. There's a LOT going on and there hasn't been much user demand for these versus the concerns and ongoing bug triage etc....

/lgtm
/approve

#3644 to follow up on all third party install options.

@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 4, 2024
@BenTheElder
Copy link
Member

oops, I meant to merge this already but missed the hold-lift, we'll have to rebase it after #3660 merged, I meant for that PR to rebase this work instead of the other way around

https://kind.sigs.k8s.io/docs/user/quick-start/#installing-with-a-package-manager

@k8s-ci-robot k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jun 20, 2024
@ste93cry ste93cry force-pushed the update-quick-start-installation-doc branch from 3240fcf to ca9d450 Compare June 20, 2024 22:16
@k8s-ci-robot k8s-ci-robot removed lgtm "Looks good to me", indicates that a PR is ready to be merged. needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. labels Jun 20, 2024
@ste93cry
Copy link
Contributor Author

Rebased 👍

Copy link
Member

@BenTheElder BenTheElder 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
/hold cancel

thanks!

@k8s-ci-robot k8s-ci-robot added lgtm "Looks good to me", indicates that a PR is ready to be merged. and removed do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. labels Jun 20, 2024
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: BenTheElder, ste93cry

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

@BenTheElder
Copy link
Member

/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 Jun 20, 2024
@k8s-ci-robot k8s-ci-robot merged commit ff9c7b5 into kubernetes-sigs:main Jun 20, 2024
9 checks passed
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. 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
Development

Successfully merging this pull request may close these issues.

4 participants