Skip to content

Commit d788e9d

Browse files
authored
Merge pull request #3485 from replicatedhq/node-role-limitation
Add limitation about the first controller node
2 parents 2a1b2da + 946a90a commit d788e9d

File tree

2 files changed

+10
-6
lines changed

2 files changed

+10
-6
lines changed

docs/enterprise/embedded-manage-nodes.mdx

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

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

13+
* The first node added to the cluster is always a controller and cannot be assigned any custom roles. For more information about configuring node roles, see [roles](/reference/embedded-config#roles-beta) in _Embedded Cluster Config_.
14+
1315
* The same Embedded Cluster data directory used at installation is used for all nodes joined to the cluster. This is either the default `/var/lib/embedded-cluster` directory or the directory set with the [`--data-dir`](/reference/embedded-cluster-install#flags) flag. You cannot choose a different data directory for Embedded Cluster when joining nodes.
1416

1517
* More than one controller node should not be joined at the same time. When joining a controller node, a warning is printed that explains that the user should not attempt to join another node until the controller node joins successfully.

docs/reference/embedded-config.mdx

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@ To install your application with Embedded Cluster, an Embedded Cluster Config mu
1010

1111
The Embedded Cluster Config lets you define several aspects of the Kubernetes cluster that will be created.
1212

13-
### Limitation
13+
### Limitations
1414

1515
* The Embedded Cluster Config does not support the use of Go template functions, including [KOTS template functions](/reference/template-functions-about).
1616

17-
For additional property-specific limitations, see the sections below.
17+
* There are additional, property-specific limitations. For more information, see the sections below.
1818

1919
### Example
2020

@@ -79,10 +79,6 @@ For a full list of versions, see the [Embedded Cluster Release Notes](/release-n
7979
8080
## roles (Beta)
8181
82-
:::note
83-
Support for setting node roles is Beta.
84-
:::
85-
8682
You can optionally customize node roles in the Embedded Cluster Config using the `roles` key.
8783

8884
A common use case for customizing node roles is to assign workloads to specific nodes. For example, if your application has graphics processing unit (GPU) workloads, you could create a `custom` role that will add a `gpu=true` label to any node that is assigned the role. This allows you to then schedule GPU workloads on nodes labled `gpu=true`.
@@ -113,6 +109,12 @@ spec:
113109
gpu: "true" # Label applied to "gpu" nodes
114110
```
115111

112+
### Limitations
113+
114+
* Defining node roles with the `roles` key is Beta.
115+
116+
* The first node added to the cluster is always a controller and cannot be assigned any custom roles. You can add custom labels to the first node by setting the `labels` field in the `roles.controller` key.
117+
116118
### roles.controller
117119

118120
In the `roles.controller` key, you can set the following fields to customize the default controller role:

0 commit comments

Comments
 (0)