You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/vendor/preflight-defining.mdx
-2Lines changed: 0 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -76,8 +76,6 @@ For more information about the Preflight custom resource, see [Preflight and Sup
76
76
77
77
This section describes how to define collectors and analyzers for preflight checks based on your application needs. You add the collectors and analyzers that you want to use in the `spec.collectors` and `spec.analyzers` keys in the manifest file that you created.
78
78
79
-
For examples of collectors and analyzers defined in Kubernetes Secrets and Preflight custom resources, see [Example Specifications](#example-specifications) below.
80
-
81
79
### Collectors
82
80
83
81
Collectors gather information from the cluster, the environment, the application, or other sources. Collectors generate output that is then used by the analyzers that you define to generate results for the preflight checks.
Copy file name to clipboardExpand all lines: docs/vendor/support-bundle-customizing.mdx
+7-9Lines changed: 7 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,11 +14,11 @@ Use the following guidance to determine which type of manifest file to use for c
14
14
15
15
***(Recommended) Helm or KOTS v1.94.2 and Later**: For Helm applications installed with Helm or KOTS v1.94.2 or later, create the support bundle spec in a Kubernetes Secret in your Helm chart `templates`. See [Kubernetes Secret](#secret).
16
16
17
-
***KOTS v1.94.1 and Earlier**: For Helm applications installed with KOTS v1.94.1 or earlier, create the support bundle spec in a Preflight custom resource. See [Preflight Custom Resource](#preflight-cr).
17
+
***KOTS v1.94.1 and Earlier**: For Helm applications installed with KOTS v1.94.1 or earlier, create the support bundle spec in a Preflight custom resource. See [SupportBundle Custom Resource](#sb-cr).
18
18
19
-
***Kubernetes Manifest-Based Applications**: For Kubernetes manifest-based applications, create the support bundle spec in a Preflight custom resource. See [Preflight Custom Resource](#preflight-cr).
19
+
***Kubernetes Manifest-Based Applications**: For Kubernetes manifest-based applications, create the support bundle spec in a Preflight custom resource. See [SupportBundle Custom Resource](#sb-cr).
20
20
21
-
### Kubernetes Secret
21
+
### Kubernetes Secret{#secret}
22
22
23
23
You can define support bundle specs in a Kubernetes Secret for the following installation types:
24
24
* Installations with Helm
@@ -59,9 +59,9 @@ You do not need manually include the `clusterInfo` or `clusterResources` collect
59
59
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.
60
60
:::
61
61
62
-
After you create this empty support bundle spec, you can test the support bundle by following the instructions in [Generating a Support Bundle](/vendor/support-bundle-generating). You can also optionally customize the support bundle spec by adding collectors and analyzers or editing the default collectors. For more information, see [(Optional) Customize the spec](/vendor/support-bundle-customizing#optional-customize-the-spec) below.
62
+
After you create this empty support bundle spec, you can test the support bundle by following the instructions in [Generating a Support Bundle](/vendor/support-bundle-generating). You can customize the support bundle spec by adding collectors and analyzers or editing the default collectors. For more information, see [Step 2: Customize the spec](/vendor/support-bundle-customizing#customize-the-spec) below.
63
63
64
-
### SupportBundle Custom Resource
64
+
### SupportBundle Custom Resource {#sb-cr}
65
65
66
66
You can define support bundle specs in a SupportBundle custom resource for the following installation types:
67
67
* Kubernetes manifest-based applications installed with KOTS
@@ -86,16 +86,14 @@ This empty support bundle spec includes the following collectors by default:
86
86
87
87
You do not need manually include the `clusterInfo` or `clusterResources` collectors in the spec.
88
88
89
-
After you create this empty support bundle spec, you can test the support bundle by following the instructions in [Generating a Support Bundle](/vendor/support-bundle-generating). You can also optionally customize the support bundle spec by adding collectors and analyzers or editing the default collectors. For more information, see [(Optional) Customize the spec](/vendor/support-bundle-customizing#optional-customize-the-spec) below.
89
+
After you create this empty support bundle spec, you can test the support bundle by following the instructions in [Generating a Support Bundle](/vendor/support-bundle-generating). You can customize the support bundle spec by adding collectors and analyzers or editing the default collectors. For more information, see [Step 2: Customize the spec](/vendor/support-bundle-customizing#customize-the-spec) below.
90
90
91
-
## Step 2: Customize the Spec
91
+
## Step 2: Customize the Spec {#customize-the-spec}
92
92
93
93
You can customize the support bundles for your application by:
94
94
* Adding collectors and analyzers
95
95
* Editing or excluding the default `clusterInfo` and `clusterResources` collectors
96
96
97
-
For examples of collectors and analyzers defined in Kubernetes Secrets and Preflight custom resources, see [Example specs](#example-specs) below.
98
-
99
97
### Add Collectors
100
98
101
99
Collectors gather information from the cluster, the environment, the application, or other sources. Collectors generate output that is then used by the analyzers that you define.
0 commit comments