Skip to content

Commit

Permalink
Merge pull request k0sproject#5235 from ncopa/doc-k0s-single
Browse files Browse the repository at this point in the history
Add note to docs that --single cannot be extended
  • Loading branch information
twz123 authored Nov 13, 2024
2 parents d0915d1 + 20f3764 commit 2b20f96
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 1 deletion.
7 changes: 7 additions & 0 deletions docs/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,13 @@ Though the Quick Start material is written for Debian/Ubuntu, you can use it for
sudo k0s install controller --single
```

NOTE:
The `--single` option will disable features needed for multi-node clusters, so you will not be able to extend this cluster. If you want to be able to extend the cluster in the future, you should use:

``` shell
sudo k0s install controller --enable-worker --no-taints
```

The `k0s install controller` sub-command accepts the same flags and parameters as the `k0s controller`. Refer to [manual install](k0s-multi-node.md#install-k0s) for a custom config file example.

It is possible to set environment variables with the install command:
Expand Down
2 changes: 1 addition & 1 deletion docs/support-dump.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ To get a support bundle, after setting up the [tooling](#setting-up), you simply
support-bundle --kubeconfig /var/lib/k0s/pki/admin.conf https://docs.k0sproject.io/stable/support-bundle-<role>.yaml
```

Above `<role>` refers to either `controller`or `worker`. For different roles we collect different things. If you are running a controller with `--enable-worker` or `--single`, where it becomes also a worker, you can also get a comobined dump:
Above `<role>` refers to either `controller`or `worker`. For different roles we collect different things. If you are running a controller with `--enable-worker` or `--single`, where it becomes also a worker, you can also get a combined dump:

```shell
support-bundle --kubeconfig /var/lib/k0s/pki/admin.conf https://docs.k0sproject.io/stable/support-bundle-controller.yaml https://docs.k0sproject.io/stable/support-bundle-worker.yaml
Expand Down

0 comments on commit 2b20f96

Please sign in to comment.