doc + goldens

Author: Mia-Cross

cmd/scw/testdata/test-all-usage-k8s-pool-add-external-node-usage.golden

@@ -0,0 +1,23 @@
+🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
+🟥🟥🟥 STDERR️️ 🟥🟥🟥️
+Add an external node to a Kosmos pool. 
+This will connect via SSH to the node, download the multicloud configuration script and run it with sudo privileges.
+Keep in mind that your external node needs to have wget in order to download the script.
+
+USAGE:
+  scw k8s pool add-external-node [arg=value ...]
+
+ARGS:
+  node-ip           IP address of the external node
+  pool-id           ID of the pool the node should be added to
+  [username=root]   Username used for the SSH connection
+  [region=fr-par]   Region to target. If none is passed will use default region from the config
+
+FLAGS:
+  -h, --help   help for add-external-node
+
+GLOBAL FLAGS:
+  -c, --config string    The path to the config file
+  -D, --debug            Enable debug mode
+  -o, --output string    Output format: json or human, see 'scw help output' for more info (default "human")
+  -p, --profile string   The config profile to use

cmd/scw/testdata/test-all-usage-k8s-pool-usage.golden

@@ -7,15 +7,18 @@ USAGE:
   scw k8s pool <command>
 
 AVAILABLE COMMANDS:
-  create      Create a new Pool in a Cluster
-  delete      Delete a Pool in a Cluster
-  get         Get a Pool in a Cluster
-  list        List Pools in a Cluster
-  update      Update a Pool in a Cluster
-  upgrade     Upgrade a Pool in a Cluster
+  create            Create a new Pool in a Cluster
+  delete            Delete a Pool in a Cluster
+  get               Get a Pool in a Cluster
+  list              List Pools in a Cluster
+  update            Update a Pool in a Cluster
+  upgrade           Upgrade a Pool in a Cluster
+
+UTILITY COMMANDS:
+  add-external-node Add an external node to a Kosmos pool
 
 WORKFLOW COMMANDS:
-  wait        Wait for a pool to reach a stable state
+  wait              Wait for a pool to reach a stable state
 
 FLAGS:
   -h, --help   help for pool

docs/commands/k8s.md

@@ -34,6 +34,7 @@ This API allows you to manage Kubernetes Kapsule and Kosmos clusters.
   - [Replace a Node in a Cluster](#replace-a-node-in-a-cluster)
   - [Wait for a node to reach a stable state](#wait-for-a-node-to-reach-a-stable-state)
 - [Kapsule pool management commands](#kapsule-pool-management-commands)
+  - [Add an external node to a Kosmos pool](#add-an-external-node-to-a-kosmos-pool)
   - [Create a new Pool in a Cluster](#create-a-new-pool-in-a-cluster)
   - [Delete a Pool in a Cluster](#delete-a-pool-in-a-cluster)
   - [Get a Pool in a Cluster](#get-a-pool-in-a-cluster)
@@ -961,6 +962,30 @@ A pool is a set of identical nodes
 A pool has a name, a size (its desired number of nodes), node number limits (min, max), and a Scaleway Instance type. Changing those limits increases/decreases the size of a pool. As a result and depending on its load, the pool will grow or shrink within those limits when autoscaling is enabled.
 
 
+### Add an external node to a Kosmos pool
+
+Add an external node to a Kosmos pool. 
+This will connect via SSH to the node, download the multicloud configuration script and run it with sudo privileges.
+Keep in mind that your external node needs to have wget in order to download the script.
+
+**Usage:**
+
+```
+scw k8s pool add-external-node [arg=value ...]
+```
+
+
+**Args:**
+
+| Name |   | Description |
+|------|---|-------------|
+| node-ip | Required | IP address of the external node |
+| pool-id | Required | ID of the pool the node should be added to |
+| username | Default: `root` | Username used for the SSH connection |
+| region | Default: `fr-par` | Region to target. If none is passed will use default region from the config |
+
+
+
 ### Create a new Pool in a Cluster
 
 Create a new pool in a specific Kubernetes cluster.