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

Add section on k3s token rotate #207

Merged
merged 4 commits into from
Nov 27, 2023
Merged

Add section on k3s token rotate #207

Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7752246
Add section on new `k3s token rotate` command
dereknola Nov 21, 2023
ab9edd5
Update token page with new `k3s token rotate` command
dereknola Nov 21, 2023
085160d
Add Version Gate
dereknola Nov 21, 2023
5606237
Codespell
dereknola Nov 21, 2023
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
20 changes: 20 additions & 0 deletions docs/cli/token.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,7 @@ COMMANDS:
delete Delete bootstrap tokens on the server
generate Generate and print a bootstrap token, but do not create it on the server
list List bootstrap tokens on the server
rotate Rotate original server token with a new bootstrap token

OPTIONS:
--help, -h show help
Expand Down Expand Up @@ -141,3 +142,22 @@ Flag | Description
`--data-dir` value | Folder to hold state (default: /var/lib/rancher/k3s or $\{HOME\}/.rancher/k3s if not root)
`--kubeconfig` value | Server to connect to [$KUBECONFIG]
`--output` value | Output format. Valid options: text, json (default: "text")

#### `k3s token rotate`

:::info Version Gate
Avaliable as of 2023-10 releases (v1.28.2+k3s1, v1.27.7+k3s1, v1.26.10+k3s1, v1.25.15+k3s1).
:::

Rotate original server token with a new bootstrap token. After running this command, all servers and any agents that originally joined with the old token must be restarted with the new token.

If you do not specify a new token, one will be generated for you.

Flag | Description
---- | ----
`--data-dir` value | Folder to hold state (default: /var/lib/rancher/k3s or $\{HOME\}/.rancher/k3s if not root)
`--kubeconfig` value | Server to connect to [$KUBECONFIG]
`--server` value | Server to connect to (default: "https://127.0.0.1:6443") [$K3S_URL]
`--token` value | Existing token used to join a server or agent to a cluster [$K3S_TOKEN]
`--new-token` value | New token that replaces existing token

Loading