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

📖 docs: Add installation guide with homebrew #4345

Merged
merged 1 commit into from
Mar 31, 2021

Conversation

ludusrusso
Copy link
Contributor

What this PR does / why we need it:

Add installation guide with homebrew for macOS in book. Related to #2389

Can be merged once Homebrew/homebrew-core/73610 is merged!

@k8s-ci-robot k8s-ci-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Mar 21, 2021
@k8s-ci-robot
Copy link
Contributor

Thanks for your pull request. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please follow instructions at https://git.k8s.io/community/CLA.md#the-contributor-license-agreement to sign the CLA.

It may take a couple minutes for the CLA signature to be fully registered; after that, please reply here with a new comment and we'll verify. Thanks.


  • If you've already signed a CLA, it's possible we don't have your GitHub username or you're using a different email address. Check your existing CLA data and verify that your email is set on your git commits.
  • If you signed the CLA as a corporation, please sign in with your organization's credentials at https://identity.linuxfoundation.org/projects/cncf to be authorized.
  • If you have done the above and are still having issues with the CLA being reported as unsigned, please log a ticket with the Linux Foundation Helpdesk: https://support.linuxfoundation.org/
  • Should you encounter any issues with the Linux Foundation Helpdesk, send a message to the backup e-mail support address at: [email protected]

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.

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

Welcome @ludusrusso!

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 Mar 21, 2021
@k8s-ci-robot
Copy link
Contributor

Hi @ludusrusso. 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 the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Mar 21, 2021
@davideimola
Copy link
Contributor

What about to add a chapter on updating clusterctl with brew?

@ludusrusso ludusrusso marked this pull request as ready for review March 21, 2021 13:34
@k8s-ci-robot k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Mar 21, 2021
@ludusrusso
Copy link
Contributor Author

/check-cla

@k8s-ci-robot k8s-ci-robot added 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 Mar 21, 2021
@fabriziopandini
Copy link
Member

/ok-to-test
/hold
for the discussion on #2389

What about to add a chapter on updating clusterctl with brew?

This is a good idea, but IMO this should not go in the quick start. what about having something under tasks? Also, If I'm not wrong, we are also still discussing how to get automatic upgrades of the formula...

@k8s-ci-robot k8s-ci-robot added do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. 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 Mar 22, 2021
@ludusrusso
Copy link
Contributor Author

/ok-to-test
/hold
for the discussion on #2389

What about to add a chapter on updating clusterctl with brew?

This is a good idea, but IMO this should not go in the quick start. what about having something under tasks? Also, If I'm not wrong, we are also still discussing how to get automatic upgrades of the formula...

I agree with @fabriziopandini! I'll also put this in WIP until we decide the best name for the homebrew formula!

@ludusrusso ludusrusso marked this pull request as draft March 22, 2021 11:20
@k8s-ci-robot k8s-ci-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Mar 22, 2021
@fabriziopandini
Copy link
Member

/milestone v0.4.0

@k8s-ci-robot k8s-ci-robot added this to the v0.4.0 milestone Mar 22, 2021
Copy link
Contributor

@stmcginnis stmcginnis left a comment

Choose a reason for hiding this comment

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

I wonder if we should get rid of the macOS curl instructions. Though no harm really having both options explained.

Looks good to me, but one small typo pointed out.

docs/book/src/user/quick-start.md Outdated Show resolved Hide resolved
@ludusrusso
Copy link
Contributor Author

@stmcginnis thanks for help! brew install clusterctl is also available on linux now, should I add docs also for this in your opinion?

@stmcginnis
Copy link
Contributor

Brew use on Linux still seems relatively low, but I could see it being useful.

Just another thought, but we could have a separate brew tab. Then have Linux, macOS, and Brew specific instructions, since there really isn't any OS-specific difference when using brew to install. Just throwing the idea out there.

@vincepri
Copy link
Member

+1 on having a brew tab as an alternative method.

/ok-to-test

@ludusrusso
Copy link
Contributor Author

Schermata 2021-03-23 alle 16 43 05

@vincepri @stmcginnis what do you think?

@stmcginnis
Copy link
Contributor

Love it!

@ludusrusso ludusrusso marked this pull request as ready for review March 24, 2021 15:17
@k8s-ci-robot k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Mar 24, 2021
@ludusrusso
Copy link
Contributor Author

I think we are ready on this!

@ludusrusso
Copy link
Contributor Author

/retest

@ludusrusso ludusrusso changed the title 📖 docs: Add installation guide with homebrew on macOS 📖 docs: Add installation guide with homebrew Mar 24, 2021
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

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Mar 26, 2021
@vincepri
Copy link
Member

/hold cancel

Copy link
Member

@vincepri vincepri left a comment

Choose a reason for hiding this comment

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

/approve

@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 Mar 31, 2021
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: vincepri

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 Mar 31, 2021
@k8s-ci-robot k8s-ci-robot merged commit 3551887 into kubernetes-sigs:master Mar 31, 2021
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.

6 participants