split up builtin fields tables

Author: paigecalvert

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

@@ -6,15 +6,15 @@ This topic describes the built-in license fields that are available when creatin
 
 ## Set Initial Values for Built-In License Fields (Beta)
 
-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.
-
-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.
+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.
 
 :::note
-Initial values set in the Vendor Portal UI are not applied to new customers created through the Vendor API.
+Initial values are not applied to new customers created through the Vendor API v3.
 :::
 
-To set inital values for the built-in license fields:
+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 inital values for built-in license fields:
 
 1. In the Vendor Portal, go to **License Fields**.
 
@@ -24,113 +24,158 @@ To set inital values for the built-in license fields:
 
      [View a larger version of this image](/images/edit-initial-value.png)
 
-## Built-In License fields
+## Built-In License Fields
+
+Built-in license fields are reserved field names. You can interact with built-in license fields using the Vendor API v3 and the Replicated SDK API.
+
+### General License Properties
 
-Built-in fields are reserved field names. The table below describes each built-in license field.
+The table below describes the general built-in license fields:
 
 <table>
     <tr>
-        <td>License field</td>
-        <td>Description</td>
+      <td>License Field</td>
+      <td>Description</td>
+    </tr>
+    <tr>
+      <td>`app_id`, `appSlug`</td>
+      <td>The unique application slug that the customer is associated with. This value never changes.</td>
     </tr>
     <tr>
-        <td>`appSlug`, `app_id`</td>
-        <td>The unique application slug that the customer is associated with. This value never changes.</td>
+      <td>`channel_id`, `channelID`</td>
+      <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>
     </tr>
     <tr>
-        <td>`channelID`, `channel_id`</td>
-        <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>
+      <td>`channel_name`, `channelName`</td>
+      <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>
     </tr>
     <tr>
-        <td>`channelName`, `channel_name`</td>
-        <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>
+      <td>`custom_id`</td>
+      <td>The custom ID for the customer.</td>
     </tr>
     <tr>
-        <td>`name`, `customerName`</td>
-        <td>The name of the customer.</td>
+      <td>`customer_id`, `licenseID`</td>
+      <td>Unique customer identifier. This value never changes.</td>
     </tr>
     <tr>
-        <td>`email`</td>
-        <td>The customer email address.</td>
+      <td>`email`</td>
+      <td>The customer email address.</td>
     </tr>
     <tr>
         <td>`endpoint`</td>
-        <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>
+        <td>(Replicated Installers Only) The endpoint that the KOTS Admin Console uses to synchronize license and download updates. This is typically `https://replicated.app`.</td>
     </tr>
     <tr>
-        <td>`entitlements`, `entitlementValues`</td>
-        <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>
+      <td>`entitlements`, `entitlementValues`</td>
+      <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>
     </tr>
     <tr>
-        <td>`expires_at`</td>
-        <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>
+      <td>`expires_at`</td>
+      <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>
     </tr>
     <tr>
-        <td>`expires_in`</td>
-        <td>Expiration period for the license. For example, `30d`.</td>
+      <td>`expires_in`</td>
+      <td><p>Expiration period for the license. For example, `30d`.</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>
     </tr>
     <tr>
-        <td>`isAirgapSupported`</td>
-        <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>
+      <td>`licenseSequence`</td>
+      <td>Every time a license is updated, its sequence number is incremented. This value represents the license sequence that the client currently has.</td>
     </tr>
     <tr>
-        <td>`isGeoaxisSupported`</td>
-        <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>
+      <td>`name`, `customerName`</td>
+      <td>The name of the customer.</td>
     </tr>
     <tr>
-        <td>`isGitOpsSupported`</td>
-        <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>
+      <td>`signature`</td>
+      <td>The base64-encoded license signature. This value will change when the license is updated.</td>
     </tr>
     <tr>
-        <td>`isIdentityServiceSupported`</td>
-        <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>
+      <td>`type`, `licenseType`</td>
+      <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>
     </tr>
+</table>    
+
+### Install Types
+
+The table below describes the built-in license fields for install type. For more information, see [Managing Install Types for a License](/vendor/licenses-install-types).
+
+<table>
     <tr>
-        <td>`isKotsInstallEnabled`</td>
-        <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>
+      <td>License Field</td>
+      <td>Description</td>
     </tr>
     <tr>
-        <td>`isSemverRequired`</td>
-        <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>
+      <td>`is_embedded_cluster_download_enabled`, `isEmbeddedClusterDownloadEnabled`</td>
+      <td><p>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`.</p><p>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.</p></td>
     </tr>
     <tr>
-        <td>`isSnapshotSupported`</td>
-        <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>
+      <td>`is_helm_install_enabled`, `isHelmInstallEnabled`</td>
+      <td><p>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.</p><p> 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.</p></td>
     </tr>
     <tr>
-        <td>`isSupportBundleUploadSupported`</td>
-        <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>
+      <td>`is_kots_install_enabled`, `isKotsInstallEnabled`</td>
+      <td><p>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.</p><p>This field requires that the vendor has the KOTS entitlement.</p></td>
     </tr>
     <tr>
-        <td>`licenseID`, `licenseId`</td>
-        <td>ID of the installed license. This value never changes.</td>
+      <td>`is_kurl_install_enabled`, `isKurlInstallEnabled`</td>
+      <td><p>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`. </p><p>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.</p></td>
     </tr>
+</table>    
+
+### Additional Install Options 
+
+The table below describes the built-in license fields for additional install options:
+
+<table>
+  <tr>
+    <td>License Field</td>
+    <td>Description</td>
+  </tr>
+  <tr>
+    <td>`is_airgap_enabled`, `isAirgapSupported`</td>
+    <td><p>(Replicated Installers Only) 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.</p><p>When you enable this field for a license, the `license.yaml` file will have license metadata embedded in it and must be re-downloaded.</p></td>
+  </tr>
+  <tr>
+    <td>`is_helm_airgap_enabled`, `isHelmAirgapEnabled`</td>
+    <td><p>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.</p><p> When you enable this feature, the `license.yaml` file will have license metadata embedded in it and must be re-downloaded.</p><p>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.</p></td>
+  </tr>
+</table>    
+
+### Admin Console Feature Options
+
+The table below describes the built-in license fields for 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). 
+
+<table>
     <tr>
-        <td>`licenseSequence`</td>
-        <td>Every time a license is updated, its sequence number is incremented. This value represents the license sequence that the client currently has.</td>
+        <td>License Field</td>
+        <td>Description</td>
+    </tr>
+    <tr>
+        <td>`is_disaster_recovery_supported`</td>
+        <td>(Embedded Cluster Only) When enabled, Velero will be deployed for backup and restore in Embedded Cluster installations. This option is only applicable for Embedded Cluster installation types. For more information, see [Enabling Disaster Recovery for Embedded Cluster](/vendor/embedded-disaster-recovery).</td>
     </tr>
     <tr>
-        <td>`type`, `licenseType`</td>
-        <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>
+        <td>`is_geoaxis_supported`, `isGeoaxisSupported`</td>
+        <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>
     </tr>
     <tr>
-        <td>`signature`</td>
-        <td>The base64-encoded license signature. This value will change when the license is updated.</td>
+        <td>`is_gitops_supported`, `isGitOpsSupported`</td>
+        <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>
     </tr>
     <tr>
-        <td>`isHelmAirgapEnabled`</td>
-        <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>
+        <td>`is_identity_service_supported`, `isIdentityServiceSupported`</td>
+        <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>
     </tr>
     <tr>
-        <td>`isHelmInstallEnabled`</td>
-        <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>
+        <td>`isSemverRequired`</td>
+        <td>(Replicated Installers 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>
     </tr>
     <tr>
-        <td>`isKurlInstallEnabled`</td>
-        <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>
+        <td>`is_snapshot_supported`, `isSnapshotSupported`</td>
+        <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>
     </tr>
     <tr>
-        <td>`isEmbeddedClusterDownloadEnabled`</td>
-        <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>
+        <td>`is_support_bundle_upload_enabled`, `isSupportBundleUploadSupported`</td>
+        <td>(Replicated Installers 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>
     </tr>
 </table>