Skip to content

HOLD FOR RELEASE: Add multi-node license option for embedded cluster #3214

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
May 7, 2025
Merged

HOLD FOR RELEASE: Add multi-node license option for embedded cluster #3214

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
da618d0
Add new multi-node ec license option
paigecalvert Apr 28, 2025
f6f5a59
add multi-node requirement
paigecalvert Apr 28, 2025
0e99beb
clarify field name
paigecalvert Apr 28, 2025
2fa3cb7
edit
paigecalvert Apr 28, 2025
23cec65
edits based on review
paigecalvert Apr 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/enterprise/embedded-manage-nodes.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

## 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).

## 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.
Expand Down
7 changes: 7 additions & 0 deletions docs/vendor/licenses-using-builtin-fields.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,6 +156,13 @@ The table below describes the built-in license fields related to install options
<td>`isAirgapSupported`</td>
<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>
</tr>
<tr>
<td>`isEmbeddedClusterMultiNodeEnabled`</td>
<td>
<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>
<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>
</td>
</tr>
<tr>
<td>`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>
Expand Down