diff --git a/docs/intro.md b/docs/intro.md index aaf6fd65be..c7e01f1b9d 100644 --- a/docs/intro.md +++ b/docs/intro.md @@ -210,7 +210,7 @@ pagination_next: null Creating and Managing Customers
  • - Managing Custom License Fields + Managing Customer License Fields
  • diff --git a/docs/reference/template-functions-license-context.md b/docs/reference/template-functions-license-context.md index 9c3b9a2ded..de301dfb15 100644 --- a/docs/reference/template-functions-license-context.md +++ b/docs/reference/template-functions-license-context.md @@ -4,7 +4,7 @@ ```go func LicenseFieldValue(name string) string ``` -LicenseFieldValue returns the value of the specified license field. LicenseFieldValue accepts custom license fields and all built-in license fields. For a list of all built-in fields, see [Built-in License Fields](/vendor/licenses-using-builtin-fields). +LicenseFieldValue returns the value of the specified license field. LicenseFieldValue accepts custom license fields and all built-in license fields. For a list of all built-in fields, see [Built-In License Fields](/vendor/licenses-using-builtin-fields). LicenseFieldValue always returns a string, regardless of the license field type. To return integer or boolean values, you need to use the [ParseInt](/reference/template-functions-static-context#parseint) or [ParseBool](/reference/template-functions-static-context#parsebool) template function to convert the string value. diff --git a/docs/vendor/licenses-about-types.md b/docs/vendor/licenses-about-types.md index cea6250d6c..312cd54360 100644 --- a/docs/vendor/licenses-about-types.md +++ b/docs/vendor/licenses-about-types.md @@ -1,4 +1,4 @@ -# Community Licenses +# About Community Licenses This topic describes community licenses. For more information about other types of licenses, see [License Types](licenses-about#license-types) in _About Customers_. diff --git a/docs/vendor/licenses-about.mdx b/docs/vendor/licenses-about.mdx index 50c8bcb353..93b814b4d3 100644 --- a/docs/vendor/licenses-about.mdx +++ b/docs/vendor/licenses-about.mdx @@ -36,13 +36,13 @@ Except Community licenses, the license type is used solely for reporting purpose You can change the type of a license at any time in the Vendor Portal. For example, if a customer upgraded from a trial to a paid account, then you could change their license type from Trial to Paid for reporting purposes. -### Built-in and Custom License Fields +### Built-In and Custom License Fields -Customer licenses have built-in fields and also support custom fields. +Each customer record in the Vendor Portal has built-in fields and also supports custom fields. -Built-in fields are reserved field names. You can specify the values for these fields to define entitlements for the customer. For example, Replicated includes built-in license fields to define the license expiration date, customer name, and application slug. For more information about built-in fields, see [Built-in License Fields](licenses-using-builtin-fields). +The built-in fields include values such as the customer name, customer email, and the license expiration date. You can optionally set initial values for the built-in fields so that each new customer created in the Vendor Portal starts with the same set of values. You can also create custom fields to define entitlements for your application. For example, you can create a custom field to set the number of active users permitted. -You can also create custom license fields to define entitlements specific to the customer. For example, you can create a custom license field to limit the number of active users permitted. For more information about creating custom license fields, see [Managing Custom License Fields](licenses-adding-custom-fields). +For more information, see [Managing Customer License Fields](/vendor/licenses-adding-custom-fields). ## About Updating Licenses diff --git a/docs/vendor/licenses-adding-custom-fields.md b/docs/vendor/licenses-adding-custom-fields.md index 4a3affe805..576e99128d 100644 --- a/docs/vendor/licenses-adding-custom-fields.md +++ b/docs/vendor/licenses-adding-custom-fields.md @@ -1,22 +1,38 @@ -# Managing Custom License Fields +# Managing Customer License Fields -In addition to the built-in license fields available through the Replicated vendor -portal, you can also create custom license fields for a customer. +This topic describes how to manage customer license fields in the Replicated Vendor Portal, including how to add custom fields and set initial values for the built-in fields. -For information about the fields that are included by default for each customer -license, see [Using built-in license fields](licenses-using-builtin-fields). +## Set Initial Values for Built-In License Fields (Beta) -## About Custom License Fields +You can set initial values to 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. -Custom license fields are useful when there is entitlement information that applies to a subset of customers. For example, you can create a custom license field to limit the number of active users permitted. Or, you can create a field that limits the number of nodes a customer is permitted on their cluster. +:::note +Initial values are not applied to new customers created through the Vendor API v3. For more information, see [Create a customer](https://replicated-vendor-api.readme.io/reference/createcustomer-1) in the Vendor API v3 documentation. +::: + +These _initial_ values differ from _default_ values in that setting initial values does not update the license field values for any existing customers. + +To set initial values for built-in license fields: + +1. In the Vendor Portal, go to **License Fields**. + +1. Under **Built-in license options**, click **Edit** next to each license field where you want to set an initial value. + + ![Edit Initial Value](/images/edit-initial-value.png) + + [View a larger version of this image](/images/edit-initial-value.png) + +## Manage Custom License Fields + +You can create custom license fields in the Vendor Portal. For example, you can create a custom license field to set the number of active users permitted. Or, you can create a field that sets the number of nodes a customer is permitted on their cluster. -The custom license fields that you create are displayed in the Vendor Portal for all new and existing customers. If the custom field is not hidden, it is also displayed under the **Licenses** tab for customers in the Replicated Admin Console. +The custom license fields that you create are displayed in the Vendor Portal for all new and existing customers. If the custom field is not hidden, it is also displayed to customers under the **Licenses** tab in the Replicated Admin Console. -## Limitation +### Limitation The maximum size for a license field value is 64KB. -## Create Custom License Fields +### Create Custom License Fields To create a custom license field: @@ -37,9 +53,9 @@ To create a custom license field: | Type| The field type. Supported formats include integer, string, text (multi-line string), and boolean values. This value cannot be changed. | | Default | The default value for the field for both existing and new customers. It is a best practice to provide a default value when possible. The maximum size for a license field value is 64KB. | | Required | If checked, this prevents the creation of customers unless this field is explicitly defined with a value. | - | Hidden | If checked, the field is not visible to your customer in the Replicated Admin Console. The field is still visible to you in the Vendor Portal. **Note**: The Hidden field is displayed only for vendors with access to the Replicated KOTS installer. | + | Hidden | If checked, the field is not visible to your customer in the Replicated Admin Console. The field is still visible to you in the Vendor Portal. **Note**: The Hidden field is displayed only for vendors with access to the Replicated installers (KOTS, kURL, Embedded Cluster). | -## Update Custom License Fields +### Update Custom License Fields To update a custom license field: @@ -47,10 +63,10 @@ To update a custom license field: 1. On the **License Fields** page, click **Edit Field** on the right side of the target row. Changing the default value for a field updates the value for each existing customer record that has not overridden the default value. :::important - Enabling **Is this field is required?** updates the license field to be required on all new and existing licenses. If you enable **Is this field is required?**, you must either set a default value for the field or manually update each existing license file to provide a value for the field. + Enabling **Is this field is required?** updates the license field to be required on all new and existing customers. If you enable **Is this field is required?**, you must either set a default value for the field or manually update each existing customer to provide a value for the field. ::: -## Set Customer-Specific Values for Custom License Fields +### Set Customer-Specific Values for Custom License Fields To set a customer-specific value for a custom license field: @@ -67,11 +83,11 @@ To set a customer-specific value for a custom license field: [View a larger version of this image](/images/customer-license-custom-fields.png) -## Delete Custom License Fields +### Delete Custom License Fields -Deleted license fields and their values do not appear in the customer's license in any location, including your view in the Vendor Portal, the downloaded YAML version of the license, and the Admin Console license screen. +Deleted license fields and their values do not appear in the customer's license in any location, including your view in the Vendor Portal, the downloaded YAML version of the license, and the Admin Console **License** screen. -By default, deleting a license field also deletes all of the values associated with the field in each customer record. +By default, deleting a custom license field also deletes all of the values associated with the field in each customer record. Only administrators can delete license fields. @@ -92,4 +108,4 @@ To delete a custom license field: If you enable **Preserve License Values**, you can create a new field with the same name and `type` as the deleted field to reinstate the preserved values. ::: -1. Follow the instructions in the dialog and click **Delete**. +1. Follow the instructions in the dialog and click **Delete**. \ No newline at end of file diff --git a/docs/vendor/licenses-download.md b/docs/vendor/licenses-download.md index 9a7c21f00c..0354d06dc9 100644 --- a/docs/vendor/licenses-download.md +++ b/docs/vendor/licenses-download.md @@ -8,7 +8,7 @@ For information about how to download customer licenses with the Vendor API v3, ## Download Licenses -A valid license file is required to install with Replicated KOTS. You can download license files for your customers from the **Customer** page in the Vendor Portal. +You can download license files for your customers from the **Customer** page in the Vendor Portal. To download a license: diff --git a/docs/vendor/licenses-reference-helm.md b/docs/vendor/licenses-reference-helm.md index 251c2020f7..a31903832a 100644 --- a/docs/vendor/licenses-reference-helm.md +++ b/docs/vendor/licenses-reference-helm.md @@ -39,7 +39,7 @@ To check entitlements before installation: 1. In the Vendor Portal, click **Customers**. Select a customer and click the **Manage customer** tab. Alternatively, click **+ Create customer** to create a new customer. For more information, see [Creating and Managing Customers](/vendor/releases-creating-customer). - 1. Edit the built-in license fields or add custom fields for the customer. For example, you can set a license expiration date in the **Expiration policy** field. Or, you can create a custom field that limits the number of nodes a user is permitted in their cluster. For more information, see [Managing Custom License Fields](/vendor/licenses-adding-custom-fields). + 1. Edit the built-in license fields or add custom fields for the customer. For example, you can set a license expiration date in the **Expiration policy** field. Or, you can create a custom field that limits the number of nodes a user is permitted in their cluster. For more information, see [Managing Customer License Fields](/vendor/licenses-adding-custom-fields). 1. In your Helm chart, update the Helm templates with one or more directives to access the license field. For example, you can access the built-in `expires_at` field with `{{ .Values.global.replicated.licenseFields.expires_at }}`. Add the desired logic to control application behavior based on the values of license fields. diff --git a/docs/vendor/licenses-reference-kots-runtime.mdx b/docs/vendor/licenses-reference-kots-runtime.mdx index 7f36e6d6ed..d18b570c90 100644 --- a/docs/vendor/licenses-reference-kots-runtime.mdx +++ b/docs/vendor/licenses-reference-kots-runtime.mdx @@ -10,9 +10,9 @@ Using the KOTS License API to check entitlements during runtime is _not_ recomme KOTS includes default logic to control access to features in the KOTS Admin Console and KOTS CLI based on the values for the built-in fields in the customer's license. For example, by default, KOTS uses the built-in `expires_at` field to prevent an instance from receiving updates when the customer license expires. You can add custom logic to your application to control the behavior of your application based on the built-in fields or any of the custom fields that you create. -For more information about creating custom license fields, see [Managing Custom License Fields](licenses-adding-custom-fields). For more information about the built-in license fields, see [Built-In License Fields](licenses-using-builtin-fields). +For information about creating custom license fields, see [Managing Customer License Fields](licenses-adding-custom-fields). For the list of built-in fields in customer licenses, see [Built-In License Fields](/vendor/licenses-using-builtin-fields). -The Replicated admin console runs on the customer's cluster and provides entitlement information during application runtime. You can query the admin console `/license/v1/license` endpoint to enforce entitlements at runtime. +The KOTS Admin Console runs on the customer's cluster and provides entitlement information during application runtime. You can query the admin console `/license/v1/license` endpoint to enforce entitlements at runtime. ## Query Fields diff --git a/docs/vendor/licenses-reference-sdk.mdx b/docs/vendor/licenses-reference-sdk.mdx index 27ad4b3a90..76f4cc410a 100644 --- a/docs/vendor/licenses-reference-sdk.mdx +++ b/docs/vendor/licenses-reference-sdk.mdx @@ -27,7 +27,7 @@ To use the SDK API to query entitlements at runtime: 1. In the Vendor Portal, click **Customers**. Select a customer and click the **Manage customer** tab. Alternatively, click **+ Create customer** to create a new customer. For more information, see [Creating and Managing Customers](/vendor/releases-creating-customer). - 1. Edit the built-in license fields or add custom fields for the customer. For example, you can set a license expiration date in the **Expiration policy** field. Or, you can create a custom field that limits the number of nodes a user is permitted in their cluster. For more information, see [Managing Custom License Fields](/vendor/licenses-adding-custom-fields). + 1. Edit the built-in fields and add custom fields for the customer. For example, you can set a license expiration date in the **Expiration policy** field. Or, you can create a custom field that limits the number of nodes a user is permitted in their cluster. For more information, see [Managing Customer License Fields](/vendor/licenses-adding-custom-fields). 1. (Recommended) Develop against the SDK API `license` endpoints locally: diff --git a/docs/vendor/licenses-referencing-fields.md b/docs/vendor/licenses-referencing-fields.md index 3801ec0ee3..10875bd224 100644 --- a/docs/vendor/licenses-referencing-fields.md +++ b/docs/vendor/licenses-referencing-fields.md @@ -6,7 +6,7 @@ This topic describes how to check custom entitlements before installation or upg KOTS includes default logic to control access to features in the Replicated Admin Console and KOTS CLI based on the values for the built-in fields in the customer's license. For example, by default, KOTS uses the built-in `expires_at` field to prevent an instance from receiving updates when the customer license expires. You can add custom logic to your application to control the behavior of your application based on the built-in fields or any of the custom fields that you create. -For more information about creating custom license fields, see [Managing Custom License Fields](licenses-adding-custom-fields). For more information about the built-in license fields, see [Built-In License Fields](licenses-using-builtin-fields). +For more information, see [Managing Customer License Fields](licenses-adding-custom-fields). For the list of built-in fields in customer licenses, see [Built-In License Fields](/vendor/licenses-using-builtin-fields). ## Add Preflights to Check Entitlements Before Installation or Upgrade {#install} diff --git a/docs/vendor/licenses-using-builtin-fields.mdx b/docs/vendor/licenses-using-builtin-fields.mdx index c34ba0955c..110ba424b4 100644 --- a/docs/vendor/licenses-using-builtin-fields.mdx +++ b/docs/vendor/licenses-using-builtin-fields.mdx @@ -1,35 +1,161 @@ import GitOpsNotRecommended from "../partials/gitops/_gitops-not-recommended.mdx" -# Built-in License Fields +# Built-In License Fields -Built-in fields are reserved field names. The following table describes each built-in license field that you can define for a customer. +This topic describes the built-in license fields that appear customer licenses for applications distributed with Replicated. + +## Overview + +The license associated with each customer record in the Replicated Vendor Portal includes several built-in fields. These built-in fields include customer properties (such as the customer name, customer email, and the Vendor Portal channel where the customer is assigned), the license expiration date, as well as the Replicated features that are enabled for the customer (such as the supported install types or Admin Console features). + +When a customer installs an application distributed with Replicated, the values for each built-in and custom field in their license can be accessed using the [Replicated SDK](/vendor/replicated-sdk-overview) in-cluster API [license](/reference/replicated-sdk-apis#license) endpoints. Applications installed with a Replicated installer (KOTS, kURL, Embedded Cluster) can also access license fields using the Replicated KOTS [LicenseFieldValue](/reference/template-functions-license-context#licensefieldvalue) template function. + +## License Field Names + +This section lists the built-in fields that are included in customer licenses for applications distributed with Replicated. :::note -License fields labeled "KOTS Only" in the table below apply only to Replicated KOTS installations. +The built-in license fields are reserved field names. ::: -| License field | Description | -|------------------------|------------------------| -| `appSlug` | Application slug value. This value never changes. | -| `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. | -| `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. | -| `customerName` | The name of the customer. | -| `endpoint` | (KOTS Only) The endpoint that the KOTS Admin Console uses to synchronize license and download updates. This is typically `https://replicated.app`. | -| `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).| -| `expires_at` |

    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.

    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_.

    | -| `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. | -| `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. | -| `isGitOpsSupported` | (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).| -| `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. | -| `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. | -| `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_. | -| `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. | -| `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`. | -| `licenseID`, `licenseId` | ID of the installed license. This value never changes. | -| `licenseSequence` | Every time a license is updated, its sequence number is incremented. This value represents the license sequence that the client currently has. | -| `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).| -| `signature` | The base64 encoded license signature. This value will change when license is updated. | -| `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.| -| `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.| -| `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. | -| `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. | +### General License Fields + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field NameDescription
    `appSlug`The unique application slug that the customer is associated with. This value never changes.
    `channelID`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.
    `channelName`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.
    `licenseID`, `licenseId`Unique ID for the installed license. This value never changes.
    `customerEmail`The customer email address.
    `endpoint`For applications installed with a Replicated installer (KOTS, kURL, Embedded Cluster), this is the endpoint that the KOTS Admin Console uses to synchronize the licenses and download updates. This is typically `https://replicated.app`.
    `entitlementValues`Includes both the built-in `expires_at` field and any custom license fields. For more information about adding custom license fields, see [Managing Customer License Fields](licenses-adding-custom-fields).
    `expires_at`

    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.

    For information about the default behavior when a license expires, see [License Expiration Handling](licenses-about#expiration) in _About Customers_.

    `licenseSequence`Every time a license is updated, its sequence number is incremented. This value represents the license sequence that the client currently has.
    `customerName`The name of the customer.
    `signature`The base64-encoded license signature. This value will change when the license is updated.
    `licenseType`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).
    + +### Install Types + +The table below describes the built-in license fields related to the supported install type(s). For more information, see [Managing Install Types for a License](/vendor/licenses-install-types). + + + + + + + + + + + + + + + + + + + + + + +
    Field NameDescription
    `isEmbeddedClusterDownloadEnabled`

    If a license supports installation with Replicated 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.

    `isHelmInstallEnabled`

    If a license supports Helm installations, 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 packages the application as Helm charts and, optionally, 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.

    `isKotsInstallEnabled`

    If a license supports installation with Replicated KOTS, this field is set to `true`. If KOTS installations are not supported, this field is either `false` or missing.

    This field requires that the vendor has the KOTS entitlement.

    `isKurlInstallEnabled`

    If a license supports installation with Replicated 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.

    + +### Install Options + +The table below describes the built-in license fields related to install options. + + + + + + + + + + + + + + +
    Field NameDescription
    `isAirgapSupported`

    If a license supports air gap installations with the Replicated installers (KOTS, kURL, 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.

    `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.

    + +### Admin Console Feature Options + +The table below describes the built-in license fields related to the Admin Console feature options. The Admin Console feature options apply only to licenses that support installation with the Replicated installers (KOTS, kURL, Embedded Cluster). + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field NameDescription
    `isDisasterRecoverySupported`If a license supports the Embedded Cluster disaster recovery feature, this field is set to `true`. If a license does not support disaster recovery for Embedded Cluster, this field is either missing or `false`. **Note**: Embedded Cluster Disaster Recovery is in Alpha. To get access to this feature, reach out to Alex Parker at [alexp@replicated.com](mailto:alexp@replicated.com). For more information, see [Disaster Recovery for Embedded Cluster](/vendor/embedded-disaster-recovery).
    `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.
    `isGitOpsSupported` 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).
    `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.
    `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_.
    `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.
    `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`.
    \ No newline at end of file diff --git a/docs/vendor/releases-creating-customer.mdx b/docs/vendor/releases-creating-customer.mdx index 51b6f23a3b..f694903521 100644 --- a/docs/vendor/releases-creating-customer.mdx +++ b/docs/vendor/releases-creating-customer.mdx @@ -50,7 +50,7 @@ To create a customer: 1. Enable any of the available options for the customer. For more information about the license options, see [Built-in License Fields](/vendor/licenses-using-builtin-fields). For more information about enabling install types, see [Managing Install Types for a License (Beta)](/vendor/licenses-install-types). -1. For **Custom fields**, configure any custom fields that you have added for your application. For more information about how to create custom fields for your application, see [Managing Custom License Fields](licenses-adding-custom-fields). +1. For **Custom fields**, configure any custom fields that you have added for your application. For more information about how to create custom fields for your application, see [Managing Customer License Fields](licenses-adding-custom-fields). 1. Click **Save Changes**. diff --git a/docs/vendor/replicated-onboarding.mdx b/docs/vendor/replicated-onboarding.mdx index 9a94322c04..9f56b5c028 100644 --- a/docs/vendor/replicated-onboarding.mdx +++ b/docs/vendor/replicated-onboarding.mdx @@ -499,7 +499,7 @@ You can add custom license entitlements for your application in the Vendor Porta * Limit the number of nodes a customer is permitted on their cluster * Identify a customer on a "Premium" plan that has access to additional features or functionality not available with your base plan -For more information about how to create and assign custom entitlements in the Vendor Portal, see [Managing Custom License Fields](/vendor/licenses-adding-custom-fields) and [Creating and Managing Customers](/vendor/releases-creating-customer). +For more information about how to create and assign custom entitlements in the Vendor Portal, see [Managing Customer License Fields](/vendor/licenses-adding-custom-fields) and [Creating and Managing Customers](/vendor/releases-creating-customer). #### Map Entitlements to Helm Values diff --git a/docs/vendor/replicated-sdk-development.md b/docs/vendor/replicated-sdk-development.md index c7ad2777f4..d4febb466f 100644 --- a/docs/vendor/replicated-sdk-development.md +++ b/docs/vendor/replicated-sdk-development.md @@ -39,7 +39,7 @@ To create a development license: 1. For **Expiration policy**, you can add an expiration date for the license. - 1. For **Custom fields**, you can add values for any custom license fields in your application. For information about how to create custom license fields, see [Managing Custom License Fields](/vendor/licenses-adding-custom-fields). + 1. For **Custom fields**, you can add values for any custom license fields in your application. For information about how to create custom license fields, see [Managing Customer License Fields](/vendor/licenses-adding-custom-fields). 1. Click **Save Changes**. diff --git a/sidebars.js b/sidebars.js index d94c94feb6..582fb19782 100644 --- a/sidebars.js +++ b/sidebars.js @@ -165,12 +165,11 @@ const sidebars = { }, { type: 'category', - label: 'Customer Licenses', + label: 'Customers and Licenses', items: [ 'vendor/licenses-about', 'vendor/releases-creating-customer', 'vendor/licenses-adding-custom-fields', - 'vendor/licenses-using-builtin-fields', 'vendor/licenses-install-types', 'vendor/licenses-about-types', 'vendor/licenses-download', @@ -178,6 +177,7 @@ const sidebars = { type: 'category', label: 'Querying License Entitlements', items: [ + 'vendor/licenses-using-builtin-fields', 'vendor/licenses-reference-sdk', 'vendor/licenses-reference-helm', 'vendor/licenses-referencing-fields', diff --git a/static/images/edit-initial-value.png b/static/images/edit-initial-value.png new file mode 100644 index 0000000000..f290a18d98 Binary files /dev/null and b/static/images/edit-initial-value.png differ