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/vendor/licenses-using-builtin-fields.mdx
+8-2Lines changed: 8 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,8 +2,14 @@ import GitOpsNotRecommended from "../partials/gitops/_gitops-not-recommended.mdx
2
2
3
3
# Built-in License Fields
4
4
5
-
Built-in fields are reserved field names. The following table describes each built-in license field that you can define for a customer.
5
+
Built-in fields are reserved field names. The table below describes each built-in license field that you can define for a customer.
6
6
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.
This will ensure that each time a user clicks "Create Customer" they start with a set of default values that you specify.
11
+
12
+
## License Field Details
7
13
:::note
8
14
License fields labeled "KOTS Only" in the table below apply only to Replicated KOTS installations.
9
15
:::
@@ -27,7 +33,7 @@ License fields labeled "KOTS Only" in the table below apply only to Replicated K
27
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`. |
28
34
|`licenseID`, `licenseId`| ID of the installed license. This value never changes. |
29
35
|`licenseSequence`| Every time a license is updated, its sequence number is incremented. This value represents the license sequence that the client currently has. |
30
-
|`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).|
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).|
31
37
|`signature`| The base64 encoded license signature. This value will change when license is updated. |
32
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.|
33
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.|
0 commit comments