3. 安装 Kubernetes（Docker 安装请跳过）

3. 安装 Kubernetes（Docker 安装请跳过）

备注

如果你使用 Docker 在单个节点上安装 Rancher，请跳过本节。

本文描述了如何根据 Rancher Server 环境的最佳实践来安装 Kubernetes 集群。该集群需要专用于运行 Rancher Server。

Rancher 可以安装在任何 Kubernetes 集群上，包括托管的 Kubernetes。

在 RKE、RKE2 或 K3s 上离线安装 Kubernetes 集群的步骤如下所示：

K3s
RKE2
RKE

在本指南中，我们假设你已经在离线环境中创建了节点，并且在堡垒服务器上有一个安全的 Docker 私有镜像仓库。

1. 准备镜像目录

从 Releases 页面获取要运行的 K3s 版本的镜像 tar 文件。

在每个节点上启动 K3s 之前，将这个 tar 文件放在 images 目录中，例如：

sudo mkdir -p /var/lib/rancher/k3s/agent/images/
sudo cp ./k3s-airgap-images-$ARCH.tar /var/lib/rancher/k3s/agent/images/

2. 创建镜像仓库 YAML

把 registries.yaml 文件创建到 /etc/rancher/k3s/registries.yaml 中。此文件为 K3s 提供连接到你的私有镜像仓库的详细信息。

在加入必要信息之前，registries.yaml 文件是这样的：

---
mirrors:
  customreg:
    endpoint:
      - "https://ip-to-server:5000"
configs:
  customreg:
    auth:
      username: xxxxxx # 镜像仓库的用户名
      password: xxxxxx # 镜像仓库的密码
    tls:
      cert_file: <镜像仓库所用的证书文件路径>
      key_file:  <镜像仓库所用的密钥文件路径>
      ca_file: <镜像仓库所用的 CA 文件路径>

请注意，目前，K3s 仅支持安全的镜像仓库（带有自定义 CA 的 SSL）。

有关 K3s 的私有镜像仓库配置文件的详情，请参见 K3s 官方文档。

3. 安装 K3s

Rancher 需要安装在支持的 Kubernetes 版本上。如需了解你使用的 Rancher 版本支持哪些 Kubernetes 版本，请参见支持维护条款。

如需指定 K3s 版本，在运行 K3s 安装脚本时，使用 INSTALL_K3S_VERSION 环境变量。

从 Releases 页面获取 K3s 的二进制文件，该文件要匹配用于获取离线镜像的 tar 版本。访问 K3s 安装脚本以获取 K3s 的安装脚本。

将二进制文件放到每个节点的 /usr/local/bin 中。将安装脚本放在每个节点的任意位置，并将脚本命名为 install.sh。

在每个 Server 上安装 K3s：

INSTALL_K3S_SKIP_DOWNLOAD=true ./install.sh

在每个 Agent 上安装 K3s：

INSTALL_K3S_SKIP_DOWNLOAD=true K3S_URL=https://myserver:6443 K3S_TOKEN=mynodetoken ./install.sh

请确保你将 myserver 替换为 Server 的 IP 或有效 DNS，并将 mynodetoken 替换为 Server 节点上的 node-token。 node-token 位于 Server 节点上的 /var/lib/rancher/k3s/server/node-token。

备注

K3s 自动为 kubelets 提供 --resolv-conf 标志，该标志可能对在离线环境中配置 DNS 有帮助。

4. 保存并开始使用 kubeconfig 文件

在每个 Rancher Server 节点安装 K3s 时，会在每个节点的 /etc/rancher/k3s/k3s.yaml 中生成一个 kubeconfig 文件。该文件包含访问集群的凭证。请将该文件保存在安全的位置。

如要使用该 kubeconfig 文件：

安装 Kubernetes 命令行工具 kubectl。
复制 /etc/rancher/k3s/k3s.yaml 文件并保存到本地主机的 ~/.kube/config 目录上。
在 kubeconfig 文件中，server 的参数为 localhost。你需要将 server 配置为负载均衡器的 DNS，并指定端口 6443（通过端口 6443 访问 Kubernetes API Server，通过端口 80 和 443 访问 Rancher Server）。以下是一个 k3s.yaml 示例：

apiVersion: v1
clusters:
- cluster:
    certificate-authority-data: [CERTIFICATE-DATA]
    server: [LOAD-BALANCER-DNS]:6443 # 编辑此行
  name: default
contexts:
- context:
    cluster: default
    user: default
  name: default
current-context: default
kind: Config
preferences: {}
users:
- name: default
  user:
    password: [PASSWORD]
    username: admin

结果：你可以开始使用 kubectl 来管理你的 K3s 集群。如果你有多个 kubeconfig 文件，在使用 kubectl 时，你可以传入文件路径来指定要使用的 kubeconfig 文件：

kubectl --kubeconfig ~/.kube/config/k3s.yaml get pods --all-namespaces

有关 kubeconfig 文件的详情，请参见 K3s 官方文档或 Kubernetes 官方文档中关于使用 kubeconfig 文件管理集群访问的部分。

升级注意事项

你可以通过以下方式完成离线环境的升级：

从 Releases 页面下载要升级的 K3s 版本的新离线镜像 tar 包。将 tar 文件放在每个节点上的 /var/lib/rancher/k3s/agent/images/ 目录中。删除旧的 tar 文件。
复制并替换每个节点上 /usr/local/bin 中的旧 K3s 二进制文件。复制 K3s 安装脚本（因为脚本可能自上次版本发布以来已更改）。使用相同的环境变量再次运行脚本。
重启 K3s 服务（如果安装程序没有自动重启 K3s 的话）。

在本指南中，我们假设你已经在离线环境中创建了节点，并且在堡垒服务器上有一个安全的 Docker 私有镜像仓库。

安装概要

创建 RKE2 配置
创建镜像仓库 YAML
安装 RKE2
保存并开始使用 kubeconfig 文件

1. 创建 RKE2 配置

把 config.yaml 文件创建到 /etc/rancher/rke2/config.yaml 中。这将包含创建高可用 RKE2 集群所需的所有配置选项。

第一台服务器的最低配置是：

token: my-shared-secret
tls-san:
  - loadbalancer-dns-domain.com

其他服务器的配置文件应该包含相同的令牌，并让 RKE2 知道要连接到现有的第一台服务器：

server: https://ip-of-first-server:9345
token: my-shared-secret
tls-san:
  - loadbalancer-dns-domain.com

有关详细信息，请参阅 RKE2 文档。

备注

RKE2 自动为 kubelets 提供 resolv-conf 选项，该标志可能对在离线环境中配置 DNS 有帮助。

2. 创建镜像仓库 YAML

把 registries.yaml 文件创建到 /etc/rancher/rke2/registries.yaml 中。此文件为 RKE2 提供连接到你的私有镜像仓库的详细信息。

在加入必要信息之前，registries.yaml 文件是这样的：

---
mirrors:
  customreg:
    endpoint:
      - "https://ip-to-server:5000"
configs:
  customreg:
    auth:
      username: xxxxxx # 镜像仓库的用户名
      password: xxxxxx # 镜像仓库的密码
    tls:
      cert_file: <镜像仓库所用的证书文件路径>
      key_file:  <镜像仓库所用的密钥文件路径>
      ca_file: <镜像仓库所用的 CA 文件路径>

有关 RKE2 的私有镜像仓库配置文件的详情，请参见 RKE2 官方文档。

3. 安装 RKE2

Rancher 需要安装在支持的 Kubernetes 版本上。如需了解你使用的 Rancher 版本支持哪些 Kubernetes 版本，请参见支持维护条款。

从 Release 页面下载安装脚本、rke2、rke2-images 和 sha256sum 存档，并将它们上传到每个服务器上的目录中：

mkdir /tmp/rke2-artifacts && cd /tmp/rke2-artifacts/
wget https://github.com/rancher/rke2/releases/download/v1.21.5%2Brke2r2/rke2-images.linux-amd64.tar.zst
wget https://github.com/rancher/rke2/releases/download/v1.21.5%2Brke2r2/rke2.linux-amd64.tar.gz
wget https://github.com/rancher/rke2/releases/download/v1.21.5%2Brke2r2/sha256sum-amd64.txt
curl -sfL https://get.rke2.io --output install.sh

接下来，使用每个服务器上的目录运行 install.sh，如下例所示：

INSTALL_RKE2_ARTIFACT_PATH=/tmp/rke2-artifacts sh install.sh

然后在所有服务器上启用并启动该服务：

systemctl enable rke2-server.service systemctl start rke2-server.service

有关详细信息，请参阅 RKE2 文档。

4. 保存并开始使用 kubeconfig 文件

在每个 Rancher Server 节点安装 RKE2 时，会在每个节点的 /etc/rancher/rke2/rke2.yaml 中生成一个 kubeconfig 文件。该文件包含访问集群的凭证。请将该文件保存在安全的位置。

如要使用该 kubeconfig 文件：

安装 kubectl（Kubernetes 命令行工具）。
复制 /etc/rancher/rke2/rke2.yaml 文件并保存到本地主机的 ~/.kube/config 目录上。
在 kubeconfig 文件中，server 的参数为 localhost。你需要将 server 配置为负载均衡器的 DNS，并指定端口 6443（通过端口 6443 访问 Kubernetes API Server，通过端口 80 和 443 访问 Rancher Server）。以下是一个 rke2.yaml 示例：

apiVersion: v1
clusters:
- cluster:
    certificate-authority-data: [CERTIFICATE-DATA]
    server: [LOAD-BALANCER-DNS]:6443 # 编辑此行
  name: default
contexts:
- context:
    cluster: default
    user: default
  name: default
current-context: default
kind: Config
preferences: {}
users:
- name: default
  user:
    password: [PASSWORD]
    username: admin

结果：你可以开始使用 kubectl 来管理你的 RKE2 集群。如果你有多个 kubeconfig 文件，在使用 kubectl 时，你可以传入文件路径来指定要使用的 kubeconfig 文件：

kubectl --kubeconfig ~/.kube/config/rke2.yaml get pods --all-namespaces

有关 kubeconfig 文件的详情，请参见 RKE2 官方文档或 Kubernetes 官方文档中关于使用 kubeconfig 文件管理集群访问的部分。

升级注意事项

你可以通过以下方式完成离线环境的升级：

从 Releases 页面下载新的离线工件，并安装升级 RKE2 版本的脚本。
使用相同的环境变量再次运行脚本。
重启 RKE2 服务。

我们将使用 Rancher Kubernetes Engine (RKE) 创建一个 Kubernetes 集群。在启动 Kubernetes 集群之前，你需要安装 RKE 并创建 RKE 配置文件。

1. 安装 RKE

参照 RKE 官方文档的说明安装 RKE。

备注

你可以在 Rancher 支持矩阵中找到基于 Rancher 版本的 RKE 认证版本。

2. 创建 RKE 配置文件

在可访问你 Linux 主机节点上的 22/TCP 端口和 6443/TCP 端口的系统上，使用以下示例创建一个名为 rancher-cluster.yml 的新文件。

该文件是 RKE 配置文件，用于配置你要部署 Rancher 的集群。

参考下方的 RKE 选项 表格，修改代码示例中的参数。使用你创建的三个节点的 IP 地址或 DNS 名称。

提示

如需获取可用选项的详情，请参见 RKE 配置选项。

RKE 选项

选项	必填	描述
`address`	✓	离线环境中节点的 DNS 或 IP 地址
`user`	✓	可运行 Docker 命令的用户
`role`	✓	分配给节点的 Kubernetes 角色列表
`internal_address`	可选¹	用于集群内部流量的 DNS 或 IP 地址
`ssh_key_path`		用来验证节点的 SSH 私钥文件路径（默认值为 `~/.ssh/id_rsa`）

1 如果你想使用引用安全组或防火墙，某些服务（如 AWS EC2）要求设置 `internal_address`。

nodes:
  - address: 10.10.3.187 # 离线环境节点 IP
    internal_address: 172.31.7.22 # 节点内网 IP
    user: rancher
    role: ['controlplane', 'etcd', 'worker']
    ssh_key_path: /home/user/.ssh/id_rsa
  - address: 10.10.3.254 # 离线环境节点 IP
    internal_address: 172.31.13.132 # 节点内网 IP
    user: rancher
    role: ['controlplane', 'etcd', 'worker']
    ssh_key_path: /home/user/.ssh/id_rsa
  - address: 10.10.3.89 # 离线环境节点 IP
    internal_address: 172.31.3.216 # 节点内网 IP
    user: rancher
    role: ['controlplane', 'etcd', 'worker']
    ssh_key_path: /home/user/.ssh/id_rsa
private_registries:
  - url: <REGISTRY.YOURDOMAIN.COM:PORT> # 私有镜像仓库 URL
    user: rancher
    password: '*********'
    is_default: true

3. 运行 RKE

配置 rancher-cluster.yml后，启动你的 Kubernetes 集群：

rke up --config ./rancher-cluster.yml

4. 保存你的文件

重要提示：

维护、排除问题和升级集群需要用到以下文件，请妥善保管这些文件：

将以下文件的副本保存在安全位置：

rancher-cluster.yml：RKE 集群配置文件。
kube_config_cluster.yml：集群的 Kubeconfig 文件。该文件包含可完全访问集群的凭证。
rancher-cluster.rkestate：Kubernetes 集群状态文件。该文件包含集群的当前状态，包括 RKE 配置以及证书
。
Kubernetes 集群状态文件仅在使用 RKE 0.2.0 或更高版本时创建。

备注

后两个文件名中的 rancher-cluster 部分取决于你命名 RKE 集群配置文件的方式。

故障排除

参见故障排除页面。

后续操作

安装 Rancher