Merge pull request #4134 from carlocorradini/patch-1

Update K3s Agent Configuration Reference CLI
This commit is contained in:
Billy Tat
2022-06-08 16:37:58 -07:00
committed by GitHub
@@ -107,30 +107,38 @@ USAGE:
k3s agent [OPTIONS] k3s agent [OPTIONS]
OPTIONS: OPTIONS:
-v value (logging) Number for the log level verbosity (default: 0) --config FILE, -c FILE (config) Load configuration from FILE (default: "/etc/rancher/k3s/config.yaml") [$K3S_CONFIG_FILE]
--vmodule value (logging) Comma-separated list of pattern=N settings for file-filtered logging --debug (logging) Turn on debug logs [$K3S_DEBUG]
--log value, -l value (logging) Log to file -v value (logging) Number for the log level verbosity (default: 0)
--alsologtostderr (logging) Log to standard error as well as file (if set) --vmodule value (logging) Comma-separated list of pattern=N settings for file-filtered logging
--token value, -t value (cluster) Token to use for authentication [$K3S_TOKEN] --log value, -l value (logging) Log to file
--token-file value (cluster) Token file to use for authentication [$K3S_TOKEN_FILE] --alsologtostderr (logging) Log to standard error as well as file (if set)
--server value, -s value (cluster) Server to connect to [$K3S_URL] --token value, -t value (cluster) Token to use for authentication [$K3S_TOKEN]
--data-dir value, -d value (agent/data) Folder to hold state (default: "/var/lib/rancher/k3s") --token-file value (cluster) Token file to use for authentication [$K3S_TOKEN_FILE]
--node-name value (agent/node) Node name [$K3S_NODE_NAME] --server value, -s value (cluster) Server to connect to [$K3S_URL]
--with-node-id (agent/node) Append id to node name --data-dir value, -d value (agent/data) Folder to hold state (default: "/var/lib/rancher/k3s")
--node-label value (agent/node) Registering and starting kubelet with set of labels --node-name value (agent/node) Node name [$K3S_NODE_NAME]
--node-taint value (agent/node) Registering kubelet with set of taints --with-node-id (agent/node) Append id to node name
--docker (agent/runtime) Use docker instead of containerd --node-label value (agent/node) Registering and starting kubelet with set of labels
--container-runtime-endpoint value (agent/runtime) Disable embedded containerd and use alternative CRI implementation --node-taint value (agent/node) Registering kubelet with set of taints
--pause-image value (agent/runtime) Customized pause image for containerd or docker sandbox (default: "docker.io/rancher/pause:3.1") --image-credential-provider-bin-dir value (agent/node) The path to the directory where credential provider plugin binaries are located (default: "/var/lib/rancher/credentialprovider/bin")
--private-registry value (agent/runtime) Private registry configuration file (default: "/etc/rancher/k3s/registries.yaml") --image-credential-provider-config value (agent/node) The path to the credential provider plugin config file (default: "/var/lib/rancher/credentialprovider/config.yaml")
--node-ip value, -i value (agent/networking) IP address to advertise for node --docker (agent/runtime) Use docker instead of containerd
--node-external-ip value (agent/networking) External IP address to advertise for node --container-runtime-endpoint value (agent/runtime) Disable embedded containerd and use alternative CRI implementation
--resolv-conf value (agent/networking) Kubelet resolv.conf file [$K3S_RESOLV_CONF] --pause-image value (agent/runtime) Customized pause image for containerd or docker sandbox (default: "rancher/mirrored-pause:3.6")
--flannel-iface value (agent/networking) Override default flannel interface --snapshotter value (agent/runtime) Override default containerd snapshotter (default: "overlayfs")
--flannel-conf value (agent/networking) Override default flannel config file --private-registry value (agent/runtime) Private registry configuration file (default: "/etc/rancher/k3s/registries.yaml")
--kubelet-arg value (agent/flags) Customized flag for kubelet process --node-ip value, -i value (agent/networking) IPv4/IPv6 addresses to advertise for node
--kube-proxy-arg value (agent/flags) Customized flag for kube-proxy process --node-external-ip value (agent/networking) IPv4/IPv6 external IP addresses to advertise for node
--rootless (experimental) Run rootless --resolv-conf value (agent/networking) Kubelet resolv.conf file [$K3S_RESOLV_CONF]
--no-flannel (deprecated) use --flannel-backend=none --flannel-iface value (agent/networking) Override default flannel interface
--cluster-secret value (deprecated) use --token [$K3S_CLUSTER_SECRET] --flannel-conf value (agent/networking) Override default flannel config file
--kubelet-arg value (agent/flags) Customized flag for kubelet process
--kube-proxy-arg value (agent/flags) Customized flag for kube-proxy process
--protect-kernel-defaults (agent/node) Kernel tuning behavior. If set, error if kernel tunables are different than kubelet defaults.
--rootless (experimental) Run rootless
--selinux (agent/node) Enable SELinux in containerd [$K3S_SELINUX]
--lb-server-port value (agent/node) Local port for supervisor client load-balancer. If the supervisor and apiserver are not colocated an additional port 1 less than this port will also be used for the apiserver client load-balancer. (default: 6444) [$K3S_LB_SERVER_PORT]
--no-flannel (deprecated) use --flannel-backend=none
--cluster-secret value (deprecated) use --token [$K3S_CLUSTER_SECRET]
``` ```