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

Document: how to install/distribute plugins with Krew #16322

Merged
merged 2 commits into from
Oct 23, 2019
Merged

Document: how to install/distribute plugins with Krew #16322

merged 2 commits into from
Oct 23, 2019

Conversation

ahmetb
Copy link
Member

@ahmetb ahmetb commented Sep 11, 2019

Context: Krew (https://sigs.k8s.io/krew) is a Kubernetes SIG CLI sub-project
that's been available for over a year. It is considered to be the de-facto tool
to discover and install kubectl plugins.

This patch details:

  • how to use Krew to discover/install plugins
  • how to distribute a kubectl plugin (with traditional package managers or
    using Krew).

/sig cli
/sig docs
/cc @corneliusweig

@k8s-ci-robot
Copy link
Contributor

@ahmetb: GitHub didn't allow me to request PR reviews from the following users: corneliusweig.

Note that only kubernetes members and repo collaborators can review this PR, and authors cannot review their own PRs.

In response to this:

Context: Krew (https://sigs.k8s.io/krew) is a Kubernetes SIG CLI sub-project
that's been available for over a year. It is considered to be the de-facto tool
to discover and install kubectl plugins.

This patch details:

  • how to use Krew to discover/install plugins
  • how to distribute a kubectl plugin (with traditional package managers or
    using Krew).

/sig cli
/sig docs
/cc @corneliusweig

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 sig/cli Categorizes an issue or PR as relevant to SIG CLI. sig/docs Categorizes an issue or PR as relevant to SIG Docs. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. language/en Issues or PRs related to English language size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Sep 11, 2019
@netlify
Copy link

netlify bot commented Sep 11, 2019

Deploy preview for kubernetes-io-master-staging ready!

Built with commit 45b9cad

https://deploy-preview-16322--kubernetes-io-master-staging.netlify.com

@netlify
Copy link

netlify bot commented Sep 11, 2019

Deploy preview for kubernetes-io-master-staging ready!

Built with commit 33c8be4

https://deploy-preview-16322--kubernetes-io-master-staging.netlify.com

@corneliusweig
Copy link
Contributor

The md links to krew and krew-index seem to be broken in some places (not all). See https://deploy-preview-16322--kubernetes-io-master-staging.netlify.com/docs/tasks/extend-kubectl/kubectl-plugins/#installing-kubectl-plugins. Maybe it would be better to always inline the link location?

Also, it might be worth adding another reference to krew in https://deploy-preview-16322--kubernetes-io-master-staging.netlify.com/docs/reference/kubectl/overview/#examples-creating-and-using-plugins.

@ahmetb
Copy link
Member Author

ahmetb commented Sep 11, 2019

Yeah clearly the markdown engine is broken or performing sub-optimally here.
I'll try to see if I can still preserve link aliases by moving them to the end.

Context: Krew (https://sigs.k8s.io/krew) is a Kubernetes SIG CLI sub-project
that's been available for over a year. It is considered to be the de-facto tool
to discover and install kubectl plugins.

This patch details:
- how to use Krew to discover/install plugins
- how to distribute a kubectl plugin (with traditional package managers or
  using Krew).

Signed-off-by: Ahmet Alp Balkan <[email protected]>
@ahmetb
Copy link
Member Author

ahmetb commented Sep 12, 2019

@corneliusweig
Copy link
Contributor

/milestone 1.16
Would be nice to get this in :)

@k8s-ci-robot
Copy link
Contributor

@corneliusweig: You must be a member of the kubernetes/website-milestone-maintainers GitHub team to set the milestone. If you believe you should be able to issue the /milestone command, please contact your Website milestone maintainers and have them propose you as an additional delegate for this responsibility.

In response to this:

/milestone 1.16
Would be nice to get this in :)

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.

@ahmetb
Copy link
Member Author

ahmetb commented Sep 13, 2019

/milestone 1.16

@k8s-ci-robot
Copy link
Contributor

@ahmetb: You must be a member of the kubernetes/website-milestone-maintainers GitHub team to set the milestone. If you believe you should be able to issue the /milestone command, please contact your Website milestone maintainers and have them propose you as an additional delegate for this responsibility.

In response to this:

/milestone 1.16

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.

@corneliusweig
Copy link
Contributor

corneliusweig commented Sep 13, 2019

/assign @zparnold
Would be great to see this land, as it would improve krew adoption rate.

Copy link
Contributor

@sftim sftim left a comment

Choose a reason for hiding this comment

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

Some informal feedback

@zacharysarah
Copy link
Contributor

@ahmetb 👋 What's the status of this PR?

@ahmetb
Copy link
Member Author

ahmetb commented Oct 13, 2019

Sorry I realized my notifications were turned off for the repo.
I will update soon.

Signed-off-by: Ahmet Alp Balkan <[email protected]>
@ahmetb
Copy link
Member Author

ahmetb commented Oct 21, 2019

@sftim appreciate the review, I just pushed some fixes.

@zparnold
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 Oct 23, 2019
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: zparnold

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 Oct 23, 2019
@k8s-ci-robot k8s-ci-robot merged commit 31bd87a into kubernetes:master Oct 23, 2019
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. language/en Issues or PRs related to English language lgtm "Looks good to me", indicates that a PR is ready to be merged. sig/cli Categorizes an issue or PR as relevant to SIG CLI. sig/docs Categorizes an issue or PR as relevant to SIG Docs. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants