Skip to content

Commit f1ecd9a

Browse files
committed
edit license entitlements
1 parent 497b12b commit f1ecd9a

File tree

1 file changed

+21
-17
lines changed

1 file changed

+21
-17
lines changed

docs/vendor/replicated-onboarding.mdx

Lines changed: 21 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -482,6 +482,27 @@ The Embedded Cluster Config supports roles for multi-node clusters. One or more
482482

483483
For more information, see [roles](/reference/embedded-config#roles) in _Embedded Cluster Config_.
484484

485+
### Add and Map License Entitlements
486+
487+
You can add custom license entitlements for your application in the Vendor Portal. Custom license fields are useful when there is entitlement information that applies to a subset of customers. For example, you can use entitlements to:
488+
* Limit the number of active users permitted
489+
* Limit the number of nodes a customer is permitted on their cluster
490+
* Identify a customer on a "Premium" plan that has access to additional features or functionality not available with your base plan
491+
492+
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).
493+
494+
#### Map Entitlements to Helm Values
495+
496+
You can map license entitlements to your Helm values using KOTS template functions. This can be useful when you need to set certain values based on the user's license information. For more information, see [Using KOTS Template Functions](/vendor/helm-optional-value-keys#using-kots-template-functions) in _Setting Helm Values with KOTS_.
497+
498+
#### Query Entitlements Before Installation and at Runtime
499+
500+
You can add logic to your application to query license entitlements both before deployment and at runtime. For example, you might want to add preflight checks that verify a user's entitlements before installing. Or, you can expose additional product functionality dynamically at runtime based on a customer's entitlements.
501+
502+
For more information, see:
503+
* [Querying Entitlements with the Replicated SDK API](/vendor/licenses-reference-sdk)
504+
* [Checking Entitlements in Preflights with KOTS Template Functions](/vendor/licenses-referencing-fields)
505+
485506
### Add Application Links to the Admin Console Dashboard
486507

487508
You can add the Kubernetes SIG Application custom resource to your release to add a link to your application from the Admin Console dashboard. This makes it easier for users to access your application after installation.
@@ -508,23 +529,6 @@ The documentation for the open-source Troubleshoot project includes the full lis
508529

509530
You can also view common examples of collectors and analyzers used in preflight checks and support bundles in [Preflight Spec Examples](preflight-examples) and [Support Bundle Spec Examples](support-bundle-examples).
510531

511-
### Add Custom License Entitlements and Map to your Helm Chart
512-
513-
You can add custom license entitlements for your application in the Vendor Portal. Custom license fields are useful when there is entitlement information that applies to a subset of customers. For example, you can use entitlements to:
514-
* Limit the number of active users permitted
515-
* Limit the number of nodes a customer is permitted on their cluster
516-
* Identify a customer on a "Premium" plan that has access to additional features or functionality not available with your base plan
517-
518-
After you add custom entitlements, you can also add logic to your application to query license entitlements both before deployment and at runtime.
519-
520-
For more information, see:
521-
* [Managing Custom License Fields](/vendor/licenses-adding-custom-fields)
522-
* [Querying Entitlements with the Replicated SDK API](/vendor/licenses-reference-sdk)
523-
* [Checking Entitlements in Preflights with KOTS Template Functions](/vendor/licenses-referencing-fields)
524-
* [Verifying License Field Signatures with the Replicated SDK API](/vendor/licenses-verify-fields-sdk-api)
525-
* [Creating and Managing Customers](/vendor/releases-creating-customer)
526-
* [Developing Against the SDK API](/vendor/replicated-sdk-development)
527-
528532
### Configure Backup and Restore
529533

530534
Enable backup and restore with Velero for your application so that users can back up and restore their KOTS Admin Console and application data.

0 commit comments

Comments
 (0)