diff --git a/docs/getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/install-kubernetes.md b/docs/getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/install-kubernetes.md index 87536926b0f..1af552dc7e3 100644 --- a/docs/getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/install-kubernetes.md +++ b/docs/getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/install-kubernetes.md @@ -16,7 +16,7 @@ This section describes how to install a Kubernetes cluster according to our [bes Rancher can be installed on any Kubernetes cluster, including hosted Kubernetes providers. -The steps to set up an air-gapped Kubernetes cluster on RKE, RKE2, or K3s are shown below. +The steps to set up an air-gapped Kubernetes cluster on RKE2 or K3s are shown below. @@ -291,102 +291,9 @@ Upgrading an air-gap environment can be accomplished in the following manner: 2. Run the script again just as you had done in the past with the same environment variables. 3. Restart the RKE2 service. - - -We will create a Kubernetes cluster using Rancher Kubernetes Engine (RKE). Before being able to start your Kubernetes cluster, you’ll need to install RKE and create a RKE config file. - -## 1. Install RKE - -Install RKE by following the instructions in the [RKE documentation.](https://rancher.com/docs/rke/latest/en/installation/) - -:::note - -Certified version(s) of RKE based on the Rancher version can be found in the [Rancher Support Matrix](https://www.suse.com/suse-rancher/support-matrix/all-supported-versions/). - -::: - -## 2. Create an RKE Config File - -From a system that can access ports 22/TCP and 6443/TCP on the Linux host node(s) that you set up in a previous step, use the sample below to create a new file named `rancher-cluster.yml`. - -This file is an RKE configuration file, which is a configuration for the cluster you're deploying Rancher to. - -Replace values in the code sample below with help of the _RKE Options_ table. Use the IP address or DNS names of the three nodes you created. - -:::tip - -For more details on the options available, see the RKE [Config Options](https://rancher.com/docs/rke/latest/en/config-options/). - -::: - -
RKE Options
- -| Option | Required | Description | -| ------------------ | -------------------- | --------------------------------------------------------------------------------------- | -| `address` | ✓ | The DNS or IP address for the node within the air gapped network. | -| `user` | ✓ | A user that can run Docker commands. | -| `role` | ✓ | List of Kubernetes roles assigned to the node. | -| `internal_address` | optional1 | The DNS or IP address used for internal cluster traffic. | -| `ssh_key_path` | | Path to the SSH private key used to authenticate to the node (defaults to `~/.ssh/id_rsa`). | - -> 1 Some services like AWS EC2 require setting the `internal_address` if you want to use self-referencing security groups or firewalls. - -```yaml -nodes: - - address: 10.10.3.187 # node air gap network IP - internal_address: 172.31.7.22 # node intra-cluster IP - user: rancher - role: ['controlplane', 'etcd', 'worker'] - ssh_key_path: /home/user/.ssh/id_rsa - - address: 10.10.3.254 # node air gap network IP - internal_address: 172.31.13.132 # node intra-cluster IP - user: rancher - role: ['controlplane', 'etcd', 'worker'] - ssh_key_path: /home/user/.ssh/id_rsa - - address: 10.10.3.89 # node air gap network IP - internal_address: 172.31.3.216 # node intra-cluster IP - user: rancher - role: ['controlplane', 'etcd', 'worker'] - ssh_key_path: /home/user/.ssh/id_rsa - -private_registries: - - url: # private registry url - user: rancher - password: '*********' - is_default: true -``` - -## 3. Run RKE - -After configuring `rancher-cluster.yml`, bring up your Kubernetes cluster: - -``` -rke up --config ./rancher-cluster.yml -``` - -## 4. Save Your Files - -:::note Important: - -The files mentioned below are needed to maintain, troubleshoot, and upgrade your cluster. - -::: - -Save a copy of the following files in a secure location: - -- `rancher-cluster.yml`: The RKE cluster configuration file. -- `kube_config_cluster.yml`: The [Kubeconfig file](https://rancher.com/docs/rke/latest/en/kubeconfig/) for the cluster, this file contains credentials for full access to the cluster. -- `rancher-cluster.rkestate`: The [Kubernetes Cluster State file](https://rancher.com/docs/rke/latest/en/installation/#kubernetes-cluster-state), this file contains the current state of the cluster including the RKE configuration and the certificates.

_The Kubernetes Cluster State file is only created when using RKE v0.2.0 or higher._ - -:::note - -The "rancher-cluster" parts of the two latter file names are dependent on how you name the RKE cluster configuration file. - -::: - ## Issues or Errors? See the [Troubleshooting](../../install-upgrade-on-a-kubernetes-cluster/troubleshooting.md) page. diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/install-kubernetes.md b/i18n/zh/docusaurus-plugin-content-docs/current/getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/install-kubernetes.md index 4697d957a79..e187c8625dc 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/install-kubernetes.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/install-kubernetes.md @@ -12,7 +12,7 @@ title: '3. 安装 Kubernetes（Docker 安装请跳过）' Rancher 可以安装在任何 Kubernetes 集群上，包括托管的 Kubernetes。 -在 RKE、RKE2 或 K3s 上离线安装 Kubernetes 集群的步骤如下所示： +在 RKE2 或 K3s 上离线安装 Kubernetes 集群的步骤如下所示： @@ -283,102 +283,9 @@ kubectl --kubeconfig ~/.kube/config/rke2.yaml get pods --all-namespaces 2. 使用相同的环境变量再次运行脚本。 3. 重启 RKE2 服务。 - - -我们将使用 Rancher Kubernetes Engine (RKE) 创建一个 Kubernetes 集群。在启动 Kubernetes 集群之前，你需要安装 RKE 并创建 RKE 配置文件。 - -### 1. 安装 RKE - -参照 [RKE 官方文档](https://rancher.com/docs/rke/latest/en/installation/)的说明安装 RKE。 - -:::note - -你可以在 [Rancher 支持矩阵](https://www.suse.com/suse-rancher/support-matrix/all-supported-versions/)中找到基于 Rancher 版本的 RKE 认证版本。 - -::: - -### 2. 创建 RKE 配置文件 - -在可访问你 Linux 主机节点上的 22/TCP 端口和 6443/TCP 端口的系统上，使用以下示例创建一个名为 `rancher-cluster.yml` 的新文件。 - -该文件是 RKE 配置文件，用于配置你要部署 Rancher 的集群。 - -参考下方的 _RKE 选项_ 表格，修改代码示例中的参数。使用你创建的三个节点的 IP 地址或 DNS 名称。 - -:::tip - -如需获取可用选项的详情，请参见 RKE [配置选项](https://rancher.com/docs/rke/latest/en/config-options/)。 - -::: - -
RKE 选项
- -| 选项 | 必填 | 描述 | -| ------------------ | -------------------- | --------------------------------------------------------------------------------------- | -| `address` | ✓ | 离线环境中节点的 DNS 或 IP 地址 | -| `user` | ✓ | 可运行 Docker 命令的用户 | -| `role` | ✓ | 分配给节点的 Kubernetes 角色列表 | -| `internal_address` | 可选1 | 用于集群内部流量的 DNS 或 IP 地址 | -| `ssh_key_path` | | 用来验证节点的 SSH 私钥文件路径（默认值为 `~/.ssh/id_rsa`） | - -> 1 如果你想使用引用安全组或防火墙，某些服务（如 AWS EC2）要求设置 `internal_address`。 - -```yaml -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: # 私有镜像仓库 URL - user: rancher - password: '*********' - is_default: true -``` - -### 3. 运行 RKE - -配置 `rancher-cluster.yml`后，启动你的 Kubernetes 集群： - -``` -rke up --config ./rancher-cluster.yml -``` - -### 4. 保存你的文件 - -:::note 重要提示： - -维护、排除问题和升级集群需要用到以下文件，请妥善保管这些文件： - -::: - -将以下文件的副本保存在安全位置： - -- `rancher-cluster.yml`：RKE 集群配置文件。 -- `kube_config_cluster.yml`：集群的 [Kubeconfig 文件](https://rancher.com/docs/rke/latest/en/kubeconfig/)。该文件包含可完全访问集群的凭证。 -- `rancher-cluster.rkestate`：[Kubernetes 集群状态文件](https://rancher.com/docs/rke/latest/en/installation/#kubernetes-cluster-state)。该文件包含集群的当前状态，包括 RKE 配置以及证书
。
_Kubernetes 集群状态文件仅在使用 RKE 0.2.0 或更高版本时创建。_ - -:::note - -后两个文件名中的 `rancher-cluster` 部分取决于你命名 RKE 集群配置文件的方式。 - -::: - ### 故障排除 参见[故障排除](../../install-upgrade-on-a-kubernetes-cluster/troubleshooting.md)页面。 diff --git a/i18n/zh/docusaurus-plugin-content-docs/version-2.12/getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/install-kubernetes.md b/i18n/zh/docusaurus-plugin-content-docs/version-2.12/getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/install-kubernetes.md index 4697d957a79..e187c8625dc 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/version-2.12/getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/install-kubernetes.md +++ b/i18n/zh/docusaurus-plugin-content-docs/version-2.12/getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/install-kubernetes.md @@ -12,7 +12,7 @@ title: '3. 安装 Kubernetes（Docker 安装请跳过）' Rancher 可以安装在任何 Kubernetes 集群上，包括托管的 Kubernetes。 -在 RKE、RKE2 或 K3s 上离线安装 Kubernetes 集群的步骤如下所示： +在 RKE2 或 K3s 上离线安装 Kubernetes 集群的步骤如下所示： @@ -283,102 +283,9 @@ kubectl --kubeconfig ~/.kube/config/rke2.yaml get pods --all-namespaces 2. 使用相同的环境变量再次运行脚本。 3. 重启 RKE2 服务。 - - -我们将使用 Rancher Kubernetes Engine (RKE) 创建一个 Kubernetes 集群。在启动 Kubernetes 集群之前，你需要安装 RKE 并创建 RKE 配置文件。 - -### 1. 安装 RKE - -参照 [RKE 官方文档](https://rancher.com/docs/rke/latest/en/installation/)的说明安装 RKE。 - -:::note - -你可以在 [Rancher 支持矩阵](https://www.suse.com/suse-rancher/support-matrix/all-supported-versions/)中找到基于 Rancher 版本的 RKE 认证版本。 - -::: - -### 2. 创建 RKE 配置文件 - -在可访问你 Linux 主机节点上的 22/TCP 端口和 6443/TCP 端口的系统上，使用以下示例创建一个名为 `rancher-cluster.yml` 的新文件。 - -该文件是 RKE 配置文件，用于配置你要部署 Rancher 的集群。 - -参考下方的 _RKE 选项_ 表格，修改代码示例中的参数。使用你创建的三个节点的 IP 地址或 DNS 名称。 - -:::tip - -如需获取可用选项的详情，请参见 RKE [配置选项](https://rancher.com/docs/rke/latest/en/config-options/)。 - -::: - -
RKE 选项
- -| 选项 | 必填 | 描述 | -| ------------------ | -------------------- | --------------------------------------------------------------------------------------- | -| `address` | ✓ | 离线环境中节点的 DNS 或 IP 地址 | -| `user` | ✓ | 可运行 Docker 命令的用户 | -| `role` | ✓ | 分配给节点的 Kubernetes 角色列表 | -| `internal_address` | 可选1 | 用于集群内部流量的 DNS 或 IP 地址 | -| `ssh_key_path` | | 用来验证节点的 SSH 私钥文件路径（默认值为 `~/.ssh/id_rsa`） | - -> 1 如果你想使用引用安全组或防火墙，某些服务（如 AWS EC2）要求设置 `internal_address`。 - -```yaml -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: # 私有镜像仓库 URL - user: rancher - password: '*********' - is_default: true -``` - -### 3. 运行 RKE - -配置 `rancher-cluster.yml`后，启动你的 Kubernetes 集群： - -``` -rke up --config ./rancher-cluster.yml -``` - -### 4. 保存你的文件 - -:::note 重要提示： - -维护、排除问题和升级集群需要用到以下文件，请妥善保管这些文件： - -::: - -将以下文件的副本保存在安全位置： - -- `rancher-cluster.yml`：RKE 集群配置文件。 -- `kube_config_cluster.yml`：集群的 [Kubeconfig 文件](https://rancher.com/docs/rke/latest/en/kubeconfig/)。该文件包含可完全访问集群的凭证。 -- `rancher-cluster.rkestate`：[Kubernetes 集群状态文件](https://rancher.com/docs/rke/latest/en/installation/#kubernetes-cluster-state)。该文件包含集群的当前状态，包括 RKE 配置以及证书
。
_Kubernetes 集群状态文件仅在使用 RKE 0.2.0 或更高版本时创建。_ - -:::note - -后两个文件名中的 `rancher-cluster` 部分取决于你命名 RKE 集群配置文件的方式。 - -::: - ### 故障排除 参见[故障排除](../../install-upgrade-on-a-kubernetes-cluster/troubleshooting.md)页面。 diff --git a/versioned_docs/version-2.12/getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/install-kubernetes.md b/versioned_docs/version-2.12/getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/install-kubernetes.md index 87536926b0f..1af552dc7e3 100644 --- a/versioned_docs/version-2.12/getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/install-kubernetes.md +++ b/versioned_docs/version-2.12/getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/install-kubernetes.md @@ -16,7 +16,7 @@ This section describes how to install a Kubernetes cluster according to our [bes Rancher can be installed on any Kubernetes cluster, including hosted Kubernetes providers. -The steps to set up an air-gapped Kubernetes cluster on RKE, RKE2, or K3s are shown below. +The steps to set up an air-gapped Kubernetes cluster on RKE2 or K3s are shown below. @@ -291,102 +291,9 @@ Upgrading an air-gap environment can be accomplished in the following manner: 2. Run the script again just as you had done in the past with the same environment variables. 3. Restart the RKE2 service. - - -We will create a Kubernetes cluster using Rancher Kubernetes Engine (RKE). Before being able to start your Kubernetes cluster, you’ll need to install RKE and create a RKE config file. - -## 1. Install RKE - -Install RKE by following the instructions in the [RKE documentation.](https://rancher.com/docs/rke/latest/en/installation/) - -:::note - -Certified version(s) of RKE based on the Rancher version can be found in the [Rancher Support Matrix](https://www.suse.com/suse-rancher/support-matrix/all-supported-versions/). - -::: - -## 2. Create an RKE Config File - -From a system that can access ports 22/TCP and 6443/TCP on the Linux host node(s) that you set up in a previous step, use the sample below to create a new file named `rancher-cluster.yml`. - -This file is an RKE configuration file, which is a configuration for the cluster you're deploying Rancher to. - -Replace values in the code sample below with help of the _RKE Options_ table. Use the IP address or DNS names of the three nodes you created. - -:::tip - -For more details on the options available, see the RKE [Config Options](https://rancher.com/docs/rke/latest/en/config-options/). - -::: - -
RKE Options
- -| Option | Required | Description | -| ------------------ | -------------------- | --------------------------------------------------------------------------------------- | -| `address` | ✓ | The DNS or IP address for the node within the air gapped network. | -| `user` | ✓ | A user that can run Docker commands. | -| `role` | ✓ | List of Kubernetes roles assigned to the node. | -| `internal_address` | optional1 | The DNS or IP address used for internal cluster traffic. | -| `ssh_key_path` | | Path to the SSH private key used to authenticate to the node (defaults to `~/.ssh/id_rsa`). | - -> 1 Some services like AWS EC2 require setting the `internal_address` if you want to use self-referencing security groups or firewalls. - -```yaml -nodes: - - address: 10.10.3.187 # node air gap network IP - internal_address: 172.31.7.22 # node intra-cluster IP - user: rancher - role: ['controlplane', 'etcd', 'worker'] - ssh_key_path: /home/user/.ssh/id_rsa - - address: 10.10.3.254 # node air gap network IP - internal_address: 172.31.13.132 # node intra-cluster IP - user: rancher - role: ['controlplane', 'etcd', 'worker'] - ssh_key_path: /home/user/.ssh/id_rsa - - address: 10.10.3.89 # node air gap network IP - internal_address: 172.31.3.216 # node intra-cluster IP - user: rancher - role: ['controlplane', 'etcd', 'worker'] - ssh_key_path: /home/user/.ssh/id_rsa - -private_registries: - - url: # private registry url - user: rancher - password: '*********' - is_default: true -``` - -## 3. Run RKE - -After configuring `rancher-cluster.yml`, bring up your Kubernetes cluster: - -``` -rke up --config ./rancher-cluster.yml -``` - -## 4. Save Your Files - -:::note Important: - -The files mentioned below are needed to maintain, troubleshoot, and upgrade your cluster. - -::: - -Save a copy of the following files in a secure location: - -- `rancher-cluster.yml`: The RKE cluster configuration file. -- `kube_config_cluster.yml`: The [Kubeconfig file](https://rancher.com/docs/rke/latest/en/kubeconfig/) for the cluster, this file contains credentials for full access to the cluster. -- `rancher-cluster.rkestate`: The [Kubernetes Cluster State file](https://rancher.com/docs/rke/latest/en/installation/#kubernetes-cluster-state), this file contains the current state of the cluster including the RKE configuration and the certificates.

_The Kubernetes Cluster State file is only created when using RKE v0.2.0 or higher._ - -:::note - -The "rancher-cluster" parts of the two latter file names are dependent on how you name the RKE cluster configuration file. - -::: - ## Issues or Errors? See the [Troubleshooting](../../install-upgrade-on-a-kubernetes-cluster/troubleshooting.md) page.