K3s Server 配置參考

2022-08-19 09:58 更新

常用選項(xiàng)

數(shù)據(jù)庫(kù)

Flag 環(huán)境變量 描述
--datastore-endpoint value K3S_DATASTORE_ENDPOINT 指定 etcd、Mysql、Postgres 或 Sqlite(默認(rèn))數(shù)據(jù)源名稱。
--datastore-cafile value K3S_DATASTORE_CAFILE TLS 證書(shū)授權(quán)文件,用于確保數(shù)據(jù)存儲(chǔ)后端通信的安全。
--datastore-certfile value K3S_DATASTORE_CERTFILE TLS 認(rèn)證文件,用于確保數(shù)據(jù)存儲(chǔ)后端通信的安全。
--datastore-keyfile value K3S_DATASTORE_KEYFILE 用于保護(hù)數(shù)據(jù)存儲(chǔ)后端通信的 TLS 密鑰文件。
--etcd-expose-metrics N/A 將 etcd 指標(biāo)公開(kāi)給客戶端界面。(默認(rèn)為 false)
--etcd-disable-snapshots N/A 禁用自動(dòng) etcd 快照
--etcd-snapshot-name value N/A 設(shè)置 etcd 快照的基本名稱。默認(rèn)值: etcd-snapshot
--etcd-snapshot-schedule-cron value N/A cron 規(guī)范中的快照間隔時(shí)間。 例如。每 5 小時(shí) "* */5 * * *" (默認(rèn)值: "0 */12 * * *")
--etcd-snapshot-retention value N/A 要保留的快照數(shù)量 (默認(rèn)值: 5)
--etcd-snapshot-dir value N/A 保存數(shù)據(jù)庫(kù)快照的目錄. (默認(rèn) location: ${data-dir}/db/snapshots)
--etcd-s3 N/A 啟用備份到 S3
--etcd-s3-endpoint value N/A S3 endpoint url (默認(rèn)值: "s3.amazonaws.com")
--etcd-s3-endpoint-ca value N/A S3 自定義 CA 證書(shū)連接到 S3 endpoint
--etcd-s3-skip-ssl-verify N/A 禁用 S3 的 SSL 證書(shū)驗(yàn)證
--etcd-s3-access-key value AWS_ACCESS_KEY_ID S3 access key
--etcd-s3-secret-key value AWS_SECRET_ACCESS_KEY S3 secret key
--etcd-s3-bucket value N/A S3 bucket 名稱
--etcd-s3-region value N/A S3 region / bucket 位置 (可選) 默認(rèn)值: "us-east-1")
--etcd-s3-folder value N/A S3 文件夾

集群選項(xiàng)

Flag 環(huán)境變量 描述
--token value, -t value K3S_TOKEN 用于將 server 或 agent 加集群的共享 secret。
--token-file value K3S_TOKEN_FILE 包含 cluster-secret/token 的文件

客戶端選項(xiàng)

Flag 環(huán)境變量 描述
--write-kubeconfig value, -o value K3S_KUBECONFIG_OUTPUT 將管理客戶端的 kubeconfig 寫(xiě)入這個(gè)文件。
--write-kubeconfig-mode value K3S_KUBECONFIG_MODE 使用這種模式寫(xiě)入 kubeconfig。允許寫(xiě)入 kubeconfig 文件的選項(xiàng)對(duì)于允許將 K3s 集群導(dǎo)入 Rancher 很有用。示例值為 644。

Agent 選項(xiàng)

K3s agent 選項(xiàng)是可以作為 server 選項(xiàng)的,因?yàn)?nbsp;server 內(nèi)部嵌入了 agent 進(jìn)程。

Agent 節(jié)點(diǎn)

Flag 環(huán)境變量 描述
--node-name value K3S_NODE_NAME 節(jié)點(diǎn)名稱
--with-node-id N/A 將 ID 附加到節(jié)點(diǎn)名稱
--node-label value N/A 用一組標(biāo)簽注冊(cè)和啟動(dòng) kubelet。
--node-taint value N/A 用一組污點(diǎn)注冊(cè) kubelet。
--image-credential-provider-bin-dir value N/A 憑證提供程序插件二進(jìn)制文件所在目錄的路徑(默認(rèn):"/var/lib/rancher/credentialprovider/bin")。
--image-credential-provider-config value N/A 憑證提供者插件配置文件的路徑 (默認(rèn): "/var/lib/rancher/credentialprovider/config.yaml")
--selinux K3S_SELINUX 在 containerd 中啟用 SELinux
--lb-server-port value K3S_LB_SERVER_PORT 客戶端負(fù)載均衡器的本地端口。如果 supervisor 和 apiserver 不在同一個(gè)主機(jī),則 apiserver 客戶端負(fù)載均衡器也將使用比該端口小 1 的額外端口。(默認(rèn):6444)

Agent 運(yùn)行時(shí)

Flag 默認(rèn)值 描述
--docker N/A 用 docker 代替 containerd
--container-runtime-endpoint value N/A 禁用嵌入式 containerd,使用替代的 CRI 實(shí)現(xiàn)。
--pause-image value "docker.io/rancher/pause:3.1" 針對(duì) containerd 或 Docker 的自定義 pause 鏡像
--snapshotter value N/A 覆蓋默認(rèn)的 containerd 快照程序 (默認(rèn): "overlayfs")
--private-registry value "/etc/rancher/k3s/registries.yaml" 私有鏡像倉(cāng)庫(kù)配置文件

Agent 網(wǎng)絡(luò)

Agent 選項(xiàng)之所以存在,是因?yàn)?nbsp;server 內(nèi)嵌了 agent 進(jìn)程

Flag 環(huán)境變量 描述
--node-ip value, -i value N/A 為節(jié)點(diǎn)發(fā)布的 IP 地址
--node-external-ip value N/A 對(duì)外發(fā)布節(jié)點(diǎn)的 IP 地址
--resolv-conf value K3S_RESOLV_CONF Kubelet resolv.conf 文件
--flannel-iface value N/A 覆蓋默認(rèn)的 flannel 接口
--flannel-conf value N/A 覆蓋默認(rèn)的 flannel 文件

高級(jí)選項(xiàng)

日志

Flag 默認(rèn)值 描述
--debug N/A 開(kāi)啟調(diào)試日志
-v value 0 日志級(jí)別詳細(xì)程度的數(shù)字
--vmodule value N/A 以逗號(hào)分隔的 pattern=N 設(shè)置列表,用于文件過(guò)濾的日志記錄
--log value, -l value N/A 記錄到文件
--alsologtostderr N/A 記錄到標(biāo)準(zhǔn)錯(cuò)誤輸出和文件(如果設(shè)置)。

監(jiān)聽(tīng)

Flag 默認(rèn)值 描述
--bind-address value 0.0.0.0 k3s 綁定地址
--https-listen-port value 6443 HTTPS 監(jiān)聽(tīng)端口
--advertise-address value node-external-ip/node-ip apiserver 用來(lái)向集群成員發(fā)布的 IP 地址
--advertise-port value 0 apiserver 用于通告集群成員的端口(默認(rèn): listen-port)
--tls-san value N/A 在 TLS 證書(shū)中添加其他主機(jī)名或 IP 作為主題備用名稱

Data

Flag 默認(rèn)值 描述
--data-dir value, -d value /var/lib/rancher/k3s 或 ${HOME}/.rancher/k3s 如果不是 root 用戶) 存放數(shù)據(jù)的目錄

網(wǎng)絡(luò)

Flag 默認(rèn)值 描述
--cluster-cidr value "10.42.0.0/16" 用于 Pod IP 的網(wǎng)絡(luò) CIDR
--service-cidr value "10.43.0.0/16" 用于 service IP 的網(wǎng)絡(luò) CIDR
--service-node-port-range value "30000-32767" 為具有 NodePort 可見(jiàn)性的服務(wù)保留的端口范圍
--cluster-dns value "10.43.0.10" 用于 coredns 服務(wù)的集群 IP。應(yīng)該在您的service-cidr范圍內(nèi)
--cluster-domain value "cluster.local" 集群域名
--flannel-backend value "vxlan" 'none', 'vxlan', 'ipsec', 'host-gw', 或 'wireguard'中的一個(gè)

定制標(biāo)志

Flag 描述
--etcd-arg value 自定義 etcd 進(jìn)程的參數(shù)。
--kube-apiserver-arg value 自定義 kube-apiserver 進(jìn)程的參數(shù)。
--kube-scheduler-arg value 自定義 kube-scheduler 進(jìn)程的參數(shù)。
--kube-controller-manager-arg value 自定義 kube-controller-manager 進(jìn)程的參數(shù)。
--kube-cloud-controller-manager-arg value 自定義 kube-cloud-controller-manager 進(jìn)程的參數(shù)。

存儲(chǔ)類(lèi)

Flag 描述
--default-local-storage-path value 本地存儲(chǔ)類(lèi)的默認(rèn)存儲(chǔ)路徑

Kubernetes 組件

Flag 描述
--disable value 不需要部署的組件,刪除任何已部署的組件 (有效項(xiàng)目:coredns, servicelb, traefik,local-storage, metrics-server)
--disable-scheduler 禁用 Kubernetes 默認(rèn)調(diào)度器
--disable-cloud-controller 禁用 k3s 默認(rèn)云控制管理器
--disable-kube-proxy 禁止運(yùn)行 kube-proxy
--disable-network-policy 禁用 K3S 默認(rèn)網(wǎng)絡(luò)策略控制器

Kubernetes 進(jìn)程定制標(biāo)志

Flag 描述
--kubelet-arg value 自定義 kubelet 進(jìn)程的參數(shù)
--kube-proxy-arg value 自定義 kube-proxy 進(jìn)程的參數(shù)

實(shí)驗(yàn)性選項(xiàng)

Flag 環(huán)境變量 描述
--rootless N/A 運(yùn)行 rootless
--agent-token value K3S_AGENT_TOKEN 用于將 agent 加入集群但不用于 server 的共享密鑰
--agent-token-file value K3S_AGENT_TOKEN_FILE 包含 agent secret 的文件
--server value, -s value K3S_URL 要連接的 k3s server,用于加入集群
--cluster-init K3S_CLUSTER_INIT 初始化為新的集群 master
--cluster-reset K3S_CLUSTER_RESET 忽略所有節(jié)點(diǎn),成為一個(gè)新集群的集群 master
--secrets-encryption N/A 啟用 Secret 加密

廢棄的選項(xiàng)

Flag 環(huán)境變量 描述
--no-flannel N/A 使用 --flannel-backend=none
--no-deploy value N/A 不需要部署的組件 (有效選項(xiàng): coredns, servicelb, traefik, local-storage, metrics-server)
--cluster-secret value K3S_CLUSTER_SECRET 使用 --token

K3s Server CLI 幫助

如果一個(gè)選項(xiàng)出現(xiàn)在下面的括號(hào)里,例如?[$K3S_TOKEN]?,則意味著該選項(xiàng)可以作為該名稱的環(huán)境變量傳遞進(jìn)來(lái)。

NAME:
   k3s server - 運(yùn)行K3s server

USAGE:
   k3s server [選項(xiàng)]

選項(xiàng):
   --config FILE, -c FILE                     (config) 從FILE加載配置(默認(rèn):"/etc/rancher/k3s/config.yaml" ) [$K3S_CONFIG_FILE]
   --debug                                    (logging) 開(kāi)啟debug調(diào)試日志 [$K3S_DEBUG]
   -v value                                   (logging) 日志級(jí)別詳細(xì)程度的數(shù)字 (默認(rèn): 0)
   --vmodule value                            (logging) 以逗號(hào)分隔的pattern=N設(shè)置列表,用于文件過(guò)濾的日志記錄
   --log value, -l value                      (logging) 記錄到文件
   --alsologtostderr                          (logging) 記錄到標(biāo)準(zhǔn)錯(cuò)誤輸出和文件(如果設(shè)置)
   --bind-address value                       (listener) k3s綁定地址 (默認(rèn): 0.0.0.0)
   --https-listen-port value                  (listener) HTTPS監(jiān)聽(tīng)端口 (默認(rèn): 6443)
   --advertise-address value                  (listener) apiserver用來(lái)向集群成員發(fā)布的IP地址 (默認(rèn): node-external-ip/node-ip)
   --advertise-port value                     (listener) apiserver用于通告集群成員的端口 (默認(rèn): listen-port) (默認(rèn): 0)
   --tls-san value                            (listener) 在TLS證書(shū)中添加其他主機(jī)名或IP作為主題備用名稱
   --data-dir value, -d value                 (data) 存放數(shù)據(jù)的目錄 默認(rèn) /var/lib/rancher/k3s or ${HOME}/.rancher/k3s(如果不是root用戶)
   --cluster-cidr value                       (networking) 用于Pod IP的網(wǎng)絡(luò)CIDR (默認(rèn): "10.42.0.0/16")
   --service-cidr value                       (networking) 用于service IP的網(wǎng)絡(luò)CIDR (默認(rèn): "10.43.0.0/16")
   --service-node-port-range value            (networking) 為具有 NodePort 可見(jiàn)性的服務(wù)保留的端口范圍 (默認(rèn): "30000-32767")
   --cluster-dns value                        (networking) 用于coredns服務(wù)的集群IP。應(yīng)該在您的`service-cidr`范圍內(nèi) (默認(rèn): 10.43.0.10)
   --cluster-domain value                     (networking) 集群域名 (默認(rèn): "cluster.local")
   --flannel-backend value                    (networking) 'none', 'vxlan', 'ipsec', 'host-gw', 或 'wireguard'中的一個(gè) (默認(rèn): "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寫(xiě)入這個(gè)文件。 [$K3S_KUBECONFIG_OUTPUT]
   --write-kubeconfig-mode value              (client) 用這種模式編寫(xiě)kubeconfig,例如:644 [$K3S_KUBECONFIG_MODE]
   --etcd-arg value                           (flags) 自定義etcd進(jìn)程的參數(shù)
   --kube-apiserver-arg value                 (flags) 自定義kube-apiserver進(jìn)程的參數(shù)
   --kube-scheduler-arg value                 (flags) 自定義kube-scheduler進(jìn)程的參數(shù)
   --kube-controller-manager-arg value        (flags) 自定義kube-controller-manager進(jìn)程的參數(shù)
   --kube-cloud-controller-manager-arg value  (flags) 自定義kube-cloud-controller-manager進(jìn)程的參數(shù)
   --datastore-endpoint value                 (db) 指定 etcd、Mysql、Postgres 或 Sqlite(默認(rèn))數(shù)據(jù)源名稱 [$K3S_DATASTORE_ENDPOINT]
   --datastore-cafile value                   (db) TLS證書(shū)授權(quán)文件,用于確保數(shù)據(jù)存儲(chǔ)后端通信的安全 [$K3S_DATASTORE_CAFILE]
   --datastore-certfile value                 (db) TLS認(rèn)證文件,用于確保數(shù)據(jù)存儲(chǔ)后端通信的安全 [$K3S_DATASTORE_CERTFILE]
   --datastore-keyfile value                  (db) 用于保護(hù)數(shù)據(jù)存儲(chǔ)后端通信的TLS密鑰文件 [$K3S_DATASTORE_KEYFILE]
   --etcd-expose-metrics                      (db) 將 etcd 指標(biāo)公開(kāi)給客戶端界面。(默認(rèn)為 false)
   --etcd-disable-snapshots                   (db) 禁用自動(dòng) etcd 快照
   --etcd-snapshot-name value                 (db) 設(shè)置 etcd 快照的基本名稱。默認(rèn)值: etcd-snapshot
   --etcd-snapshot-schedule-cron value        (db) cron 規(guī)范中的快照間隔時(shí)間。 例如。每 5 小時(shí) "\* \*/5 \* \* \*" (默認(rèn)值: "0 \*/12 \* \* \*")
   --etcd-snapshot-retention value            (db) 要保留的快照數(shù)量 (默認(rèn)值: 5)
   --etcd-snapshot-dir value                  (db) 保存數(shù)據(jù)庫(kù)快照的目錄. (默認(rèn) location: ${data-dir}/db/snapshots)
   --etcd-s3                                  (db) 啟用備份到 S3
   --etcd-s3-endpoint value                   (db) S3 endpoint url (默認(rèn)值: "s3.amazonaws.com")
   --etcd-s3-endpoint-ca value                (db) S3 自定義 CA 證書(shū)連接到 S3 endpoint
   --etcd-s3-skip-ssl-verify                  (db) 禁用 S3 的 SSL 證書(shū)驗(yàn)證
   --etcd-s3-access-key value                 (db) S3 access key [$AWS_ACCESS_KEY_ID]
   --etcd-s3-secret-key value                 (db) S3 secret key [$AWS_SECRET_ACCESS_KEY]
   --etcd-s3-bucket value                     (db) S3 bucket 名稱
   --etcd-s3-region value                     (db) S3 region / bucket 位置 (可選) 默認(rèn)值: "us-east-1")
   --etcd-s3-folder value                     (db) S3 文件夾
   --default-local-storage-path value         (storage) 本地存儲(chǔ)類(lèi)的默認(rèn)存儲(chǔ)路徑
   --disable value                            (components) 不需要部署的組件,刪除任何已部署的組件 (有效項(xiàng)目:coredns, servicelb, traefik,local-storage, metrics-server)
   --disable-scheduler                        (components) 禁用Kubernetes默認(rèn)調(diào)度器
   --disable-cloud-controller                 (components) 禁用k3s默認(rèn)云控制管理器
   --disable-kube-proxy                       (components) 禁止運(yùn)行 kube-proxy
   --disable-network-policy                   (components) 用K3S默認(rèn)網(wǎng)絡(luò)策略控制器
   --node-name value                          (agent/node) 節(jié)點(diǎn)名稱 [$K3S_NODE_NAME]
   --with-node-id                             (agent/node) 將ID附加到節(jié)點(diǎn)名稱
   --node-label value                         (agent/node) 用一組標(biāo)簽注冊(cè)和啟動(dòng)kubelet
   --node-taint value                         (agent/node) 用一組污點(diǎn)注冊(cè)kubelet
   --image-credential-provider-bin-dir value  (agent/node) 憑證提供程序插件二進(jìn)制文件所在目錄的路徑(默認(rèn):"/var/lib/rancher/credentialprovider/bin")
   --image-credential-provider-config value   (agent/node) 憑證提供者插件配置文件的路徑 (默認(rèn): "/var/lib/rancher/credentialprovider/config.yaml")
   --docker                                   (agent/runtime) 用docker代替containerd
   --container-runtime-endpoint value         (agent/runtime) 禁用嵌入式containerd,使用替代的CRI實(shí)現(xiàn)
   --pause-image value                        (agent/runtime) 針對(duì)containerd或Docker的自定義pause鏡像 (默認(rèn): "docker.io/rancher/pause:3.1")
   --snapshotter value                        (agent/runtime) 覆蓋默認(rèn)的 containerd 快照程序 (默認(rèn): "overlayfs")
   --private-registry value                   (agent/runtime) 私有鏡像倉(cāng)庫(kù)配置文件 (默認(rèn): "/etc/rancher/k3s/registries.yaml")
   --node-ip value, -i value                  (agent/networking) 為節(jié)點(diǎn)發(fā)布的IP地址
   --node-external-ip value                   (agent/networking) 對(duì)外發(fā)布節(jié)點(diǎn)的IP地址
   --resolv-conf value                        (agent/networking) Kubelet resolv.conf 文件 [$K3S_RESOLV_CONF]
   --flannel-iface value                      (agent/networking) 覆蓋默認(rèn)的flannel接口
   --flannel-conf value                       (agent/networking) 覆蓋默認(rèn)的flannel文件
   --kubelet-arg value                        (agent/flags) 自定義kubelet進(jìn)程的參數(shù)
   --kube-proxy-arg value                     (agent/flags) 自定義kube-proxy進(jìn)程的參數(shù)
   --protect-kernel-defaults                  (agent/node) 內(nèi)核調(diào)優(yōu)行為。如果設(shè)置,如果內(nèi)核可調(diào)參數(shù)與 kubelet 默認(rèn)值不同,則會(huì)出錯(cuò)。
   --rootless                                 (experimental) 運(yùn)行 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) 忽略所有節(jié)點(diǎn),成為一個(gè)新集群的集群master [$K3S_CLUSTER_RESET]
   --cluster-reset-restore-path value         (db) 要恢復(fù)的快照文件的路徑
   --secrets-encryption                       (experimental) 啟用Secret加密
   --system-default-registry value            (image) 用于所有系統(tǒng)鏡像的私有注冊(cè)表 [$K3S_SYSTEM_DEFAULT_REGISTRY]
   --selinux                                  (agent/node) 在 containerd 中啟用 SELinux [$K3S_SELINUX]
   --lb-server-port value                     (agent/node) 客戶端負(fù)載均衡器的本地端口。如果 supervisor 和 apiserver 不在同一個(gè)主機(jī),則 apiserver 客戶端負(fù)載均衡器也將使用比該端口小 1 的額外端口。(默認(rèn):6444) [$K3S_LB_SERVER_PORT]
   --no-flannel                               (deprecated) 使用 --flannel-backend=none
   --no-deploy value                          (deprecated) 不需要部署的組件 (有效選項(xiàng): coredns, servicelb, traefik, local-storage, metrics-server)
   --cluster-secret value                     (deprecated) 使用 --token [$K3S_CLUSTER_SECRET]


以上內(nèi)容是否對(duì)您有幫助:
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號(hào)
微信公眾號(hào)

編程獅公眾號(hào)