From 13df9a0f87bc1c2a14d02cfea678bed3cc9eb4c1 Mon Sep 17 00:00:00 2001 From: Andrew Lavery Date: Wed, 17 Jun 2020 14:37:38 -0400 Subject: [PATCH 1/2] refactor krew yaml to match upstream format --- deploy/krew/preflight.yaml | 35 ++++++++++++++++----------------- deploy/krew/support-bundle.yaml | 28 +++++++++++++------------- 2 files changed, 31 insertions(+), 32 deletions(-) diff --git a/deploy/krew/preflight.yaml b/deploy/krew/preflight.yaml index 47a682bc5..37abbf767 100644 --- a/deploy/krew/preflight.yaml +++ b/deploy/krew/preflight.yaml @@ -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 @@ -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/ diff --git a/deploy/krew/support-bundle.yaml b/deploy/krew/support-bundle.yaml index c4b072ef7..e926645fe 100644 --- a/deploy/krew/support-bundle.yaml +++ b/deploy/krew/support-bundle.yaml @@ -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 @@ -60,16 +73,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/ From eb90b6d935356491b7a9aa4e8cc989168fb00453 Mon Sep 17 00:00:00 2001 From: Andrew Lavery Date: Wed, 17 Jun 2020 14:44:20 -0400 Subject: [PATCH 2/2] remove extra trailing whitespace --- deploy/krew/support-bundle.yaml | 1 - 1 file changed, 1 deletion(-) diff --git a/deploy/krew/support-bundle.yaml b/deploy/krew/support-bundle.yaml index e926645fe..03ad5041c 100644 --- a/deploy/krew/support-bundle.yaml +++ b/deploy/krew/support-bundle.yaml @@ -72,4 +72,3 @@ spec: For application developers writing collectors and analyzers: https://help.replicated.com/docs/troubleshoot/kubernetes/collectors/defining-collectors/ -