K3s Server 配置参考

在本节中,你将学习如何配置 K3s server。

在整个 K3s 文档中,你会看到一些选项可以作为命令标志和环境变量传递进来。关于传入选项的帮助,请参考如何使用标志和环境变量。

常用选项

数据库

Flag环境变量描述
--datastore-endpoint valueK3S_DATASTORE_ENDPOINT指定 etcd、Mysql、Postgres 或 Sqlite(默认)数据源名称。
--datastore-cafile valueK3S_DATASTORE_CAFILETLS 证书授权文件,用于确保数据存储后端通信的安全。
--datastore-certfile valueK3S_DATASTORE_CERTFILETLS 认证文件,用于确保数据存储后端通信的安全。
--datastore-keyfile valueK3S_DATASTORE_KEYFILE用于保护数据存储后端通信的 TLS 密钥文件。

集群选项

Flag环境变量描述
--token value, -t valueK3S_TOKEN用于将 server 或 agent 加集群的共享 secret。
--token-file valueK3S_TOKEN_FILE包含 cluster-secret/token 的文件

客户端选项

Flag环境变量描述
--write-kubeconfig value, -o valueK3S_KUBECONFIG_OUTPUT将管理客户端的 kubeconfig 写入这个文件。
--write-kubeconfig-mode valueK3S_KUBECONFIG_MODE使用这种模式写入 kubeconfig。允许写入 kubeconfig 文件的选项对于允许将 K3s 集群导入 Rancher 很有用。示例值为 644。

Agent 选项

K3s agent 选项是可以作为 server 选项的,因为 server 内部嵌入了 agent 进程。

Agent 节点

Flag环境变量描述
--node-name valueK3S_NODE_NAME节点名称
--with-node-idN/A将 ID 附加到节点名称
--node-label valueN/A用一组标签注册和启动 kubelet。
--node-taint valueN/A用一组污点注册 kubelet。

Agent 运行时

Flag默认值描述
--dockerN/A用 docker 代替 containerd
--container-runtime-endpoint valueN/A禁用嵌入式 containerd,使用替代的 CRI 实现。
--pause-image value"docker.io/rancher/pause:3.1"针对 containerd 或 Docker 的自定义 pause 镜像
--private-registry value"/etc/rancher/k3s/registries.yaml"私有注册表配置文件

Agent 网络

Agent 选项之所以存在,是因为 server 内嵌了 agent 进程

Flag环境变量描述
--node-ip value, -i valueN/A为节点发布的 IP 地址
--node-external-ip valueN/A对外发布节点的 IP 地址
--resolv-conf valueK3S_RESOLV_CONFKubelet resolv.conf 文件
--flannel-iface valueN/A覆盖默认的 flannel 接口
--flannel-conf valueN/A覆盖默认的 flannel 文件

高级选项

日志

Flag默认值描述
-v value0日志级别详细程度的数字
--vmodule valueN/A以逗号分隔的 pattern=N 设置列表,用于文件过滤的日志记录
--log value, -l valueN/A记录到文件
--alsologtostderrN/A记录到标准错误输出和文件(如果设置)。

监听

Flag默认值描述
--bind-address value0.0.0.0k3s 绑定地址
--https-listen-port value6443HTTPS 监听端口
--advertise-address valuenode-external-ip/node-ipapiserver 用来向集群成员发布的 IP 地址
--advertise-port value0apiserver 用于通告集群成员的端口(默认: listen-port)
--tls-san valueN/A在 TLS 证书中添加其他主机名或 IP 作为主题备用名称

Data

Flag默认值描述
--data-dir value, -d value/var/lib/rancher/k3s${HOME}/.rancher/k3s 如果不是 root 用户)存放数据的目录

网络

Flag默认值描述
--cluster-cidr value"10.42.0.0/16"用于 Pod IP 的网络 CIDR
--service-cidr value"10.43.0.0/16"用于 service IP 的网络 CIDR
--cluster-dns value"10.43.0.10"用于 coredns 服务的集群 IP。应该在您的service-cidr范围内
--cluster-domain value"cluster.local"集群域名
--flannel-backend value"vxlan"'none', 'vxlan', 'ipsec', 'host-gw', 或 'wireguard'中的一个

定制标志

Flag描述
--kube-apiserver-arg value自定义 kube-apiserver 进程的参数。
--kube-scheduler-arg value自定义 kube-scheduler 进程的参数。
--kube-controller-manager-arg value自定义 kube-controller-manager 进程的参数。
--kube-cloud-controller-manager-arg value自定义 kube-cloud-controller-manager 进程的参数。

存储类

Flag描述
--default-local-storage-path value本地存储类的默认存储路径

Kubernetes 组件

Flag描述
--disable value不需要部署的组件,删除任何已部署的组件 (有效项目:coredns, servicelb, traefik,local-storage, metrics-server)
--disable-scheduler禁用 Kubernetes 默认调度器
--disable-cloud-controller禁用 k3s 默认云控制管理器
--disable-network-policy禁用 K3S 默认网络策略控制器

Kubernetes 进程定制标志

Flag描述
--kubelet-arg value自定义 kubelet 进程的参数
--kube-proxy-arg value自定义 kube-proxy 进程的参数

实验性选项

Flag环境变量描述
--rootlessN/A运行 rootless
--agent-token valueK3S_AGENT_TOKEN用于将 agent 加入集群但不用于 server 的共享密钥
--agent-token-file valueK3S_AGENT_TOKEN_FILE包含 agent secret 的文件
--server value, -s valueK3S_URL要连接的 k3s server,用于加入集群
--cluster-initK3S_CLUSTER_INIT初始化为新的集群 master
--cluster-resetK3S_CLUSTER_RESET忽略所有节点,成为一个新集群的集群 master
--secrets-encryptionN/A启用 Secret 加密

废弃的选项

Flag环境变量描述
--no-flannelN/A使用 --flannel-backend=none
--no-deploy valueN/A不需要部署的组件 (有效选项: coredns, servicelb, traefik, local-storage, metrics-server)
--cluster-secret valueK3S_CLUSTER_SECRET使用 --token

K3s Server CLI 帮助

如果一个选项出现在下面的括号里,例如[$K3S_TOKEN],则意味着该选项可以作为该名称的环境变量传递进来。

NAME:
k3s server - 运行K3s server
USAGE:
k3s server [选项]
选项:
-v value (logging) 日志级别详细程度的数字 (默认: 0)
--vmodule value (logging) 以逗号分隔的pattern=N设置列表,用于文件过滤的日志记录
--log value, -l value (logging) 记录到文件
--alsologtostderr (logging) 记录到标准错误输出和文件(如果设置)
--bind-address value (listener) k3s绑定地址 (默认: 0.0.0.0)
--https-listen-port value (listener) HTTPS监听端口 (默认: 6443)
--advertise-address value (listener) apiserver用来向集群成员发布的IP地址 (默认: node-external-ip/node-ip)
--advertise-port value (listener) apiserver用于通告集群成员的端口 (默认: listen-port) (默认: 0)
--tls-san value (listener) 在TLS证书中添加其他主机名或IP作为主题备用名称
--data-dir value, -d value (data) 存放数据的目录 默认 /var/lib/rancher/k3s or ${HOME}/.rancher/k3s(如果不是root用户)
--cluster-cidr value (networking) 用于Pod IP的网络CIDR (默认: "10.42.0.0/16")
--service-cidr value (networking) 用于service IP的网络CIDR (默认: "10.43.0.0/16")
--cluster-dns value (networking) 用于coredns服务的集群IP。应该在您的`service-cidr`范围内 (默认: 10.43.0.10)
--cluster-domain value (networking) 集群域名 (默认: "cluster.local")
--flannel-backend value (networking) 'none', 'vxlan', 'ipsec', 'host-gw', 或 'wireguard'中的一个 (默认: "vxlan")
--token value, -t value (cluster) 用于将server或agent加入集群的共享secret。 [$K3S_TOKEN]
--token-file value (cluster) 包含cluster-secret/token的文件 [$K3S_TOKEN_FILE]
--write-kubeconfig value, -o value (client) 将管理客户端的kubeconfig写入这个文件。 [$K3S_KUBECONFIG_OUTPUT]
--write-kubeconfig-mode value (client) 用这种模式编写kubeconfig,例如:644 [$K3S_KUBECONFIG_MODE]
--kube-apiserver-arg value (flags) 自定义kube-apiserver进程的参数
--kube-scheduler-arg value (flags) 自定义kube-scheduler进程的参数
--kube-controller-manager-arg value (flags) 自定义kube-controller-manager进程的参数
--kube-cloud-controller-manager-arg value (flags) 自定义kube-cloud-controller-manager进程的参数
--datastore-endpoint value (db) 指定 etcd、Mysql、Postgres 或 Sqlite(默认)数据源名称 [$K3S_DATASTORE_ENDPOINT]
--datastore-cafile value (db) TLS证书授权文件,用于确保数据存储后端通信的安全 [$K3S_DATASTORE_CAFILE]
--datastore-certfile value (db) TLS认证文件,用于确保数据存储后端通信的安全 [$K3S_DATASTORE_CERTFILE]
--datastore-keyfile value (db) 用于保护数据存储后端通信的TLS密钥文件 [$K3S_DATASTORE_KEYFILE]
--default-local-storage-path value (storage) 本地存储类的默认存储路径
--disable value (components) 不需要部署的组件,删除任何已部署的组件 (有效项目:coredns, servicelb, traefik,local-storage, metrics-server)
--disable-scheduler (components) 禁用Kubernetes默认调度器
--disable-cloud-controller (components) 禁用k3s默认云控制管理器
--disable-network-policy (components) 用K3S默认网络策略控制器
--node-name value (agent/node) 节点名称 [$K3S_NODE_NAME]
--with-node-id (agent/node) 将ID附加到节点名称
--node-label value (agent/node) 用一组标签注册和启动kubelet
--node-taint value (agent/node) 用一组污点注册kubelet
--docker (agent/runtime) 用docker代替containerd
--container-runtime-endpoint value (agent/runtime) 禁用嵌入式containerd,使用替代的CRI实现
--pause-image value (agent/runtime) 针对containerd或Docker的自定义pause镜像 (默认: "docker.io/rancher/pause:3.1")
--private-registry value (agent/runtime) 私有注册表配置文件 (默认: "/etc/rancher/k3s/registries.yaml")
--node-ip value, -i value (agent/networking) 为节点发布的IP地址
--node-external-ip value (agent/networking) 对外发布节点的IP地址
--resolv-conf value (agent/networking) Kubelet resolv.conf 文件 [$K3S_RESOLV_CONF]
--flannel-iface value (agent/networking) 覆盖默认的flannel接口
--flannel-conf value (agent/networking) 覆盖默认的flannel文件
--kubelet-arg value (agent/flags) 自定义kubelet进程的参数
--kube-proxy-arg value (agent/flags) 自定义kube-proxy进程的参数
--rootless (experimental) 运行 rootless
--agent-token value (experimental/cluster) 用于将agent加入集群但不用于server的共享密钥 [$K3S_AGENT_TOKEN]
--agent-token-file value (experimental/cluster) 包含agent secret的文件 [$K3S_AGENT_TOKEN_FILE]
--server value, -s value (experimental/cluster) 要连接的k3s server,用于加入集群 [$K3S_URL]
--cluster-init (experimental/cluster) 初始化为新的集群master [$K3S_CLUSTER_INIT]
--cluster-reset (experimental/cluster) 忽略所有节点,成为一个新集群的集群master [$K3S_CLUSTER_RESET]
--secrets-encryption (experimental) 启用Secret加密
--no-flannel (deprecated) 使用 --flannel-backend=none
--no-deploy value (deprecated) 不需要部署的组件 (有效选项: coredns, servicelb, traefik, local-storage, metrics-server)
--cluster-secret value (deprecated) 使用 --token [$K3S_CLUSTER_SECRET]
最后由 yzeng25更新 于