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 plugin: support-bundle #196

Merged
merged 1 commit into from Aug 13, 2019

Conversation

@divolgin
Copy link
Contributor

commented Aug 6, 2019

This is a new plugin that generates a support bundle for a cluster.

Example:

kubectl troubleshoot https://troubleshoot.replicated.com

The generated support bundle can be manually inspected or uploaded to https://vendor.replicated.com for automated analysis.

@k8s-ci-robot

This comment has been minimized.

Copy link

commented Aug 6, 2019

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.


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.

@ahmetb

This comment has been minimized.

Copy link
Member

commented Aug 7, 2019

I think the name “troubleshoot” is far too generic per Krew’s naming guidelines.

  • It’s sort of a name grab (what happens when others want to develop troubleshooting plugins? what should they call them?)
  • name doesn’t sufficiently describe what the plugin does (troubleshoot what? Nodes? Volumes? Load balancers? Perf issues?)
@divolgin

This comment has been minimized.

Copy link
Contributor Author

commented Aug 7, 2019

I signed it

@divolgin

This comment has been minimized.

Copy link
Contributor Author

commented Aug 7, 2019

@ahmetb I see how that name is generic. The intention is to collect information that can be used for troubleshooting the entire cluster: nodes, volumes, load balancers, any applications that may be running on it, etc.... All this information is saved in a support bundle file.

I'll rename this to support-bundle. That's does seem more specific about what this plugin does: generates a support bundle from a cluster.

@ahmetb

This comment has been minimized.

Copy link
Member

commented Aug 8, 2019

Thanks, I think a name like support-bundle is definitely more appropriate and specific to make it clear that this is not as general-purpose as the original name reads.

@ahmetb

This comment has been minimized.

Copy link
Member

commented Aug 8, 2019

/lgtm
/hold

@divolgin divolgin force-pushed the divolgin:troubleshoot branch from 8dbdf45 to be25016 Aug 8, 2019

@k8s-ci-robot k8s-ci-robot removed the lgtm label Aug 8, 2019

@divolgin

This comment has been minimized.

Copy link
Contributor Author

commented Aug 8, 2019

@ahmetb I've changed the name to support-bundle

@ahmetb ahmetb changed the title Add plugin: troubleshoot Add plugin: support-bundle Aug 13, 2019

@ahmetb

This comment has been minimized.

Copy link
Member

commented Aug 13, 2019

Thanks. I will accept the plugin but you have 3 visible issues:

  1. the help message doesn't understand the new plugin name
kubectl support-bundle
Error: requires at least 1 arg(s), only received 0
Usage:
  troubleshoot [url] [flags]
  troubleshoot [command]
  1. please consider adding -n flag in addition to namespace.

  2. please consider importing auth plugins like gcp, azure, oidc etc in your code, otherwise this will not work with managed cloud clusters (e.g. GKE, AKS).

kubectl support-bundle https://troubleshoot.replicated.com
panic: No Auth Provider found for name "gcp"
@ahmetb

This comment has been minimized.

Copy link
Member

commented Aug 13, 2019

/hold cancel
/lgtm
/approve

@k8s-ci-robot k8s-ci-robot added lgtm and removed do-not-merge/hold labels Aug 13, 2019

@k8s-ci-robot

This comment has been minimized.

Copy link

commented Aug 13, 2019

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: ahmetb, divolgin

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 merged commit f5368c0 into kubernetes-sigs:master Aug 13, 2019

2 of 3 checks passed

tide Not mergeable. Needs approved, lgtm labels.
Details
cla/linuxfoundation divolgin authorized
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants
You can’t perform that action at this time.