Skip to content

Commit

Permalink
docs: improve toolchain/k3d docs (#15913)
Browse files Browse the repository at this point in the history
* docs: improve toolchain/k3d docs

Signed-off-by: Francisco Rangel <franc.rangel07@protonmail.com>

* fix: add missing code formatting for first k3d flag

Signed-off-by: Francisco Rangel <franc.rangel07@protonmail.com>

* fix: add missing code formatting for first k3d legacy flag

Signed-off-by: Francisco Rangel <franc.rangel07@protonmail.com>

* fix: use correct type of quote

Signed-off-by: Francisco Rangel <franc.rangel07@protonmail.com>

* add single quotes around k3d extra arguments

Signed-off-by: Francisco Rangel <franc.rangel07@protonmail.com>

---------

Signed-off-by: Francisco Rangel <franc.rangel07@protonmail.com>
  • Loading branch information
francRang authored Oct 12, 2023
1 parent 7297a6c commit c9aa373
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions docs/developer-guide/toolchain-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -205,10 +205,11 @@ you should edit your `~/.kube/config` and modify the `server` option to point to
4. Finally, so that you don't have to keep updating your kube-config whenever you spin up a new k3d cluster, add `--api-port $IP:6550` to your **k3d cluster create** command, where $IP is the value from step 1. An example command is provided here:
```
k3d cluster create my-cluster --wait --k3s-server-arg '--disable=traefik' --api-port $IP:6550 -p 443:443@loadbalancer
k3d cluster create my-cluster --wait --k3s-arg '--disable=traefik@server:*' --api-port $IP:6550 -p 443:443@loadbalancer
```
Starting from k3d v5.0.0 the example command flags `--k3s-server-arg` and `'--disable=traefik'` would have to be changed to `--k3s-arg` and `'--disable=traefik@server:*'`, respectively.
!!!note
For k3d versions less than v5.0.0, the example command flags `--k3s-arg` and `'--disable=traefik@server:*'` should change to `--k3s-server-arg` and `'--disable=traefik'`, respectively.
## The development cycle
Expand Down

0 comments on commit c9aa373

Please sign in to comment.