Skip to content
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

Jump to bottom

Add note to docs that --single cannot be extended #5235

Merged
merged 3 commits into from
Nov 13, 2024
Merged

Add note to docs that --single cannot be extended #5235

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
610f234
docs: fix typo
ncopa Nov 12, 2024
46327fb
Add note that --single can not be extended
ncopa Nov 12, 2024
20f3764
Update docs/install.md
ncopa Nov 13, 2024
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
6 changes: 6 additions & 0 deletions docs/install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,12 @@
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 be able to extend the cluster in the future you should instead use:
ncopa marked this conversation as resolved.
Show resolved Hide resolved
``` shell

Check failure on line 35 in docs/install.md

View workflow job for this annotation

GitHub Actions / Lint markdown 

Fenced code blocks should be surrounded by blank lines [Context: "``` 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
View file
Open in desktop
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
Loading