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/reference/custom-resource-preflight.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -110,11 +110,11 @@ The following fields are supported on all optional analyzers for preflights and
110
110
</tr>
111
111
<tr>
112
112
<td><code>exclude</code></td>
113
-
<td>(Optional) For KOTS only, a condition based on the runtime available configuration can be specified in the <code>exclude</code> field. This is useful for deployment techniques that allow templating for KOTS and the optional KOTS Helm component. When this value is <code>true</code>, the analyzer is not included.</td>
113
+
<td>(Optional) A condition based on the runtime available configuration can be specified in the <code>exclude</code> field. This is useful for deployment techniques that allow templating for KOTS and the optional KOTS Helm component. When this value is <code>true</code>, the analyzer is not included.</td>
114
114
</tr>
115
115
<tr>
116
116
<td><code>strict</code></td>
117
-
<td>(Optional) For KOTS only, an analyzer can be set to <code>strict: true</code> so that <code>fail</code> outcomes for that analyzer prevent the release from deploying until the vendor-specified requirements are met. When <code>exclude: true</code> is also specified, <code>exclude</code> overrides <code>strict</code> and the analyzer is not executed.</td>
117
+
<td>(Optional) An analyzer can be set to <code>strict: true</code> so that <code>fail</code> outcomes for that analyzer prevent the release from being deployed by KOTS until the vendor-specified requirements are met. When <code>exclude: true</code> is also specified, <code>exclude</code> overrides <code>strict</code> and the analyzer is not executed.</td>
Copy file name to clipboardExpand all lines: docs/vendor/customer-reporting.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -80,8 +80,8 @@ The **Instances** section displays the following details about each active insta
80
80
* The Kubernetes version running in the cluster.
81
81
* Whether the instance is installed in a Replicated kURL cluster.
82
82
* (kURL Clusters Only) The number of nodes ready in the cluster.
83
-
*(KOTS Only) The KOTS version running in the cluster.
84
-
*(Replicated SDK Only) The Replicated SDK version running in the cluster.
83
+
* The KOTS version running in the cluster.
84
+
* The Replicated SDK version running in the cluster.
85
85
* The cloud provider and region, if applicable.
86
86
* Instance uptime data, including:
87
87
* The timestamp of the last recorded check-in for the instance. For more information about what triggers an instance check-in, see [How the Vendor Portal Collects Instance Data](instance-insights-event-data#about-reporting) in _About Instance and Event Data_.
Copy file name to clipboardExpand all lines: docs/vendor/licenses-about.mdx
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -95,7 +95,7 @@ Replicated enforces the following logic when a license expires:
95
95
To change the behavior of your application when a license expires, you can can add custom logic in your application that queries the `expires_at` field using the Replicated SDK in-cluster API. For more information, see [Querying Entitlements with the Replicated SDK API](/vendor/licenses-reference-sdk).
96
96
* Expired licenses cannot log in to the Replicated registry to pull a Helm chart for installation or upgrade.
97
97
* Expired licenses cannot pull application images through the Replicated proxy registry or from the Replicated registry.
98
-
*(KOTS Only) KOTS prevents instances with expired licenses from receiving updates.
98
+
* KOTS prevents instances with expired licenses from receiving updates.
99
99
100
100
## About Customer Channel Assignment {#channel-assignment}
101
101
@@ -127,7 +127,7 @@ From the **Customers** page, you can do the following:
127
127
128
128
* Click the **Manage customer** button to edit details such as the customer name and email, the custom license fields assigned to the customer, and the license expiration policy. For more information, see [Creating and Managing Customers](releases-creating-customer).
129
129
130
-
*(KOTS Only) Download the license file for each customer.
130
+
* Download the license file for each customer.
131
131
132
132
* Click the **Customer reporting** button to view data about the active application instances associated with each customer. For more information, see [Customer Reporting](customer-reporting).
Copy file name to clipboardExpand all lines: docs/vendor/licenses-using-builtin-fields.mdx
+9-9Lines changed: 9 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,17 +10,17 @@ Built-in fields are reserved field names. The following table describes each bui
10
10
|`channelID`| Current channel ID from which releases will be downloaded. When channel changes, the latest release of that will be downloaded on the next update check. |
11
11
|`channelName`| Current channel name from which releases will be downloaded. When channel changes, the latest release of that will be downloaded on the next update check. |
12
12
|`customerName`| The name of the customer. |
13
-
|`endpoint`|(KOTS Only) The endpoint that the Replicated Admin Console uses to synchronize license and download updates. This is typically `https://replicated.app`. |
13
+
|`endpoint`| The endpoint that the Replicated Admin Console uses to synchronize license and download updates. This is typically `https://replicated.app`. |
14
14
|`entitlements`| The `entitlements` property includes the `expires_at` field and any custom entitlements for the license. For more information about adding custom license fields, see [Managing Custom License Fields](licenses-adding-custom-fields).|
15
15
|`expires_at`| <p>Defines the expiration date for the license. The date is encoded in ISO 8601 format (`2026-01-23T00:00:00Z`) and is set to midnight UTC on the date selected. If a license does not expire, this field is missing.</p><p>By default, instances with an expired license continue to run. Additionally, instances installed with KOTS that have an expired license do not receive updates. For more information about the default behavior when a license expires, see [License Expiration Handling](licenses-about#expiration) in _About Customers_.</p>|
16
-
|`isAirgapSupported`|(KOTS Only) If a license supports air gapped installations, then this field is set to `true`. If air gapped is not supported, this field is missing. When you enable this feature, the `.rli` file will have license meta data embedded in it, and must be re-downloaded. |
17
-
|`isGeoaxisSupported`|(KOTS Only) If a license supports integration with GeoAxis, this field is set to `true`. If GeoAxis is not supported, this field is either `false` or missing. **Note**: This field requires that the vendor has the GeoAxis entitlement. It also requires that the vendor has access to the Identity Service entitlement. |
18
-
|`isGitOpsSupported`| <GitOpsNotRecommended/> (KOTS Only) If a license supports the KOTS AutoGitOps workflow in the Admin Console, this field is set to `true`. If Auto-GitOps is not supported, this field is either `false` or missing. See [KOTS Auto-GitOps Workflow](/enterprise/gitops-workflow).|
19
-
|`isIdentityServiceSupported`|(KOTS Only) If a license supports identity-service enablement for the Admin Console, this field is set to `true`. If identity service is not supported, this field is either `false` or missing. **Note**: This field requires that the vendor have access to the Identity Service entitlement. |
20
-
|`isKotsInstallEnabled`|(KOTS Only) If a license supports installation with KOTS, this field is set to `true`. If KOTS installations are not supported, this field is either `false` or missing. **Note**: This field requires that the vendor has the KOTS entitlement. |
21
-
|`isSemverRequired`|(KOTS Only) If set to `true`, this field requires that the Admin Console orders releases according to Semantic Versioning. This field is controlled at the channel level. For more information about enabling Semantic Versioning on a channel, see [Semantic Versioning](releases-about#semantic-versioning) in _About Releases_. |
22
-
|`isSnapshotSupported`|(KOTS Only) If a license supports the snapshots backup and restore feature, this field is set to `true`. If a license does not support snapshots, this field is either missing or `false`. **Note**: This field requires that the vendor have access to the Snapshots entitlement. |
23
-
|`isSupportBundleUploadSupported`|(KOTS Only) If a license supports uploading a support bundle in the Admin Console, this field is set to `true`. If a license does not support uploading a support bundle, this field is either missing or `false`. |
16
+
|`isAirgapSupported`| If a license supports air gapped installations, then this field is set to `true`. If air gapped is not supported, this field is missing. When you enable this feature, the `.rli` file will have license meta data embedded in it, and must be re-downloaded. |
17
+
|`isGeoaxisSupported`| If a license supports integration with GeoAxis, this field is set to `true`. If GeoAxis is not supported, this field is either `false` or missing. **Note**: This field requires that the vendor has the GeoAxis entitlement. It also requires that the vendor has access to the Identity Service entitlement. |
18
+
|`isGitOpsSupported`| <GitOpsNotRecommended/> If a license supports the KOTS AutoGitOps workflow in the Admin Console, this field is set to `true`. If Auto-GitOps is not supported, this field is either `false` or missing. See [KOTS Auto-GitOps Workflow](/enterprise/gitops-workflow).|
19
+
|`isIdentityServiceSupported`| If a license supports identity-service enablement for the Admin Console, this field is set to `true`. If identity service is not supported, this field is either `false` or missing. **Note**: This field requires that the vendor have access to the Identity Service entitlement. |
20
+
|`isKotsInstallEnabled`| If a license supports installation with KOTS, this field is set to `true`. If KOTS installations are not supported, this field is either `false` or missing. **Note**: This field requires that the vendor has the KOTS entitlement. |
21
+
|`isSemverRequired`| If set to `true`, this field requires that the Admin Console orders releases according to Semantic Versioning. This field is controlled at the channel level. For more information about enabling Semantic Versioning on a channel, see [Semantic Versioning](releases-about#semantic-versioning) in _About Releases_. |
22
+
|`isSnapshotSupported`| If a license supports the snapshots backup and restore feature, this field is set to `true`. If a license does not support snapshots, this field is either missing or `false`. **Note**: This field requires that the vendor have access to the Snapshots entitlement. |
23
+
|`isSupportBundleUploadSupported`| If a license supports uploading a support bundle in the Admin Console, this field is set to `true`. If a license does not support uploading a support bundle, this field is either missing or `false`. |
24
24
|`licenseID`, `licenseId`| ID of the installed license. This value never changes. |
25
25
|`licenseSequence`| Every time a license is updated, its sequence number is incremented. This value represents the license sequence that the client currently has. |
26
26
|`licenseType`| This field contains a string value that describes the type of the license. This is currently one of `paid`, `trial`, `dev` or `community`. For more information about license types, see [Managing License Type](licenses-about-types).|
1. (KOTS Only) For applications that support installation with Replicated KOTS, to enable semantic versioning on the channel if it is not enabled by default, turn on **Enable semantic versioning**. For more information about semantic versioning and defaults, see [Semantic Versioning](releases-about#semantic-versioning).
21
+
1. (Recommended) Enable semantic versioning on the channel if it is not enabled by default by turning on **Enable semantic versioning**. For more information about semantic versioning and defaults, see [Semantic Versioning](releases-about#semantic-versioning).
22
22
23
-
1. (KOTS Only) For applications that support installation with KOTS, to enable an air gap bundle format that supports image digests and deduplication of image layers, turn on **Enable new air gap bundle format**. For more information, see [Using Image Tags and Digests](private-images-tags-digests).
23
+
1. (Recommended) Enable an air gap bundle format that supports image digests and deduplication of image layers, by turning on **Enable new air gap bundle format**. For more information, see [Using Image Tags and Digests](private-images-tags-digests).
Copy file name to clipboardExpand all lines: docs/vendor/releases-creating-cli.mdx
+2-26Lines changed: 2 additions & 26 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -47,7 +47,7 @@ To create and promote a release:
47
47
mv wordpress-1.3.5.tgz manifests
48
48
```
49
49
50
-
1.(KOTS Only) In the same directory that contains the release files, add a HelmChart custom resource for each Helm chart in the release. See [Configuring the HelmChart Custom Resource](helm-native-v2-using).
50
+
1. In the same directory that contains the release files, add a HelmChart custom resource for each Helm chart in the release. See [Configuring the HelmChart Custom Resource](helm-native-v2-using).
51
51
52
52
1. Lint the application manifest files and ensure that there are no errors in the YAML:
53
53
@@ -110,28 +110,4 @@ To create and promote a release:
110
110
111
111
```
112
112
replicated release ls
113
-
```
114
-
115
-
## Create a Release With One Helm Chart Only
116
-
117
-
For applications that contain only one Helm chart, you can use the `--chart` flag to create a release.
118
-
119
-
To create a release that contains one Helm chart:
120
-
121
-
1. Package the chart as a `.tgz` file. See [Packaging a Helm Chart for a Release](/vendor/helm-install-release).
Copy file name to clipboardExpand all lines: docs/vendor/releases-creating-customer.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -38,7 +38,7 @@ To create a customer:
38
38
39
39
1. For **Customer type**, set the customer type. Customer type is used only for reporting purposes. Customer access to your application is not affected by the type you assign to them. By default, **Trial** is selected. For more information, see [About Customer License Types](licenses-about-types).
40
40
41
-
1.(KOTS Only) In the **License options** pane, configure any of the built-in KOTS entitlements that you support in your application. For more information, see [Built-in License Fields](licenses-using-builtin-fields).
41
+
1. In the **License options** pane, configure any of the built-in KOTS entitlements that you support in your application. For more information, see [Built-in License Fields](licenses-using-builtin-fields).
Copy file name to clipboardExpand all lines: docs/vendor/releases-creating-releases.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -56,7 +56,7 @@ To create and promote a release in the Vendor Portal:
56
56
<tr>
57
57
<td>Requirements</td>
58
58
<td>
59
-
(KOTS Only) Select the <strong>Prevent this release from being skipped during upgrades</strong> to mark the release as required for KOTS installations. This option does not apply to installations with Helm.
59
+
Select the <strong>Prevent this release from being skipped during upgrades</strong> to mark the release as required for KOTS installations. This option does not apply to installations with Helm.
Copy file name to clipboardExpand all lines: docs/vendor/telemetry-air-gap.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -62,7 +62,7 @@ To collect telemetry from air gap instances:
62
62
63
63
For more information, see [Generating Support Bundles](/vendor/support-bundle-generating).
64
64
65
-
*(KOTS Only) For KOTS installations, users can also generate and download a support bundle from the Admin Console **Troubleshoot** tab to ensure that telemetry and custom metrics are included. See [Generating a Support Bundle Using the Admin Console](/enterprise/troubleshooting-an-app#generate-a-bundle-from-the-admin-console).
65
+
*Users can also generate and download a support bundle from the KOTS Admin Console **Troubleshoot** tab to ensure that telemetry and custom metrics are included. See [Generating a Support Bundle Using the Admin Console](/enterprise/troubleshooting-an-app#generate-a-bundle-from-the-admin-console).
66
66
67
67
1. After receiving the support bundle from your customer, go to the Vendor Portal **Customers**, **Customer Reporting**, or **Instance Details** page and upload the support bundle:
0 commit comments