Skip to content

Commit 169cccf

Browse files
authored
Merge pull request #3214 from replicatedhq/122788
HOLD FOR RELEASE: Add multi-node license option for embedded cluster
2 parents 150b02f + 23cec65 commit 169cccf

File tree

2 files changed

+11
-0
lines changed

2 files changed

+11
-0
lines changed

docs/enterprise/embedded-manage-nodes.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,10 @@ Multi-node clusters with Embedded Cluster have the following limitations:
1818

1919
* Setting node roles with the Embedded Cluster Config [roles](/reference/embedded-config#roles) key is Beta.
2020

21+
## Requirement
22+
23+
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).
24+
2125
## Add Nodes to a Cluster (Beta) {#add-nodes}
2226

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

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

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -156,6 +156,13 @@ The table below describes the built-in license fields related to install options
156156
<td>`isAirgapSupported`</td>
157157
<td><p>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>
158158
</tr>
159+
<tr>
160+
<td>`isEmbeddedClusterMultiNodeEnabled`</td>
161+
<td>
162+
<p>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`.</p>
163+
<p>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.</p>
164+
</td>
165+
</tr>
159166
<tr>
160167
<td>`isHelmAirgapEnabled`</td>
161168
<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>

0 commit comments

Comments
 (0)