Skip to content

Commit c0dfd79

Browse files
committed
update to not suggest installing the CRDs
1 parent 1420030 commit c0dfd79

3 files changed

Lines changed: 6 additions & 6 deletions

File tree

docs/reference/linter.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1129,8 +1129,8 @@ For more information, see [LintConfig](custom-resource-lintconfig).
11291129
<tr>
11301130
<th>Description</th>
11311131
<td>
1132-
<p>Notifies if a Helm chart contains a top-level <code>kind: Preflight</code> or <code>kind: SupportBundle</code> custom resource without also including the corresponding CRD (<code>preflights.troubleshoot.sh</code> or <code>supportbundles.troubleshoot.sh</code>) in the chart's <code>crds/</code> directory or templates.</p>
1133-
<p>Bare Preflight or SupportBundle custom resources inside a Helm chart require the matching CRD to be installed in the cluster before the chart is applied. In most shared clusters, that CRD is not present and installing it requires cluster-admin permissions. Embed the spec in a Kubernetes Secret with the <code>troubleshoot.sh/kind</code> label instead. See <a href="/vendor/preflight-defining">Define preflight checks</a> and <a href="/vendor/support-bundle-customizing">Add and customize support bundles</a>.</p>
1132+
<p>Notifies if a Helm chart contains a top-level <code>kind: Preflight</code> or <code>kind: SupportBundle</code> custom resource.</p>
1133+
<p>Preflight and SupportBundle custom resources cannot be applied directly from a Helm chart — they require cluster-side CRDs that are not available in most shared clusters and that need cluster-admin permissions to install. Embed the spec in a Kubernetes Secret with the <code>troubleshoot.sh/kind</code> label instead. See <a href="/vendor/preflight-defining">Define preflight checks</a> and <a href="/vendor/support-bundle-customizing">Add and customize support bundles</a>.</p>
11341134
</td>
11351135
</tr>
11361136
<tr>

docs/vendor/preflight-defining.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ You can define preflight checks in a Kubernetes Secret or in a Preflight custom
2121
For Helm applications installed with Helm or KOTS v1.101.0 or later, define preflight checks in a Kubernetes Secret in your Helm chart `templates`. This allows you to define the preflights spec only one time to support running preflight checks in both Helm and KOTS installations.
2222

2323
:::note
24-
Preflight checks must be defined in a Kubernetes Secret (or ConfigMap) when included inside a Helm chart's `templates` directory. A bare `kind: Preflight` custom resource in a chart requires the `preflights.troubleshoot.sh` CRD to be installed in the cluster, which is not available in most shared clusters and requires cluster-admin permissions. The Secret-based approach works in any cluster without additional setup. For more information, see [Discover Cluster Specs](https://troubleshoot.sh/docs/support-bundle/discover-cluster-specs/) in the Troubleshoot documentation.
24+
Preflight checks must be defined in a Kubernetes Secret (or ConfigMap) when included inside a Helm chart's `templates` directory. Do not place a bare `kind: Preflight` custom resource inside a Helm chart — that pattern is not supported in most shared clusters. The Secret-based approach works in any cluster without additional setup. For more information, see [Discover Cluster Specs](https://troubleshoot.sh/docs/support-bundle/discover-cluster-specs/) in the Troubleshoot documentation.
2525
:::
2626

2727
Add the following YAML to a Kubernetes Secret in your Helm chart `templates` directory:
@@ -55,7 +55,7 @@ Define preflight checks in a Preflight custom resource for the following install
5555
* Kubernetes manifest-based applications installed with any version of KOTS, where the resource is in the root of the release (not inside a Helm chart)
5656
* Helm applications installed with KOTS v1.100.3 and earlier
5757
:::note
58-
For Helm charts installed with KOTS v1.101.0 and later, Replicated recommends that you define preflight checks in a Secret in the Helm chart `templates` instead of using the Preflight custom resource. See [Create a Secret](#secret) above. A bare `kind: Preflight` resource inside a Helm chart requires the `preflights.troubleshoot.sh` CRD to be installed in the cluster.
58+
For Helm charts installed with KOTS v1.101.0 and later, Replicated recommends that you define preflight checks in a Secret in the Helm chart `templates` instead of using the Preflight custom resource. See [Create a Secret](#secret) above. Do not place a bare `kind: Preflight` resource inside a Helm chart.
5959

6060
In KOTS v1.101.0 and later, preflights defined in the Helm chart override the Preflight custom resource used by KOTS. During installation, if KOTS v1.101.0 and later cannot find preflights specified in the Helm chart archive, then KOTS searches for `kind: Preflight` in the root of the release.
6161
:::

docs/vendor/support-bundle-customizing.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ You can define support bundle specs in a Kubernetes Secret for the following ins
2525
* Helm applications installed with KOTS v1.94.2 and later
2626

2727
:::note
28-
Support bundle specs must be defined in a Kubernetes Secret (or ConfigMap) when included inside a Helm chart's `templates` directory. A bare `kind: SupportBundle` custom resource in a chart requires the `supportbundles.troubleshoot.sh` CRD to be installed in the cluster, which is not available in most shared clusters and requires cluster-admin permissions. The Secret-based approach works in any cluster without additional setup. For more information, see [Discover Cluster Specs](https://troubleshoot.sh/docs/support-bundle/discover-cluster-specs/) in the Troubleshoot documentation.
28+
Support bundle specs must be defined in a Kubernetes Secret (or ConfigMap) when included inside a Helm chart's `templates` directory. Do not place a bare `kind: SupportBundle` custom resource inside a Helm chart — that pattern is not supported in most shared clusters. The Secret-based approach works in any cluster without additional setup. For more information, see [Discover Cluster Specs](https://troubleshoot.sh/docs/support-bundle/discover-cluster-specs/) in the Troubleshoot documentation.
2929
:::
3030

3131
In your Helm chart `templates` directory, add the following YAML to a Kubernetes Secret:
@@ -72,7 +72,7 @@ You can define support bundle specs in a SupportBundle custom resource for the f
7272
* Helm applications installed with KOTS v1.94.1 and earlier
7373

7474
:::note
75-
A bare `kind: SupportBundle` custom resource is only appropriate at the root of a release. If you place this manifest inside a Helm chart's `templates` directory, the `supportbundles.troubleshoot.sh` CRD must be installed in the cluster before the chart is deployed. For Helm charts, use the Secret-based approach in [Kubernetes secret](#secret) instead.
75+
A bare `kind: SupportBundle` custom resource is only appropriate at the root of a release. Do not place this manifest inside a Helm chart's `templates` directory. For Helm charts, use the Secret-based approach in [Kubernetes secret](#secret) instead.
7676
:::
7777

7878
In the root of a release for your application (outside of any Helm chart), add the following YAML to a new `support-bundle.yaml` manifest file:

0 commit comments

Comments
 (0)