安装选项介绍

本页主要介绍首次设置 K3s 时可以使用的选项:

除了使用环境变量和 CLI 参数配置 K3s 外,K3s 还可以使用配置文件

更多高级选项,请参阅本页

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

使用脚本安装的选项

正如快速启动指南中提到的那样,你可以使用https://get.k3s.io 提供的安装脚本在基于 systemd 和 openrc 的系统上安装 K3s 作为服务。

该命令的最简单形式如下:

curl -sfL https://get.k3s.io | sh -
提示

国内用户,可以使用以下方法加速安装:

curl -sfL http://rancher-mirror.cnrancher.com/k3s/k3s-install.sh | INSTALL_K3S_MIRROR=cn sh -

使用此方法安装 K3s 时,可使用以下环境变量来配置安装:

Environment VariableDescription
INSTALL_K3S_SKIP_DOWNLOAD如果设置为 "true "将不会下载 K3s 的哈希值或二进制。
INSTALL_K3S_SYMLINK默认情况下,如果路径中不存在命令,将为 kubectl、crictl 和 ctr 二进制文件创建符号链接。如果设置为'skip'将不会创建符号链接,而'force'将覆盖。
INSTALL_K3S_SKIP_ENABLE如果设置为 "true",将不启用或启动 K3s 服务。
INSTALL_K3S_SKIP_START如果设置为 "true "将不会启动 K3s 服务。
INSTALL_K3S_VERSION从 Github 下载 K3s 的版本。如果没有指定,将尝试从"stable"频道下载。
INSTALL_K3S_BIN_DIR安装 K3s 二进制文件、链接和卸载脚本的目录,或者使用/usr/local/bin作为默认目录。
INSTALL_K3S_BIN_DIR_READ_ONLY如果设置为 true 将不会把文件写入INSTALL_K3S_BIN_DIR,强制设置INSTALL_K3S_SKIP_DOWNLOAD=true
INSTALL_K3S_SYSTEMD_DIR安装 systemd 服务和环境文件的目录,或者使用/etc/systemd/system作为默认目录。
INSTALL_K3S_EXEC带有标志的命令,用于在服务中启动 K3s。如果未指定命令,并且设置了K3S_URL,它将默认为“agent”。如果未设置K3S_URL,它将默认为“server”。要获得帮助,请参考此示例。
INSTALL_K3S_NAME要创建的 systemd 服务名称,如果以服务器方式运行 k3s,则默认为'k3s';如果以 agent 方式运行 k3s,则默认为'k3s-agent'。如果指定了服务名,则服务名将以'k3s-'为前缀。
INSTALL_K3S_TYPE要创建的 systemd 服务类型,如果没有指定,将从 K3s exec 命令中默认。
INSTALL_K3S_CHANNEL_URL用于获取 K3s 下载网址的频道 URL。默认为https://update.k3s.io/v1-release/channels
INSTALL_K3S_CHANNEL用于获取 K3s 下载 URL 的通道。默认值为 "stable"。选项包括:stable, latest, testing

以 "K3S_"开头的环境变量将被保留,供 systemd 和 openrc 服务使用。

在没有明确设置 exec 命令的情况下设置K3S_URL,会将命令默认为 "agent"。

运行 agent 时还必须设置K3S_TOKEN

从二进制中安装 K3s

如上所述,安装脚本主要是配置 K3s 作为服务运行。如果你选择不使用脚本,你可以通过从我们的发布页面下载二进制文件,将其放在你的路径上,然后执行它来运行 K3s。K3s 二进制支持以下命令:

命令描述
k3s server运行 K3s server,它还将启动 Kubernetes 控制平面组件,如 API server, controller-manager, 和 scheduler。
k3s agent运行 K3s agent 节点。这将使 K3s 作为工作节点运行,启动 Kubernetes 节点服务kubeletkube-proxy
k3s kubectl运行嵌入式kubectl CLI。如果没有设置KUBECONFIG环境变量,当启动 K3s 服务器节点时,将自动尝试使用在/etc/rancher/k3s/k3s.yaml创建的配置文件。
k3s crictl运行一个嵌入式crictl。这是一个用于与 Kubernetes 的容器运行时接口(CRI)交互的 CLI。对调试很有用。
k3s ctr运行一个嵌入式的ctr。这是为 containerd(K3s 使用的容器守护进程)提供的 CLI。对调试很有用。
k3s help显示一个命令的命令列表或帮助。

k3s serverk3s agent 命令有额外的配置选项,可以通过 k3s server --helpk3s agent --help 查看.

K3s Server 的注册选项

关于 K3s server 的详细配置,请参考k3s server 配置参考

K3s Agent 的注册选项

关于 K3s agent 的配置详情,请参考k3s agent 配置参考

配置文件

除了使用环境变量和 CLI 参数来配置 K3s,K3s 还可以使用配置文件。

默认情况下,位于/etc/rancher/k3s/config.yaml的 YAML 文件中的值将在安装时使用。

下面是一个基本的server配置文件的例子。

write-kubeconfig-mode: "0644"
tls-san:
- "foo.local"
node-label:
- "foo=bar"
- "something=amazing"

一般来说,CLI 参数映射到各自的 YAML 键,可重复的 CLI 参数被表示为 YAML 列表。

下面展示了一个完全使用 CLI 参数的相同配置来证明这一点。

k3s server \
--write-kubeconfig-mode "0644" \
--tls-san "foo.local" \
--node-label "foo=bar" \
--node-label "something=amazing"

也可以同时使用配置文件和 CLI 参数。 在这种情况下,值将从两个来源加载,但 CLI 参数将优先。 对于可重复的参数,如--node-label,CLI 参数将覆盖列表中的所有值。

最后,配置文件的位置可以通过 cli 参数--config FILE,-c FILE或者环境变量$K3S_CONFIG_FILE来改变。

最后由 kingsd041更新 于