Skip to content

Commit

Permalink
Merge pull request #217 from replicatedhq/laverya/krew-yaml-refactor
Browse files Browse the repository at this point in the history
refactor krew yaml to match upstream format
  • Loading branch information
laverya committed Jun 17, 2020
2 parents 89b4979 + eb90b6d commit 086f858
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 33 deletions.
35 changes: 17 additions & 18 deletions deploy/krew/preflight.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,23 @@ spec:
bin: preflight.exe
shortDescription: Executes application preflight tests in a cluster
homepage: https://github.com/replicatedhq/troubleshoot
caveats: |
description: |
This plugin executes application-specific preflight checks and conformance
tests against a cluster, prior to installation of an application.
Application developers can create and host a Preflight manifest that
defines the minimum and desired Kubernetes environment for an application.
Before installing the application, a cluster admin can use this plugin to
execute the application preflight checksto identify any missing
components, configuration or incompatibilities between the cluster and the
desired environment.
When executing Preflight tests, the test results will be displayed in a
terminal-based UI on the workstation that executed the command.
For information on creating a Preflight manifest, view the documentation
at https://help.replicated.com/docs/troubleshoot/kubernetes/analysis/
Usage:
$ kubectl preflight <uri/path>
Expand All @@ -59,20 +75,3 @@ spec:
For application developers writing collectors and analyzers:
https://help.replicated.com/docs/troubleshoot/kubernetes/collectors/defining-collectors/
description: |
This plugin executes application-specific preflight checks and conformance
tests against a cluster, prior to installation of an application.
Application developers can create and host a Preflight manifest that
defines the minimum and desired Kubernetes environment for an application.
Before installing the application, a cluster admin can use this plugin to
execute the application preflight checksto identify any missing
components, configuration or incompatibilities between the cluster and the
desired environment.
When executing Preflight tests, the test results will be displayed in a
terminal-based UI on the workstation that executed the command.
For information on creating a Preflight manifest, view the documentation
at https://help.replicated.com/docs/troubleshoot/kubernetes/analysis/
29 changes: 14 additions & 15 deletions deploy/krew/support-bundle.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,20 @@ spec:
bin: support-bundle.exe
shortDescription: Creates support bundles for off-cluster analysis
homepage: https://github.com/replicatedhq/troubleshoot
caveats: |
description: |
This plugin collects information about the cluster, and automatically
redacts sensitive data from being collected. This can optionally include
application-specific data. The plugin writes the collected files into a
single archive named support-bundle.tar.gz. This archive can be manually
inspected or uploaded to https://vendor.replicated.com for automated
analysis.
Application developers can create and host a Collector manifest that
defines information to be collected.
For information on creating a Collector manifest, view the documentation
at https://help.replicated.com/docs/troubleshoot/kubernetes/collectors/defining-collectors/
Usage:
$ kubectl support-bundle <uri>
Expand All @@ -59,17 +72,3 @@ spec:
For application developers writing collectors and analyzers:
https://help.replicated.com/docs/troubleshoot/kubernetes/collectors/defining-collectors/
description: |
This plugin collects information about the cluster, and automatically
redacts sensitive data from being collected. This can optionally include
application-specific data. The plugin writes the collected files into a
single archive named support-bundle.tar.gz. This archive can be manually
inspected or uploaded to https://vendor.replicated.com for automated
analysis.
Application developers can create and host a Collector manifest that
defines information to be collected.
For information on creating a Collector manifest, view the documentation
at https://help.replicated.com/docs/troubleshoot/kubernetes/collectors/defining-collectors/

0 comments on commit 086f858

Please sign in to comment.