Skip to content

Commit 0306cf7

Browse files
committed
define install types option & include single tenant managed
1 parent 8cec4e4 commit 0306cf7

File tree

2 files changed

+9
-3
lines changed

2 files changed

+9
-3
lines changed

docs/vendor/licenses-about.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,8 @@ of your software.
2929
* **Paid**: The Paid type identifies the customer as a paying customer for which
3030
additional information can be provided.
3131
* **Community**: The Community type is designed for a free or low cost version of your application. For more details about this type, see [Community Licenses](licenses-about-types).
32+
* **Single Tenant Vendor Managed**: The Single Tenant Vendor Managed type is for customers for whom you're team is operating the application in infrastructure you fully control and operate. These are free to use, but come with limited support. (Beta feature ask your account rep or a PM for access.)
33+
3234

3335
Except Community licenses, the license type is used solely for reporting purposes and a customer's access to your application is not affected by the type that you assign.
3436

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

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,15 +17,19 @@ License fields labeled "KOTS Only" in the table below apply only to Replicated K
1717
| `endpoint` | (KOTS Only) The endpoint that the KOTS Admin Console uses to synchronize license and download updates. This is typically `https://replicated.app`. |
1818
| `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).|
1919
| `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>|
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. |
20+
| `isAirgapSupported` | (KOTS/kURL/Embedded Cluster) If a license supports Replicated Installer 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 `license.yaml` file will have license meta data embedded in it, and must be re-downloaded. |
21+
| `isGeoaxisSupported` | (kURL 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. |
2222
| `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).|
2323
| `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. |
24+
| `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. |
2525
| `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_. |
2626
| `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. |
2727
| `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`. |
2828
| `licenseID`, `licenseId` | ID of the installed license. This value never changes. |
2929
| `licenseSequence` | Every time a license is updated, its sequence number is incremented. This value represents the license sequence that the client currently has. |
3030
| `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).|
3131
| `signature` | The base64 encoded license signature. This value will change when license is updated. |
32+
| `isHelmAirgapEnabled` | If a license supports Helm air gapped installations, then this field is set to `true` or missing. If air gapped is not supported, this field is missing. When you enable this feature, the `license.yaml` file will have license meta data embedded in it, and must be re-downloaded. (Requires the "Install Types" Feature)|
33+
| `isHelmInstallEnabled` | If a license supports Helm installations, then this field is set to `true` or missing. If Helm installations are not supported, this field is set to `false`. This field requires that the vendor only packages the application as Helm charts and Replicated Custom Resources. (Requires the "Install Types" Feature)|
34+
| `isKurlInstallEnabled` | If a license supports installation with kURL, this field is set to `true` or missing. If kURL installations are not supported, this field is `false`. **Note**: This field requires that the vendor has the kURL entitlement and a promoted kURL manifest. (Requires the "Install Types" Feature) |
35+
| `isEmbeddedClusterDownloadEnabled` | If a license supports installation with Embedded Cluster, this field is set to `true` or missing. If Embedded Cluster installations are not supported, this field is `false`. **Note**: This field requires that the vendor has the Embedded Cluster entitlement and that the release at the head of the channel include an `embedded-cluster.yaml` custom resource. (Requires the "Install Types" Feature) |

0 commit comments

Comments
 (0)