From da618d0cec898d4de2a0deb6dbc952eac318c4f0 Mon Sep 17 00:00:00 2001 From: Paige Calvert Date: Mon, 28 Apr 2025 11:22:35 -0600 Subject: [PATCH 1/5] Add new multi-node ec license option --- docs/vendor/licenses-using-builtin-fields.mdx | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/vendor/licenses-using-builtin-fields.mdx b/docs/vendor/licenses-using-builtin-fields.mdx index fc7eaf9fd8..111270fc96 100644 --- a/docs/vendor/licenses-using-builtin-fields.mdx +++ b/docs/vendor/licenses-using-builtin-fields.mdx @@ -175,6 +175,13 @@ The table below describes the built-in license fields related to the Admin Conso `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). + + `isEmbeddedClusterMultiNodeEnabled` + +

If a license supports multi-node installations with Embedded Cluster, this field is set to `true`. If a license does not support multi-node installations, this field is either missing or `false`. By default, `isEmbeddedClusterMultiNodeEnabled` is `true`.

+

When `isEmbeddedClusterMultiNodeEnabled` is missing or false, the **Configure the cluster** page is hidden from the Embedded Cluster installation and upgrade flow in the Admin Console. Additionally, the option to add nodes is removed from the Admin Console **Cluster management** page.

+ + `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. From f6f5a5983eb6ef7f1d8cf16bfcd6c2bde3d9b254 Mon Sep 17 00:00:00 2001 From: Paige Calvert Date: Mon, 28 Apr 2025 11:28:08 -0600 Subject: [PATCH 2/5] add multi-node requirement --- docs/enterprise/embedded-manage-nodes.mdx | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/enterprise/embedded-manage-nodes.mdx b/docs/enterprise/embedded-manage-nodes.mdx index b046231a91..a206b99278 100644 --- a/docs/enterprise/embedded-manage-nodes.mdx +++ b/docs/enterprise/embedded-manage-nodes.mdx @@ -18,6 +18,10 @@ Multi-node clusters with Embedded Cluster have the following limitations: * Setting node roles with the Embedded Cluster Config [roles](/reference/embedded-config#roles) key is Beta. +## Requirements + +To deploy multi-node clusters with Embedded Cluster, the **Embedded Cluster Multi-Node** license field must be enabled for the customer. For more information about managing customer licenses, see [Create and Manage Customers](/vendor/releases-creating-customer). + ## Add Nodes to a Cluster (Beta) {#add-nodes} You can add nodes to create a multi-node cluster in online (internet-connected) and air-gapped (limited or no outbound internet access) environments. The Admin Console provides the join command that you use to join nodes to the cluster. From 0e99beb34d5c3b0a693868cfafb59867a35c063d Mon Sep 17 00:00:00 2001 From: Paige Calvert Date: Mon, 28 Apr 2025 11:32:01 -0600 Subject: [PATCH 3/5] clarify field name --- docs/enterprise/embedded-manage-nodes.mdx | 2 +- docs/vendor/licenses-using-builtin-fields.mdx | 14 +++++++------- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/enterprise/embedded-manage-nodes.mdx b/docs/enterprise/embedded-manage-nodes.mdx index a206b99278..d94a6ba8d2 100644 --- a/docs/enterprise/embedded-manage-nodes.mdx +++ b/docs/enterprise/embedded-manage-nodes.mdx @@ -20,7 +20,7 @@ Multi-node clusters with Embedded Cluster have the following limitations: ## Requirements -To deploy multi-node clusters with Embedded Cluster, the **Embedded Cluster Multi-Node** license field must be enabled for the customer. For more information about managing customer licenses, see [Create and Manage Customers](/vendor/releases-creating-customer). +To deploy multi-node clusters with Embedded Cluster, the **Multi-node Cluster (Embedded Cluster only)** license field must be enabled for the customer. For more information about managing customer licenses, see [Create and Manage Customers](/vendor/releases-creating-customer). ## Add Nodes to a Cluster (Beta) {#add-nodes} diff --git a/docs/vendor/licenses-using-builtin-fields.mdx b/docs/vendor/licenses-using-builtin-fields.mdx index 111270fc96..e771dc94c8 100644 --- a/docs/vendor/licenses-using-builtin-fields.mdx +++ b/docs/vendor/licenses-using-builtin-fields.mdx @@ -156,6 +156,13 @@ The table below describes the built-in license fields related to install options `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.

+ + `isEmbeddedClusterMultiNodeEnabled` + +

If a license supports multi-node installations with Embedded Cluster, this field is set to `true`. If a license does not support multi-node installations, this field is either missing or `false`. By default, `isEmbeddedClusterMultiNodeEnabled` is `true`.

+

When `isEmbeddedClusterMultiNodeEnabled` is missing or false, the **Configure the cluster** page is hidden from the Embedded Cluster installation and upgrade flow in the Admin Console. Additionally, the option to add nodes is removed from the Admin Console **Cluster management** page.

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

@@ -175,13 +182,6 @@ The table below describes the built-in license fields related to the Admin Conso `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). - - `isEmbeddedClusterMultiNodeEnabled` - -

If a license supports multi-node installations with Embedded Cluster, this field is set to `true`. If a license does not support multi-node installations, this field is either missing or `false`. By default, `isEmbeddedClusterMultiNodeEnabled` is `true`.

-

When `isEmbeddedClusterMultiNodeEnabled` is missing or false, the **Configure the cluster** page is hidden from the Embedded Cluster installation and upgrade flow in the Admin Console. Additionally, the option to add nodes is removed from the Admin Console **Cluster management** page.

- - `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. From 2fa3cb7a0b1fffb0b0a9ead467876874e876820e Mon Sep 17 00:00:00 2001 From: Paige Calvert Date: Mon, 28 Apr 2025 11:56:46 -0600 Subject: [PATCH 4/5] edit --- docs/enterprise/embedded-manage-nodes.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/enterprise/embedded-manage-nodes.mdx b/docs/enterprise/embedded-manage-nodes.mdx index d94a6ba8d2..90b6f8b63b 100644 --- a/docs/enterprise/embedded-manage-nodes.mdx +++ b/docs/enterprise/embedded-manage-nodes.mdx @@ -18,7 +18,7 @@ Multi-node clusters with Embedded Cluster have the following limitations: * Setting node roles with the Embedded Cluster Config [roles](/reference/embedded-config#roles) key is Beta. -## Requirements +## Requirement To deploy multi-node clusters with Embedded Cluster, the **Multi-node Cluster (Embedded Cluster only)** license field must be enabled for the customer. For more information about managing customer licenses, see [Create and Manage Customers](/vendor/releases-creating-customer). From 23cec658ad23523a9a970b33473839f94324a642 Mon Sep 17 00:00:00 2001 From: Paige Calvert Date: Mon, 28 Apr 2025 13:32:48 -0600 Subject: [PATCH 5/5] edits based on review --- docs/vendor/licenses-using-builtin-fields.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/vendor/licenses-using-builtin-fields.mdx b/docs/vendor/licenses-using-builtin-fields.mdx index e771dc94c8..c91f5af647 100644 --- a/docs/vendor/licenses-using-builtin-fields.mdx +++ b/docs/vendor/licenses-using-builtin-fields.mdx @@ -160,7 +160,7 @@ The table below describes the built-in license fields related to install options `isEmbeddedClusterMultiNodeEnabled`

If a license supports multi-node installations with Embedded Cluster, this field is set to `true`. If a license does not support multi-node installations, this field is either missing or `false`. By default, `isEmbeddedClusterMultiNodeEnabled` is `true`.

-

When `isEmbeddedClusterMultiNodeEnabled` is missing or false, the **Configure the cluster** page is hidden from the Embedded Cluster installation and upgrade flow in the Admin Console. Additionally, the option to add nodes is removed from the Admin Console **Cluster management** page.

+

When `isEmbeddedClusterMultiNodeEnabled` is missing or false, the **Configure the cluster** page is hidden from the Embedded Cluster installation flow in the Admin Console. Additionally, the `join` command is not available and the option to add nodes is removed from the Admin Console **Cluster management** page.