Skip to content

Commit 058dcee

Browse files
paigecalvertpaigecalvert
committed
work in progress
1 parent 6726736 commit 058dcee

File tree

1 file changed

+128
-33
lines changed

1 file changed

+128
-33
lines changed

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

Lines changed: 128 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,136 @@
11
import GitOpsNotRecommended from "../partials/gitops/_gitops-not-recommended.mdx"
22

3-
# Built-in License Fields
3+
# Working with Built-in License Fields
44

5-
Built-in fields are reserved field names. The table below describes each built-in license field that you can define for a customer.
5+
This topic describes the built-in license fields that are available when creating a customer in the Replicated Vendor Portal. It also includes information about how to set default values for the built-in license fields.
66

7-
## Setting Initial License Field Values (Beta)
8-
The initial values that populate the "Create Customer" form in the Vendor Portal, can be set from the License Fields page by clicking the edit icon for the row.
9-
![Edit Initial Value](/images/edit-initial-value.png)
10-
This will ensure that each time a user clicks "Create Customer" they start with a set of default values that you specify.
7+
## Set Initial Values for Built-In License Fields (Beta)
8+
9+
You can set the initial values that will populate the **Create Customer** form in the Vendor Portal when a new customer is created. This ensures that each new customer created from the Vendor Portal UI starts with the same set of built-in license field values.
10+
11+
These initial values that you can set for built-in license fields differ from default values in that setting initial values does not update the license field values for any existing customers.
1112

12-
## License Field Details
1313
:::note
14-
License fields labeled "KOTS Only" in the table below apply only to Replicated KOTS installations.
14+
Initial values set in the Vendor Portal UI are not applied to new customers created through the Vendor API.
1515
:::
1616

17-
| License field | Description |
18-
|------------------------|------------------------|
19-
| `appSlug` | Application slug value. This value never changes. |
20-
| `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. |
21-
| `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. |
22-
| `customerName` | The name of the customer. |
23-
| `endpoint` | (KOTS Only) The endpoint that the KOTS Admin Console uses to synchronize license and download updates. This is typically `https://replicated.app`. |
24-
| `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).|
25-
| `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>|
26-
| `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. |
27-
| `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. |
28-
| `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).|
29-
| `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. |
30-
| `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. |
31-
| `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_. |
32-
| `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. |
33-
| `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`. |
34-
| `licenseID`, `licenseId` | ID of the installed license. This value never changes. |
35-
| `licenseSequence` | Every time a license is updated, its sequence number is incremented. This value represents the license sequence that the client currently has. |
36-
| `licenseType` | This field contains a string value that describes the type of the license. This is currently one of `paid`, `trial`, `dev`, `single-tenant-vendor-managed` or `community`. For more information about license types, see [Managing License Type](licenses-about-types).|
37-
| `signature` | The base64 encoded license signature. This value will change when license is updated. |
38-
| `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.|
39-
| `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.|
40-
| `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. |
41-
| `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. |
17+
To set inital values for the built-in license fields:
18+
19+
1. In the Vendor Portal, go to **License Fields**.
20+
21+
1. Under **Built-in license options**, click **Edit** next to each license field where you want to set an initial value.
22+
23+
![Edit Initial Value](/images/edit-initial-value.png)
24+
25+
[View a larger version of this image](/images/edit-initial-value.png)
26+
27+
## Built-In License fields
28+
29+
Built-in fields are reserved field names. The table below describes each built-in license field.
30+
31+
<table>
32+
<tr>
33+
<td>License field</td>
34+
<td>Description</td>
35+
</tr>
36+
<tr>
37+
<td>`appSlug`, `app_id`</td>
38+
<td>The unique application slug that the customer is associated with. This value never changes.</td>
39+
</tr>
40+
<tr>
41+
<td>`channelID`, `channel_id`</td>
42+
<td>The ID of the channel where the customer is assigned. When the customer's assigned channel changes, the latest release from that channel will be downloaded on the next update check.</td>
43+
</tr>
44+
<tr>
45+
<td>`channelName`, `channel_name`</td>
46+
<td>The name of the channel where the customer is assigned. When the customer's assigned channel changes, the latest release from that channel will be downloaded on the next update check.</td>
47+
</tr>
48+
<tr>
49+
<td>`name`, `customerName`</td>
50+
<td>The name of the customer.</td>
51+
</tr>
52+
<tr>
53+
<td>`email`</td>
54+
<td>The customer email address.</td>
55+
</tr>
56+
<tr>
57+
<td>`endpoint`</td>
58+
<td>(KOTS/kURL/Embedded Cluster Only) The endpoint that the KOTS Admin Console uses to synchronize license and download updates. This is typically `https://replicated.app`.</td>
59+
</tr>
60+
<tr>
61+
<td>`entitlements`, `entitlementValues`</td>
62+
<td>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).</td>
63+
</tr>
64+
<tr>
65+
<td>`expires_at`</td>
66+
<td><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></td>
67+
</tr>
68+
<tr>
69+
<td>`expires_in`</td>
70+
<td>Expiration period for the license. For example, `30d`.</td>
71+
</tr>
72+
<tr>
73+
<td>`isAirgapSupported`</td>
74+
<td>(KOTS/kURL/Embedded Cluster Only) If a license supports air gap installations with the Replicated installers, 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.</td>
75+
</tr>
76+
<tr>
77+
<td>`isGeoaxisSupported`</td>
78+
<td>(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.</td>
79+
</tr>
80+
<tr>
81+
<td>`isGitOpsSupported`</td>
82+
<td><GitOpsNotRecommended/> (KOTS Existing Cluster 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).</td>
83+
</tr>
84+
<tr>
85+
<td>`isIdentityServiceSupported`</td>
86+
<td>(KOTS Existing Cluster 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.</td>
87+
</tr>
88+
<tr>
89+
<td>`isKotsInstallEnabled`</td>
90+
<td>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.</td>
91+
</tr>
92+
<tr>
93+
<td>`isSemverRequired`</td>
94+
<td>(KOTS/kURL/Embedded Cluster 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_.</td>
95+
</tr>
96+
<tr>
97+
<td>`isSnapshotSupported`</td>
98+
<td>(KOTS Existing Cluster 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.</td>
99+
</tr>
100+
<tr>
101+
<td>`isSupportBundleUploadSupported`</td>
102+
<td>(KOTS/kURL/Embedded Cluster 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`.</td>
103+
</tr>
104+
<tr>
105+
<td>`licenseID`, `licenseId`</td>
106+
<td>ID of the installed license. This value never changes.</td>
107+
</tr>
108+
<tr>
109+
<td>`licenseSequence`</td>
110+
<td>Every time a license is updated, its sequence number is incremented. This value represents the license sequence that the client currently has.</td>
111+
</tr>
112+
<tr>
113+
<td>`type`, `licenseType`</td>
114+
<td>A string value that describes the type of the license, which is one of the following: `paid`, `trial`, `dev`, `single-tenant-vendor-managed` or `community`. For more information about license types, see [Managing License Type](licenses-about-types).</td>
115+
</tr>
116+
<tr>
117+
<td>`signature`</td>
118+
<td>The base64-encoded license signature. This value will change when the license is updated.</td>
119+
</tr>
120+
<tr>
121+
<td>`isHelmAirgapEnabled`</td>
122+
<td>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.</td>
123+
</tr>
124+
<tr>
125+
<td>`isHelmInstallEnabled`</td>
126+
<td>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.</td>
127+
</tr>
128+
<tr>
129+
<td>`isKurlInstallEnabled`</td>
130+
<td>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.</td>
131+
</tr>
132+
<tr>
133+
<td>`isEmbeddedClusterDownloadEnabled`</td>
134+
<td>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.</td>
135+
</tr>
136+
</table>

0 commit comments

Comments
 (0)