Skip to content

Commit 086f858

Browse files
authored
Merge pull request #217 from replicatedhq/laverya/krew-yaml-refactor
refactor krew yaml to match upstream format
2 parents 89b4979 + eb90b6d commit 086f858

File tree

2 files changed

+31
-33
lines changed

2 files changed

+31
-33
lines changed

deploy/krew/preflight.yaml

Lines changed: 17 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,23 @@ spec:
4040
bin: preflight.exe
4141
shortDescription: Executes application preflight tests in a cluster
4242
homepage: https://github.com/replicatedhq/troubleshoot
43-
caveats: |
43+
description: |
44+
This plugin executes application-specific preflight checks and conformance
45+
tests against a cluster, prior to installation of an application.
46+
47+
Application developers can create and host a Preflight manifest that
48+
defines the minimum and desired Kubernetes environment for an application.
49+
Before installing the application, a cluster admin can use this plugin to
50+
execute the application preflight checksto identify any missing
51+
components, configuration or incompatibilities between the cluster and the
52+
desired environment.
53+
54+
When executing Preflight tests, the test results will be displayed in a
55+
terminal-based UI on the workstation that executed the command.
56+
57+
For information on creating a Preflight manifest, view the documentation
58+
at https://help.replicated.com/docs/troubleshoot/kubernetes/analysis/
59+
4460
Usage:
4561
$ kubectl preflight <uri/path>
4662
@@ -59,20 +75,3 @@ spec:
5975
6076
For application developers writing collectors and analyzers:
6177
https://help.replicated.com/docs/troubleshoot/kubernetes/collectors/defining-collectors/
62-
63-
description: |
64-
This plugin executes application-specific preflight checks and conformance
65-
tests against a cluster, prior to installation of an application.
66-
67-
Application developers can create and host a Preflight manifest that
68-
defines the minimum and desired Kubernetes environment for an application.
69-
Before installing the application, a cluster admin can use this plugin to
70-
execute the application preflight checksto identify any missing
71-
components, configuration or incompatibilities between the cluster and the
72-
desired environment.
73-
74-
When executing Preflight tests, the test results will be displayed in a
75-
terminal-based UI on the workstation that executed the command.
76-
77-
For information on creating a Preflight manifest, view the documentation
78-
at https://help.replicated.com/docs/troubleshoot/kubernetes/analysis/

deploy/krew/support-bundle.yaml

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,20 @@ spec:
4040
bin: support-bundle.exe
4141
shortDescription: Creates support bundles for off-cluster analysis
4242
homepage: https://github.com/replicatedhq/troubleshoot
43-
caveats: |
43+
description: |
44+
This plugin collects information about the cluster, and automatically
45+
redacts sensitive data from being collected. This can optionally include
46+
application-specific data. The plugin writes the collected files into a
47+
single archive named support-bundle.tar.gz. This archive can be manually
48+
inspected or uploaded to https://vendor.replicated.com for automated
49+
analysis.
50+
51+
Application developers can create and host a Collector manifest that
52+
defines information to be collected.
53+
54+
For information on creating a Collector manifest, view the documentation
55+
at https://help.replicated.com/docs/troubleshoot/kubernetes/collectors/defining-collectors/
56+
4457
Usage:
4558
$ kubectl support-bundle <uri>
4659
@@ -59,17 +72,3 @@ spec:
5972
6073
For application developers writing collectors and analyzers:
6174
https://help.replicated.com/docs/troubleshoot/kubernetes/collectors/defining-collectors/
62-
63-
description: |
64-
This plugin collects information about the cluster, and automatically
65-
redacts sensitive data from being collected. This can optionally include
66-
application-specific data. The plugin writes the collected files into a
67-
single archive named support-bundle.tar.gz. This archive can be manually
68-
inspected or uploaded to https://vendor.replicated.com for automated
69-
analysis.
70-
71-
Application developers can create and host a Collector manifest that
72-
defines information to be collected.
73-
74-
For information on creating a Collector manifest, view the documentation
75-
at https://help.replicated.com/docs/troubleshoot/kubernetes/collectors/defining-collectors/

0 commit comments

Comments
 (0)