Skip to content

Commit 4586741

Browse files
committed
copy edits and add section for using custom resources
1 parent 722b1a1 commit 4586741

3 files changed

Lines changed: 46 additions & 12 deletions

File tree

docs/vendor/preflight-defining.mdx

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ To add a preflight spec to a release for your application:
5050
For the complete list of available collectors and analyzers, see the [Collect](https://troubleshoot.sh/docs/collect/all/) and [Analyze](https://troubleshoot.sh/docs/analyze/) sections in the Troubleshoot documentation.
5151

5252
:::note
53-
The [clusterInfo](https://troubleshoot.sh/docs/collect/cluster-info/) and [clusterResources](https://troubleshoot.sh/docs/collect/cluster-resources/) collectors are included automatically to gather information about the cluster and cluster resources. You do not need manually include the `clusterInfo` or `clusterResources` collectors in the specification.
53+
Troubleshoot automatically includes the [clusterInfo](https://troubleshoot.sh/docs/collect/cluster-info/) and [clusterResources](https://troubleshoot.sh/docs/collect/cluster-resources/) collectors to gather information about the cluster and cluster resources. You do not need to manually include the `clusterInfo` or `clusterResources` collectors in the specification.
5454

5555
To use only the `clusterInfo` and `clusterResources` collectors, delete the `spec.collectors` key from the preflight spec.
5656
:::
@@ -67,14 +67,30 @@ To add a preflight spec to a release for your application:
6767

6868
## (Optional) Block installation with required (strict) preflights {#strict}
6969

70-
For applications installed with a Replicated installer (Embedded Cluster, KOTS, kURL), you can set any preflight analyzer to `strict: true`. When `strict: true` is set, any `fail` outcomes for the analyzer block the deployment of the release.
70+
For applications installed with a Replicated installer (Embedded Cluster, KOTS, kURL), you can set any preflight analyzer to `strict: true`. When you set `strict: true`, any `fail` outcomes for the analyzer block the deployment of the release.
7171

7272
:::note
73-
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.
73+
Troubleshoot ignores strict preflight analyzers if the `exclude` property is also included and evaluates to `true`. See [exclude](https://troubleshoot.sh/docs/analyze/#exclude) in the Troubleshoot documentation.
7474
:::
7575

76-
The following image shows how a `fail` outcome is displayed when `strict: true` is set on an analyzer, which prevents installation from continuing if the preflight check fails:
76+
The following image shows how a `fail` outcome appears when you set `strict: true` on an analyzer, which prevents installation from continuing if the preflight check fails:
7777

7878
![Preflight checks in Admin Console showing fail message with strict mode](/images/preflight-mysql-fail-strict.png)
7979

8080
[View a larger version of this image](/images/preflight-mysql-fail-strict.png)
81+
82+
## Add a preflight spec for non-Helm applications or installations with KOTS v1.100.3 and earlier
83+
84+
For non-Helm applications or KOTS v1.100.3 and earlier, add the following SupportBundle custom resource at the root level of your release:
85+
86+
```yaml
87+
# support-bundle.yaml
88+
89+
apiVersion: troubleshoot.sh/v1beta2
90+
kind: SupportBundle
91+
metadata:
92+
name: example
93+
spec:
94+
collectors: []
95+
analyzers: []
96+
```

docs/vendor/support-bundle-customizing.mdx

Lines changed: 22 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22

33
This topic describes how to add a default support bundle spec to a release for your application. It also describes how to customize the default support bundle spec based on your application's needs. For more information about support bundles, see [About Preflight Checks and Support Bundles](/vendor/preflight-support-bundle-about).
44

5-
The information in this topic applies to Helm applications and Kubernetes manifest-based application installed with Helm or with Replicated KOTS.
6-
75
## Add the default support bundle spec to a release
86

97
When you add an empty support bundle spec to your Helm chart, the spec automatically includes the [clusterInfo](https://troubleshoot.sh/docs/collect/cluster-info/) and [clusterResources](https://troubleshoot.sh/docs/collect/cluster-resources/) collectors by default. You do not need manually include these collectors in the spec.
@@ -13,7 +11,7 @@ To add the default support bundle spec to a release for your application:
1311
1. In your Helm chart `templates` directory, create a YAML file. Name the file `support-bundle.yaml` or similar.
1412

1513
:::note
16-
If your application is deployed as multiple Helm charts, Replicated recommends that you create separate support bundle specs for each subchart. This allows you to make specs that are specific to different components of your application. When a support bundle is generated, all the specs are combined to provide a single bundle.
14+
If you deploy your application as multiple Helm charts, Replicated recommends that you create separate support bundle specs for each subchart. This allows you to make specs that are specific to different components of your application. When Replicated generates a support bundle, it combines all the specs into a single bundle.
1715
:::
1816

1917
1. In the YAML file, add the following to create a Kubernetes Secret with the default support bundle spec:
@@ -41,7 +39,7 @@ To add the default support bundle spec to a release for your application:
4139
4240
1. (Recommended) Customize the default spec by adding more collectors and analyzers or editing the default collectors. See [Customize the default support bundle spec](#customize-the-spec) on this page.
4341
44-
1. If your application is deployed as multiple subcharts, repeat the previous steps to add a support bundle spec to the templates directory of each chart.
42+
1. If you deploy your application as multiple subcharts, repeat the previous steps to add a support bundle spec to the templates directory of each chart.
4543
4644
1. Test the support bundle by following the instructions in [Generating a Support Bundle](/vendor/support-bundle-generating).
4745
@@ -89,14 +87,14 @@ To add collectors and analyzers:
8987
- [postgresql](https://troubleshoot.sh/docs/analyze/postgresql/), [mysql](https://troubleshoot.sh/docs/analyze/mysql/), and [redis](https://troubleshoot.sh/docs/analyze/redis/)
9088

9189
:::note
92-
Good analyzers clearly identify failure modes and provide troubleshooting guidance for the user. For example, if you can identify a log message from your database component that indicates a problem, you should write an analyzer that checks for that log and provides a description of the error to the user.
90+
Good analyzers clearly identify failure modes and provide troubleshooting guidance for the user. For example, if you can identify a log message that indicates a problem in your database component, write an analyzer to check for that log. Include a description of the error for the user.
9391
:::
9492

9593
### Customize the default `clusterResources` collector
9694

9795
You can edit the default [`clusterResources`](https://troubleshoot.sh/docs/collect/cluster-resources/) using the following properties:
9896

99-
* `namespaces`: The list of namespaces where the resources and information is collected. If the `namespaces` key is not specified, then the `clusterResources` collector defaults to collecting information from all namespaces. The `default` namespace cannot be removed, but you can specify additional namespaces.
97+
* `namespaces`: The list of namespaces from which to collect resources and information. If the `namespaces` key is not specified, then the `clusterResources` collector defaults to collecting information from all namespaces. You cannot remove the `default` namespace, but you can specify additional namespaces.
10098

10199
* `ignoreRBAC`: When true, the `clusterResources` collector does not check for RBAC authorization before collecting resource information from each namespace. This is useful when your cluster uses authorization webhooks that do not support SelfSubjectRuleReviews. Defaults to false.
102100

@@ -135,9 +133,9 @@ For more information, see [Namespace](/reference/template-functions-static-conte
135133

136134
### Exclude the default collectors
137135

138-
Although Replicated recommends including the default `clusterInfo` and `clusterResources` collectors because they collect a large amount of data to help with installation and debugging, you can optionally exclude them.
136+
Replicated recommends including the default `clusterInfo` and `clusterResources` collectors because they collect a large amount of data for installation and debugging. However, you can exclude them.
139137

140-
The following example shows how to exclude both the clusterInfo and clusterResources collectors from your support bundle spec:
138+
The following example shows how to exclude both the `clusterInfo` and `clusterResources` collectors from your support bundle spec:
141139

142140
```yaml
143141
spec:
@@ -147,3 +145,19 @@ spec:
147145
- clusterResources:
148146
exclude: true
149147
```
148+
149+
## Add a support bundle spec for non-Helm applications or installations with KOTS v1.94.1 and earlier
150+
151+
For non-Helm applications or KOTS v1.94.1 and earlier, add the following SupportBundle custom resource at the root level of your release:
152+
153+
```yaml
154+
# support-bundle.yaml
155+
156+
apiVersion: troubleshoot.sh/v1beta2
157+
kind: SupportBundle
158+
metadata:
159+
name: example
160+
spec:
161+
collectors: []
162+
analyzers: []
163+
```

styles/config/vocabularies/TechJargon/accept.txt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,3 +94,7 @@ ttl
9494
keyless
9595
liveness
9696
Unmute
97+
98+
subchart
99+
subcharts
100+
namespaces

0 commit comments

Comments
 (0)