Skip to content

Commit 2944856

Browse files
authored
Merge pull request #3926 from replicatedhq/update-platform-overview
update replicated platform intro
2 parents 7360497 + b1b09b8 commit 2944856

8 files changed

Lines changed: 209 additions & 163 deletions

File tree

docs/intro-replicated.mdx

Lines changed: 88 additions & 68 deletions
Large diffs are not rendered by default.

docs/partials/getting-started/_csdl-overview.mdx

Lines changed: 0 additions & 5 deletions
This file was deleted.

docs/partials/getting-started/_replicated-definition.mdx

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/vendor/licenses-referencing-fields.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,25 @@
11
# Check entitlements in preflights with Replicated template functions
22

3-
This topic describes how to check custom entitlements before installation or upgrade using preflight checks and Replicated template functions in the License context. The information in this topic applies to applications installed with KOTS.
3+
This topic describes how to check custom entitlements before installation or upgrade using preflight checks and Replicated template functions in the License context. The information in this topic applies to applications installed with a Replicated installer (Embedded Cluster, KOTS, kURL).
44

55
## Overview
66

7-
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.
7+
The Replicated installers include default logic to control the user experience based on the customer's built-in license fields.
8+
For example, by default, the Replicated installers use the built-in `expires_at` field to prevent an instance from receiving updates when the customer license expires.
9+
You can also 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.
810

9-
For more information, see [Manage 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).
11+
For more information, see [Manage Customer License Fields](licenses-adding-custom-fields).
12+
For the list of built-in fields in customer licenses, see [Built-In License Fields](/vendor/licenses-using-builtin-fields).
1013

1114
## Add preflights to check entitlements before installation or upgrade {#install}
1215

1316
To enforce entitlements when your customer installs or updates your application,
14-
you can use the Replicated LicenseFieldValue template function in your application to read the value of license fields. The LicenseFieldValue template function accepts the built-in license fields and any custom fields that you configure. For more information, see [LicenseFieldValue](/reference/template-functions-license-context#licensefieldvalue) in _License Context_.
17+
you can use the Replicated LicenseFieldValue template function in your application to read the value of license fields.
18+
The LicenseFieldValue template function accepts the built-in license fields and any custom fields that you configure.
19+
For more information, see [LicenseFieldValue](/reference/template-functions-license-context#licensefieldvalue) in _License Context_.
1520

16-
For example, a license might limit how many nodes are permitted in a customer's
17-
cluster. You could define this limit by creating a `node_count` custom license field:
21+
For example, a license might limit how many nodes are permitted in a customer's cluster.
22+
You could define this limit by creating a `node_count` custom license field:
1823

1924
| Name | Key | Type | Description |
2025
|------|-----|------|-------------|
@@ -40,7 +45,8 @@ spec:
4045
message: The number of nodes matches your license ({{repl LicenseFieldValue "node_count"}})
4146
```
4247
43-
In the example above, the preflight check uses the `nodeResources` analyzer and the value of the custom `node_count` field to determine if the customer has exceeded the maximum number of nodes permitted by their license. If the preflight checks fails, a failure message is displayed to the user and KOTS prevents the installation or upgrade from continuing.
48+
In the example above, the preflight check uses the `nodeResources` analyzer and the value of the custom `node_count` field to determine if the customer has exceeded the maximum number of nodes permitted by their license.
49+
If the preflight checks fails, a failure message is displayed to the user and KOTS prevents the installation or upgrade from continuing.
4450

4551
For more information about this example, see [How Can I Use License Custom Fields Value in a Pre-Flight Check?](https://help.replicated.com/community/t/how-can-i-use-license-custom-fields-value-in-a-pre-flight-check/624) in Replicated Community.
4652

docs/vendor/quick-start.mdx

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,13 @@ import Requirements from "../partials/embedded-cluster/v2/_requirements.mdx"
1111

1212
# Replicated quick start
1313

14-
This topic provides a quick start workflow to help new users learn about the Replicated Platform. Complete this quick start before you onboard your application to the platform.
14+
This topic provides a quick start workflow to help new users learn about the Replicated Platform.
15+
Complete this quick start before you onboard your application to the platform.
1516

1617
## Introduction
1718

18-
This quick start demonstrates how to create, install, and update releases for a sample Helm chart in the Replicated Platform. You will repeat these same basic steps to create and test releases throughout the onboarding process to integrate Replicated features with your own application.
19+
This quick start demonstrates how to create, install, and update releases for a sample Helm chart in the Replicated Platform.
20+
You will repeat these same basic steps to create and test releases throughout the onboarding process to integrate Replicated features with your own application.
1921

2022
The goals of this quick start are to introduce new Replicated users to the following common tasks for the purpose of preparing to onboard to the Replicated Platform:
2123

@@ -25,7 +27,7 @@ The goals of this quick start are to introduce new Replicated users to the follo
2527

2628
* Working with the Replicated CLI
2729

28-
* Installing and updating applications on a VM with Replicated Embedded Cluster through the Replicated Admin Console UI.
30+
* Installing and updating applications on a VM with Replicated Embedded Cluster v2 through the Replicated Admin Console UI.
2931

3032
Replicated recommends that you allow one to two hours to complete this quick start. No prior knowledge of Replicated, Helm, or interacting with the command line is required. However, if you are unfamiliar with these tools, you might allow more time. If you have any questions or need help, don't hesitate to reach out to our team at https://www.replicated.com/contact.
3133

@@ -35,7 +37,7 @@ Before you begin, do the following to set up your environment:
3537

3638
* Install the Helm CLI, which is the tool for interacting with Helm and managing Helm charts. See [Install Helm](/vendor/environment-setup#install-helm).
3739

38-
* Ensure that you have access to a VM that meets the requirements for Embedded Cluster:
40+
* Ensure that you have access to a VM that meets the requirements for Embedded Cluster v2:
3941

4042
* **Option 1: Use Compatibility Matrix.** To use Replicated Compatibility Matrix (CMX) to create a VM, do the following before proceeding:
4143

0 commit comments

Comments
 (0)