Skip to content

Commit 3b570a6

Browse files
authored
Update licenses-using-builtin-fields.mdx
1 parent 820535f commit 3b570a6

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ 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/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. |
20+
| `isAirgapSupported` | (KOTS/kURL/Embedded Cluster) If a license supports air gap installations with the Replicated installers (KOTS, kURL, or Embedded Cluster), then this field is set to `true`. If Replicated installer air gap installations are not supported, this field is missing. When you enable this field for a license, the `license.yaml` file will have license metadata embedded in it and must be re-downloaded. |
2121
| `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. |
@@ -29,7 +29,7 @@ License fields labeled "KOTS Only" in the table below apply only to Replicated K
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) |
32+
| `isHelmAirgapEnabled` | If a license supports Helm air gap installations, then this field is set to `true` or missing. If Helm air gap is not supported, this field is missing. When you enable this feature, the `license.yaml` file will have license metadata embedded in it and must be re-downloaded. This field requires that the "Install Types" feature is enabled for your Vendor Portal team. Reach out to your Replicated account representative to get access.|
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. This field requires that the "Install Types" feature is enabled for your Vendor Portal team. Reach out to your Replicated account representative to get access.|
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`. This field requires that the vendor has the kURL entitlement and a promoted kURL installer spec. This field also requires that the "Install Types" feature is enabled for your Vendor Portal team. Reach out to your Replicated account representative to get access. |
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`. This field requires that the vendor has the Embedded Cluster entitlement and that the release at the head of the channel includes an [Embedded Cluster Config](/reference/embedded-config) custom resource. This field also requires that the "Install Types" feature is enabled for your Vendor Portal team. Reach out to your Replicated account representative to get access. |

0 commit comments

Comments
 (0)