HOLD FOR RELEASE: use cli to get commands for node joins #3216
Conversation
replicated-ci
added
type::docs
✅ Deploy Preview for replicated-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
✅ Deploy Preview for replicated-docs-upgrade ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
| ## 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. | ||
| * The `join print-command` command always returns the command for joining a node with the controller role. It does not support printing the join command for any custom node roles defined in the Embedded Cluster Config `roles` key. See [Automate Controller Node Joins](#automate-node-joins) below. |
There was a problem hiding this comment.
^ added to Limitations section
| 1. Repeat these steps for each node you want to add. | ||
| 1. Repeat these steps for each node you want to add. | ||
|
|
||
| ## Automate Controller Node Joins (Beta) {#automate-node-joins} |
There was a problem hiding this comment.
^ added new section on automating node joins that explains how to get the join command for controllers from the command line.
Note: I decided to specify "controller nodes" in the heading etc to make it clear that the print command is just for controllers. We can update this to remove the "controller" callouts if/when that changes
There was a problem hiding this comment.
Also , it seemed like "Automate Node Joins" as the heading would speak to people who are wanting to write automating tests, but lmk if you have other ideas for how this info might be titled
| ``` | ||
| Where `APP_SLUG` is the unique application slug. | ||
|
|
||
| 1. SSH onto the node that you want to add as a third controller. |
There was a problem hiding this comment.
^ I also added mention of the print command to the HA procedure since this procedure does assume the user is joining a third controller node
paigecalvert
changed the title
join print-command to help automate node joins
paigecalvert
changed the title
join print-command to help automate node joins
| 1. If you configured the `roles` key to customize node roles, select one or more roles for the node. | ||
|
|
||
| <img alt="Add node page in the Admin Console" src="/images/admin-console-add-node.png" width="600px"/> | ||
| The Admin Console page is updated to display the commands for downloading the Embedded Cluster binary, extracting the binary, and joining the node to the cluster based on the roles you selected. Keep this Admin Console page open for the next steps. |
There was a problem hiding this comment.
Edited this description to reflect the new experience.
|
|
||
| 1. If you configured the `roles` key to customize node roles, select one or more roles for the node. | ||
|
|
||
| <img alt="Add node page in the Admin Console" src="/images/admin-console-add-node.png" width="600px"/> |
There was a problem hiding this comment.
^ removed out of date screenshot of admin console
| "sudo ./embedded-cluster join 172.17.0.2:30000 1234aBcD" | ||
| ] | ||
| } | ||
| ``` |
There was a problem hiding this comment.
^ copied these examples from ethan's pr
| ## 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. | ||
| This section describes how to add nodes to a cluster with Embedded Cluster in online and air gap installations. |
There was a problem hiding this comment.
updated this procedure to split into online and air gap subheadings.
goal was to get rid of that extra layer of "if this then that" to reduce noise
Co-authored-by: Alex Parker <[email protected]>
paigecalvert
changed the title
https://deploy-preview-3216--replicated-docs.netlify.app/enterprise/embedded-manage-nodes