Skip to content

Commit b86bd98

Browse files
committed
edits
1 parent 4586741 commit b86bd98

2 files changed

Lines changed: 23 additions & 9 deletions

File tree

docs/vendor/preflight-defining.mdx

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -79,18 +79,20 @@ The following image shows how a `fail` outcome appears when you set `strict: tru
7979

8080
[View a larger version of this image](/images/preflight-mysql-fail-strict.png)
8181

82-
## Add a preflight spec for non-Helm applications or installations with KOTS v1.100.3 and earlier
82+
## Define preflights for non-Helm applications or KOTS v1.100.3 and earlier
8383

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:
84+
For non-Helm applications or installations with KOTS v1.100.3 and earlier, add the Preflight custom resource to a YAML file at the root level of your release:
8585

8686
```yaml
87-
# support-bundle.yaml
87+
# preflights.yaml
8888
8989
apiVersion: troubleshoot.sh/v1beta2
90-
kind: SupportBundle
90+
kind: Preflight
9191
metadata:
92-
name: example
92+
name: preflights
9393
spec:
9494
collectors: []
9595
analyzers: []
96-
```
96+
```
97+
98+
Customize the collectors and analyzers as desired.

docs/vendor/support-bundle-customizing.mdx

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,16 @@ To add collectors and analyzers:
9090
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.
9191
:::
9292

93+
1. Test the support bundle by following the instructions in [Generating a Support Bundle](/vendor/support-bundle-generating).
94+
95+
1. From the root directory of your Helm chart, package the chart into a `.tgz` archive:
96+
97+
```bash
98+
helm package --dependency-update .
99+
```
100+
101+
1. Add the chart archive to a new release. Promote the release to an internal development channel, and install the release in a development environment to test your changes.
102+
93103
### Customize the default `clusterResources` collector
94104

95105
You can edit the default [`clusterResources`](https://troubleshoot.sh/docs/collect/cluster-resources/) using the following properties:
@@ -146,9 +156,9 @@ spec:
146156
exclude: true
147157
```
148158

149-
## Add a support bundle spec for non-Helm applications or installations with KOTS v1.94.1 and earlier
159+
## Add a support bundle spec for non-Helm applications or KOTS v1.94.1 and earlier
150160

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:
161+
For non-Helm applications or installations with KOTS v1.94.1 and earlier, add the SupportBundle custom resource to a YAML file at the root level of your release:
152162

153163
```yaml
154164
# support-bundle.yaml
@@ -160,4 +170,6 @@ metadata:
160170
spec:
161171
collectors: []
162172
analyzers: []
163-
```
173+
```
174+
175+
Customize the collectors and analyzers as desired.

0 commit comments

Comments
 (0)