Skip to content

Commit e5dbe34

Browse files
committed
edits
1 parent cf27766 commit e5dbe34

File tree

2 files changed

+10
-10
lines changed

2 files changed

+10
-10
lines changed

docs/vendor/preflight-defining.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
11
# Defining Preflight Checks
22

3-
This topic describes how to define preflight checks in Helm- and standard Kubernetes manifest-based applications. For more information about preflight checks, see [About Preflight Checks and Support Bundles](/vendor/preflight-support-bundle-about).
3+
This topic describes how to define preflight checks in Helm and Kubernetes manifest-based applications. For more information about preflight checks, see [About Preflight Checks and Support Bundles](/vendor/preflight-support-bundle-about).
44

55
The information in this topic applies to applications that are installed with the Helm CLI or with Replicated KOTS.
66

77
## Step 1: Create the Manifest File
88

9-
You can define preflight checks in a Kubernetes Secret or in a Preflight custom resource. The type of manifest file that you use depends on your application type (Helm- or standard manifest-based) and the installation methods that your application supports (Helm CLI, KOTS v1.101.0 or later, or KOTS v1.100.3 or earlier).
9+
You can define preflight checks in a Kubernetes Secret or in a Preflight custom resource. The type of manifest file that you use depends on your application type (Helm or Kubernetes manifest-based) and the installation methods that your application supports (Helm CLI, KOTS v1.101.0 or later, or KOTS v1.100.3 or earlier).
1010

1111
* **Helm Applications**: For Helm applications, see the following guidance:
1212

13-
* **(Recommended) Helm CLI or KOTS v1.101.0 or Later**: For Helm-based applications installed with the Helm CLI or KOTS v1.101.0 or later, define the preflight checks in a Kubernetes Secret in your Helm chart `templates`. See [Kubernetes Secret](#secret).
13+
* **(Recommended) Helm CLI or KOTS v1.101.0 or Later**: For Helm applications installed with the Helm CLI or KOTS v1.101.0 or later, define the preflight checks in a Kubernetes Secret in your Helm chart `templates`. See [Kubernetes Secret](#secret).
1414

1515
* **KOTS v1.100.3 or Earlier**: For Helm applications installed with KOTS v1.100.3 or earlier, define the preflight checks in a Preflight custom resource. See [Preflight Custom Resource](#preflight-cr).
1616

17-
* **Standard Manifest-Based Applications**: For standard manifest-based applications, define the preflight checks in a Preflight custom resource. See [Preflight Custom Resource](#preflight-cr).
17+
* **Kubernetes Manifest-Based Applications**: For Kubernetes manifest-based applications, define the preflight checks in a Preflight custom resource. See [Preflight Custom Resource](#preflight-cr).
1818

1919
### Kubernetes Secret {#secret}
2020

@@ -50,7 +50,7 @@ As shown above, the Secret must include the following:
5050
### Preflight Custom Resource {#preflight-cr}
5151

5252
Define preflight checks in a Preflight custom resource for the following installation types:
53-
* Standard manifest-based applications installed with any version of KOTS
53+
* Kubernetes manifest-based applications installed with any version of KOTS
5454
* Helm applications installed with KOTS v1.100.3 and earlier
5555
:::note
5656
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.

docs/vendor/support-bundle-customizing.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
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 chart- and standard manifest-based application installed with Helm or with Replicated KOTS.
5+
The information in this topic applies to Helm applications and Kubernetes manifest-based application installed with Helm or with Replicated KOTS.
66

77
## Step 1: Add the Default Spec to a Manifest File
88

9-
You can add the support bundle spec to a Kubernetes Secret or a SupportBundle custom resource. The type of manifest file that you use depends on your application type (Helm chart- or standard manifest-based) and installation method (Helm CLI or KOTS).
9+
You can add the support bundle spec to a Kubernetes Secret or a SupportBundle custom resource. The type of manifest file that you use depends on your application type (Helm or manifest-based) and installation method (Helm CLI or KOTS).
1010

1111
Use the following guidance to determine which type of manifest file to use for creating a support bundle spec:
1212

@@ -16,7 +16,7 @@ Use the following guidance to determine which type of manifest file to use for c
1616

1717
* **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).
1818

19-
* **Standard Manifest-Based Applications**: For standard 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 [Preflight Custom Resource](#preflight-cr).
2020

2121
### Kubernetes Secret
2222

@@ -64,8 +64,8 @@ After you create this empty support bundle spec, you can test the support bundle
6464
### SupportBundle Custom Resource
6565

6666
You can define support bundle specs in a SupportBundle custom resource for the following installation types:
67-
* Standard manifest-based applications installed with KOTS
68-
* Helm chart-based applications installed with KOTS v1.94.1 and earlier
67+
* Kubernetes manifest-based applications installed with KOTS
68+
* Helm applications installed with KOTS v1.94.1 and earlier
6969

7070
In a release for your application, add the following YAML to a new `support-bundle.yaml` manifest file:
7171

0 commit comments

Comments
 (0)