HOLD FOR FEEDBACK: Add topic about sharing collectors and analyzers with helm templates #2610
Conversation
replicated-ci
added
type::docs
✅ Deploy Preview for replicated-docs-upgrade ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
✅ Deploy Preview for replicated-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
| import Tabs from '@theme/Tabs'; | ||
| import TabItem from '@theme/TabItem'; | ||
|
|
||
| # Example Preflight Specs |
There was a problem hiding this comment.
Moved the examples to their own topic to cut down on noise and make the examples easier to see from the docs sidebar
| import RunPodsSecret from "../partials/support-bundles/_run-pods-secret.mdx" | ||
| import RunPodsCr from "../partials/support-bundles/_run-pods-cr.mdx" | ||
|
|
||
| # Example Support Bundle Specs |
There was a problem hiding this comment.
Moved the examples to their own topic to cut down on noise and make the examples easier to see from the docs sidebar
| @@ -0,0 +1,191 @@ | |||
| import Overview from "../partials/support-bundles/_shared-collectors-analyzers.mdx" | |||
|
|
|||
| # Defining Shared Collectors and Analyzers with Helm Templating | |||
| @@ -1,11 +1,12 @@ | |||
| # About Modular Specifications | |||
| # About Creating Modular Specifications | |||
There was a problem hiding this comment.
This was an existing topic about taking a modular approach to defining support bundle specs (See https://docs.replicated.com/vendor/support-modular-support-bundle-specs)
I just did some updates to the overview, which I didn't find to be super descriptive.
This topic currently only provides an example of how a modular approach would work when defining support bundles in YAML files in your release manifests, as opposed to defining them in Secrets in your Helm templates. I think in a separate docs PR it would be good to add an example of using a modular approach by creating Secrets in the parent chart as well as in subcharts
| @@ -1,23 +1,16 @@ | |||
| # About Online Support Bundle Specifications | |||
| # Making Support Bundle Specs Available Online | |||
There was a problem hiding this comment.
Similar to above, this was an existing topic where I just updated the content in the overview a bit
| @@ -1,11 +1,12 @@ | |||
| # About Modular Specifications | |||
| # About Creating Modular Support Bundle Specs | |||
There was a problem hiding this comment.
This was an existing topic about taking a modular approach to defining support bundle specs (See https://docs.replicated.com/vendor/support-modular-support-bundle-specs)
I just did some updates to the overview, which I didn't find to be super descriptive.
This topic currently only provides an example of how a modular approach would work when defining support bundles in YAML files in your release manifests, as opposed to defining them in Secrets in your Helm templates. I think in a separate docs PR it would be good to add an example of using a modular approach by creating Secrets in the parent chart as well as in subcharts
|
|
||
| Preflight and support bundle specifications can be designed using a modular approach. This helps teams develop specifications that are scoped to individual components or microservices in a large application and avoid merge conflicts. |
There was a problem hiding this comment.
Q: This topic said "Preflight and support bundle specifications can be designed using a modular approach". However, it appeared only in the Support Bundle section the docs, and the example provided only shows using a modular approach with support bundles.
Is it accurate that this approach applies to preflight checks as well?
| @@ -138,172 +117,12 @@ For applications installed with KOTS, you can set any preflight analyzer to `str | |||
| Strict preflight analyzers are ignored if the `exclude` property is also included and evaluates to `true`. See [exclude](https://troubleshoot.sh/docs/analyze/#exclude) in the Troubleshoot documentation. | |||
| ::: | |||
|
|
|||
| ## Example Specifications | |||
| ### (Recommended) Define Shared Collectors and Analyzers with Helm | |||
There was a problem hiding this comment.
Added new section to call out that defining shared collectors and analyzers for Helm apps is recommended
| <RedisMysqlCr/> | ||
| </TabItem> | ||
| </Tabs> | ||
| ### (Recommended) Define Shared Collectors and Analyzers with Helm |
There was a problem hiding this comment.
Added new section to call out that defining shared collectors and analyzers for Helm apps is recommended
paigecalvert
changed the title
New topic that includes a procedure on how to add shared collectors/analyzers using Helm templates: https://deploy-preview-2610--replicated-docs-upgrade.netlify.app/vendor/preflight-support-bundle-shared
Added new subheadings to the main topics on creating preflight/support bundle specs to indicate that, for Helm apps, the method of creating shared collectors/analyzers is recommended: