Skip to content

Commit 1ff25ac

Browse files
committed
relabel kots only
1 parent e528a1c commit 1ff25ac

File tree

5 files changed

+23
-15
lines changed

5 files changed

+23
-15
lines changed

docs/reference/custom-resource-preflight.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -110,11 +110,11 @@ The following fields are supported on all optional analyzers for preflights and
110110
</tr>
111111
<tr>
112112
<td><code>exclude</code></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>
113+
<td>(Optional) (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>
114114
</tr>
115115
<tr>
116116
<td><code>strict</code></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>
117+
<td>(Optional) (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 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>
118118
</tr>
119119
</table>
120120

docs/reference/custom-resource-redactor.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
1-
# Redactor
1+
# Redactor (KOTS Only)
22

3-
This topic describes the Redactor custom resource.
3+
This topic describes how to define redactors with the Redactor custom resource.
4+
5+
:::note
6+
Custom redactors defined with the Redactor resource apply only to installations with Replicated KOTS.
7+
:::
48

59
## Overview
610

docs/vendor/customer-reporting.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ The **Instances** section displays the following details about each active insta
8080
* The Kubernetes version running in the cluster.
8181
* Whether the instance is installed in a Replicated kURL cluster.
8282
* (kURL Clusters Only) The number of nodes ready in the cluster.
83-
* The KOTS version running in the cluster.
83+
* (KOTS Only) The KOTS version running in the cluster.
8484
* The Replicated SDK version running in the cluster.
8585
* The cloud provider and region, if applicable.
8686
* Instance uptime data, including:

docs/vendor/licenses-about.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ Replicated enforces the following logic when a license expires:
9595
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).
9696
* Expired licenses cannot log in to the Replicated registry to pull a Helm chart for installation or upgrade.
9797
* Expired licenses cannot pull application images through the Replicated proxy registry or from the Replicated registry.
98-
* KOTS prevents instances with expired licenses from receiving updates.
98+
* In Replicated KOTS installations, KOTS prevents instances with expired licenses from receiving updates.
9999

100100
## About Customer Channel Assignment {#channel-assignment}
101101

docs/vendor/licenses-using-builtin-fields.mdx

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,23 +4,27 @@ import GitOpsNotRecommended from "../partials/gitops/_gitops-not-recommended.mdx
44

55
Built-in fields are reserved field names. The following table describes each built-in license field that you can define for a customer.
66

7+
:::note
8+
License fields labeled "KOTS Only" in the table below apply only to Replicated KOTS installations.
9+
:::
10+
711
| License field | Description |
812
|------------------------|------------------------|
913
| `appSlug` | Application slug value. This value never changes. |
1014
| `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. |
1115
| `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. |
1216
| `customerName` | The name of the customer. |
13-
| `endpoint` | The endpoint that the Replicated Admin Console uses to synchronize license and download updates. This is typically `https://replicated.app`. |
17+
| `endpoint` | (KOTS Only) The endpoint that the KOTS Admin Console uses to synchronize license and download updates. This is typically `https://replicated.app`. |
1418
| `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).|
1519
| `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` | 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`. |
20+
| `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. |
21+
| `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. |
22+
| `isGitOpsSupported` | (KOTS Only) <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).|
23+
| `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. |
24+
| `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. |
25+
| `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_. |
26+
| `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. |
27+
| `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`. |
2428
| `licenseID`, `licenseId` | ID of the installed license. This value never changes. |
2529
| `licenseSequence` | Every time a license is updated, its sequence number is incremented. This value represents the license sequence that the client currently has. |
2630
| `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).|

0 commit comments

Comments
 (0)