mirror of https://github.com/k3d-io/k3d
parent
e4cefaab27
commit
e98ff9a964
@ -1,4 +1,3 @@ |
||||
title: FAQ |
||||
nav: |
||||
- faq.md |
||||
- v1vsv3-comparison.md |
@ -1,63 +0,0 @@ |
||||
# Feature Comparison: v1 vs. v3 |
||||
|
||||
## v1.x feature -> implementation in v3 |
||||
|
||||
```text |
||||
- k3d |
||||
- check-tools -> won't do |
||||
- shell -> planned: `k3d shell CLUSTER` |
||||
- --name -> planned: drop (now as arg) |
||||
- --command -> planned: keep |
||||
- --shell -> planned: keep (or second arg) |
||||
- auto, bash, zsh |
||||
- create -> `k3d cluster create CLUSTERNAME` |
||||
- --name -> dropped, implemented via arg |
||||
- --volume -> implemented |
||||
- --port -> implemented |
||||
- --port-auto-offset -> TBD |
||||
- --api-port -> implemented |
||||
- --wait -> implemented |
||||
- --image -> implemented |
||||
- --server-arg -> implemented as `--k3s-server-arg` |
||||
- --agent-arg -> implemented as `--k3s-agent-arg` |
||||
- --env -> planned |
||||
- --label -> planned |
||||
- --workers -> implemented |
||||
- --auto-restart -> dropped (docker's `unless-stopped` is set by default) |
||||
- --enable-registry -> coming in v4.0.0 (2021) as `--registry-create` and `--registry-use` |
||||
- --registry-name -> TBD |
||||
- --registry-port -> TBD |
||||
- --registry-volume -> TBD |
||||
- --registries-file -> TBD |
||||
- --enable-registry-cache -> TBD |
||||
- (add-node) -> `k3d node create NODENAME` |
||||
- --role -> implemented |
||||
- --name -> dropped, implemented as arg |
||||
- --count -> implemented as `--replicas` |
||||
- --image -> implemented |
||||
- --arg -> planned |
||||
- --env -> planned |
||||
- --volume -> planned |
||||
- --k3s -> TBD |
||||
- --k3s-secret -> TBD |
||||
- --k3s-token -> TBD |
||||
- delete -> `k3d cluster delete CLUSTERNAME` |
||||
- --name -> dropped, implemented as arg |
||||
- --all -> implemented |
||||
- --prune -> TBD |
||||
- --keep-registry-volume -> TBD |
||||
- stop -> `k3d cluster stop CLUSTERNAME` |
||||
- --name -> dropped, implemented as arg |
||||
- --all -> implemented |
||||
- start -> `k3d cluster start CLUSTERNAME` |
||||
- --name -> dropped, implemented as arg |
||||
- --all -> implemented |
||||
- list -> dropped, implemented as `k3d get clusters` |
||||
- get-kubeconfig -> `k3d kubeconfig get|merge CLUSTERNAME` |
||||
- --name -> dropped, implemented as arg |
||||
- --all -> implemented |
||||
- --overwrite -> implemented |
||||
- import-images -> `k3d image import [--cluster CLUSTERNAME] [--keep] IMAGES` |
||||
- --name -> implemented as `--cluster` |
||||
- --no-remove -> implemented as `--keep-tarball` |
||||
``` |
@ -1,15 +1,22 @@ |
||||
# Defaults |
||||
|
||||
- multiple server nodes |
||||
- by default, when `--server` > 1 and no `--datastore-x` option is set, the first server node (server-0) will be the initializing server node |
||||
- the initializing server node will have the `--cluster-init` flag appended |
||||
- all other server nodes will refer to the initializing server node via `--server https://<init-node>:6443` |
||||
- API-Ports |
||||
- by default, we expose the API-Port (`6443`) by forwarding traffic from the default server loadbalancer (nginx container) to the server node(s) |
||||
- port `6443` of the loadbalancer is then mapped to a specific (`--api-port` flag) or a random (default) port on the host system |
||||
- kubeconfig |
||||
- if `--kubeconfig-update-default` is set, we use the default loading rules to get the default kubeconfig: |
||||
- First: kubeconfig specified via the KUBECONFIG environment variable (error out if multiple are specified) |
||||
- Second: default kubeconfig in home directory (e.g. `$HOME/.kube/config`) |
||||
- Networking |
||||
- [by default, k3d creates a new (docker) network for every cluster](./networking) |
||||
## Multiple server nodes |
||||
|
||||
- by default, when `--server` > 1 and no `--datastore-x` option is set, the first server node (server-0) will be the initializing server node |
||||
- the initializing server node will have the `--cluster-init` flag appended |
||||
- all other server nodes will refer to the initializing server node via `--server https://<init-node>:6443` |
||||
|
||||
## API-Ports |
||||
|
||||
- by default, we expose the API-Port (`6443`) by forwarding traffic from the default server loadbalancer (nginx container) to the server node(s) |
||||
- port `6443` of the loadbalancer is then mapped to a specific (`--api-port` flag) or a random (default) port on the host system |
||||
|
||||
## Kubeconfig |
||||
|
||||
- if `--kubeconfig-update-default` is set, we use the default loading rules to get the default kubeconfig: |
||||
- First: kubeconfig specified via the KUBECONFIG environment variable (error out if multiple are specified) |
||||
- Second: default kubeconfig in home directory (e.g. `$HOME/.kube/config`) |
||||
|
||||
## Networking |
||||
|
||||
- [by default, k3d creates a new (docker) network for every cluster](./networking) |
||||
|
Loading…
Reference in new issue