Fix v2.6 level-1 headings

2026-09-27 13:38:07 +00:00 · 2022-11-23 15:14:44 +08:00
parent 6782aeaaa4
commit 3a397c2a87
72 changed files with 279 additions and 254 deletions
@@ -16,14 +16,14 @@ Rancher 安装在 RKE Kubernetes 集群、K3s Kubernetes 集群，或单个 Dock

 :::

-# 安装概要
+## 安装概要

 1. [设置基础设施和私有镜像仓库](../getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/infrastructure-private-registry.md)
 2. [收集镜像到私有镜像仓库](../getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/publish-images.md)
 3. [设置 Kubernetes 集群（如果你使用 Docker 安装，请跳过此步骤）](../getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/install-kubernetes.md)
 4. [安装 Rancher](../getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/install-rancher-ha.md)

-# 升级
+## 升级

 如需在离线环境中使用 Helm CLI 升级 Rancher，请按照[升级步骤](../getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/upgrades.md)进行操作。

@@ -2,11 +2,11 @@
 title: AWS Marketplace 集成
 ---

-# 概述
+## 概述

 Rancher 提供了与 AWS Marketplace 的集成，允许用户向 SUSE 购买支持。此集成帮助你在需要使用更多集群时轻松调整支持需求。

-# 限制
+## 限制

 - 必须使用 Rancher v2.6.7 或更高版本。
 - Rancher 必须在启用其他指标的情况下进行部署。
@@ -14,11 +14,12 @@ Rancher 提供了与 AWS Marketplace 的集成，允许用户向 SUSE 购买支
 - 必须通过 AWS Marketplace 购买至少一项 Rancher 支持的 Entitlement。
 - 你可能需要额外的设置来支持代理/离线用例。有关详细信息，请参阅[先决条件](../integrations-in-rancher/cloud-marketplace/aws-cloud-marketplace/adapter-requirements.md)。

-# 如何使用
+## 如何使用
+
 1. 完成[先决条件步骤](../integrations-in-rancher/cloud-marketplace/aws-cloud-marketplace/adapter-requirements.md)。
 2. [安装 CSP Adapter](../integrations-in-rancher/cloud-marketplace/aws-cloud-marketplace/install-adapter.md)。

-# 常见问题
+## 常见问题

 **我以后后续再购买更多节点的支持吗？**

@@ -11,7 +11,7 @@ title: 配置 Shibboleth (SAML)
 > 本节假定你已了解 Rancher，Shibboleth 和 OpenLDAP 是如何协同工作的。有关工作原理的详细说明，请参见[本页](../how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/configure-shibboleth-saml/about-group-permissions.md)。


-# 在 Rancher 中设置 Shibboleth
+## 在 Rancher 中设置 Shibboleth

 ### Shibboleth 先决条件
 >
@@ -73,7 +73,7 @@ SAML 协议不支持用户或用户组的搜索或查找。因此，如果你没

 要在 Rancher 中分配权限时启用搜索组，你需要为支持组的 SAML 身份验证提供商配置后端（例如 OpenLDAP）。

-# 在 Rancher 中设置 OpenLDAP
+## 在 Rancher 中设置 OpenLDAP

 如果你将 OpenLDAP 配置为 Shibboleth 的后端，SAML 断言会返回到 Rancher，其中包括用于引用组的用户属性。然后，通过身份验证的用户将能够访问其所在的组有权访问的 Rancher 资源。

@@ -96,6 +96,6 @@ SAML 协议不支持用户或用户组的搜索或查找。因此，如果你没
 1. 在左侧导航栏，单击**认证**。
 1. 单击 **OpenLDAP**。将显示**配置 OpenLDAP 服务器**表单。

-# 故障排除
+## 故障排除

 如果在测试与 OpenLDAP 服务器的连接时遇到问题，请首先仔细检查为 ServiceAccount 输入的凭证以及搜索库配置。你还可以检查 Rancher 日志来查明问题的原因。调试日志可能包含有关错误的更详细信息。详情请参见[如何启用调试日志](../faq/technical-items.md#如何启用调试日志记录？)。
@@ -20,7 +20,7 @@ Rancher 包含一些默认关闭的实验功能。在某些情况下，例如当

 如果你安装 Rancher 后使用 Rancher API 将功能开关设置为 true，然后在使用命令升级 Rancher 时将功能开关设置为 false，在这种情况下，虽然默认值会是 false，但是该功能依然会被启用，因为它是通过 API 设置的。如果你随后使用 Rancher API 删除设置值（true）并将它设置为 NULL，则默认值（false）将生效。有关详细信息，请参阅[功能开关页面](../getting-started/installation-and-upgrade/installation-references/feature-flags.md)。

-# 启动 Rancher 时启用功能
+## 启动 Rancher 时启用功能

 安装 Rancher 时，使用功能开关启用你所需的功能。通过单节点容器安装 Rancher，和在 Kubernetes 集群上安装 Rancher 对应的命令有所不同。

@@ -81,7 +81,7 @@ docker run -d -p 80:80 -p 443:443 \
 ```


-# 使用 Rancher UI 启用功能
+## 使用 Rancher UI 启用功能

 1. 在左上角，单击 **☰ > 全局设置**。
 1. 单击**功能开关**。
@@ -97,7 +97,7 @@ docker run -d -p 80:80 -p 443:443 \

 **结果**：该功能已禁用。

-# 使用 Rancher API 启用功能
+## 使用 Rancher API 启用功能

 1. 前往 `<RANCHER-SERVER-URL>/v3/features`。
 1. 在 `data` 中，你会看到一个数组，该数组包含所有能通过功能开关启用的功能。功能的名称在 `id` 字段中。单击要启用的功能的名称。
@@ -15,7 +15,7 @@ Cluster Autoscaler 运行在 Kubernetes master 节点上。它可以在 `kube-sy

 你可以在 worker 节点上运行 Cluster Autoscaler 的自定义 deployment，但需要小心以保证 Cluster Autoscaler 能正常运行。

-# 云提供商
+## 云提供商

 Cluster Autoscaler 为不同的云提供商提供支持。有关详细信息，请参见 [Cluster Autoscaler 支持的云提供商](https://github.com/kubernetes/autoscaler/tree/master/cluster-autoscaler#deployment)。

@@ -9,7 +9,7 @@ import TabItem from '@theme/TabItem';
 在本节中，你将学习如何使用 Helm CLI 在 Kubernetes 集群上部署 Rancher。


-# 先决条件
+## 先决条件

 - [Kubernetes 集群](#kubernetes-集群)
 - [Ingress Controller](#ingress-controller)
@@ -47,7 +47,7 @@ Rancher UI 和 API 通过 Ingress 公开。换言之，安装 Rancher 的 Kubern
 - [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/#install-kubectl) - Kubernetes 命令行工具。
 - [Helm](https://docs.helm.sh/using_helm/#installing-helm) - Kubernetes 的包管理器。请参见 [Helm 版本要求](../getting-started/installation-and-upgrade/resources/helm-version-requirements.md)选择 Helm 版本来安装 Rancher。请为你的具体平台参见 [Helm 项目提供的说明](https://helm.sh/docs/intro/install/)。

-# 安装 Rancher Helm Chart
+## 安装 Rancher Helm Chart

 Rancher 是使用 Kubernetes 的 [Helm](https://helm.sh/) 包管理器安装的。Helm Chart 为 Kubernetes YAML 清单文件提供了模板语法。通过 Helm，用户可以创建可配置的 deployment，而不仅仅只能使用静态文件。

@@ -5,7 +5,7 @@ description: 了解如何在开发和生产环境中安装 Rancher。了解单

 本节介绍了 Rancher 各种安装方式以及每个安装方式的优点。

-# 名词解释
+## 名词解释

 本章节涉及以下名词：

@@ -16,7 +16,7 @@ description: 了解如何在开发和生产环境中安装 Rancher。了解单

 `restrictedAdmin` Helm Chart 选项在 **Rancher Server** 可用。如果该选项设置为 true，初始的 Rancher 用户访问本地 Kubernetes 集群会受到限制，以避免权限升级。详情请参见 [restricted-admin 角色](../how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/global-permissions.md#受限管理员)。

-# 安装方式概述
+## 安装方式概述

 Rancher 可以安装在以下主要架构上：

@@ -62,10 +62,11 @@ Rancher backup operator 可将 Rancher 从单个 Docker 容器迁移到高可用

 如需进一步了解 Rancher 架构，请参见[架构概述](rancher-manager-architecture.md)，[生产级别架构推荐](../reference-guides/rancher-manager-architecture/architecture-recommendations.md)或[最佳实践指南](../reference-guides/best-practices/rancher-server/tips-for-running-rancher.md)。

-# 先决条件
+## 先决条件
+
 安装 Rancher 之前，请确保你的节点满足所有[安装要求](installation-requirements.md)。

-# 架构建议
+## 架构建议

 为了达到最佳性能和安全性，我们建议你为 Rancher Management Server 使用单独的专用 Kubernetes 集群。不建议在此集群上运行用户工作负载。部署 Rancher 后，你可以[创建或导入集群](kubernetes-clusters-in-rancher-setup.md)来运行你的工作负载。

@@ -35,7 +35,7 @@ description: 如果 Rancher 配置在 Docker 或 Kubernetes 中运行时，了

 Rancher UI 在基于 Firefox 或 Chromium 的浏览器（Chrome、Edge、Opera、Brave 等）中效果最佳。

-# 操作系统和容器运行时要求
+## 操作系统和容器运行时要求

 Rancher 兼容当前所有的主流 Linux 发行版。

@@ -77,11 +77,11 @@ Rancher 需要安装在支持的 Kubernetes 版本上。如需了解你使用的

 如需了解 RKE2 通过了哪些操作系统版本的测试，请参见[支持和维护条款](https://rancher.com/support-maintenance-terms/)。

-# 硬件要求
+## 硬件要求

 本节描述安装 Rancher Server 的节点的 CPU、内存和磁盘要求。

-# CPU 和内存
+## CPU 和内存

 硬件要求根据你的 Rancher 部署规模而定。请根据要求配置每个节点。通过单节点容器安装 Rancher，和在 Kubernetes 集群上安装 Rancher 的要求有所不同。

@@ -134,7 +134,7 @@ Rancher 需要安装在支持的 Kubernetes 版本上。如需了解你使用的
 | 小 | 最多 5 个 | 最多 50 个 | 1 | 4 GB |
 | 中 | 最多 15 个 | 最多 200 个 | 2 | 8 GB |

-# Ingress
+## Ingress

 安装 Rancher 的 Kubernetes 集群中的每个节点都应该运行一个 Ingress。

@@ -148,11 +148,11 @@ Ingress 需要部署为 DaemonSet 以确保负载均衡器能成功把流量转
 - **AKS**：[使用 Azure Kubernetes 服务安装 Rancher 以及如何安装 Ingress 以访问 Rancher Server](../getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rancher-on-aks.md)。
 - **GKE**：[使用 GKE 安装 Rancher 以及如何安装 Ingress 以访问 Rancher Server](../getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rancher-on-gke.md)。

-# 磁盘
+## 磁盘

 etcd 在集群中的性能决定了 Rancher 的性能。因此，为了获得最佳速度，我们建议使用 SSD 磁盘来支持 Rancher 管理的 Kubernetes 集群。在云提供商上，你还需使用能获得最大 IOPS 的最小大小。在较大的集群中，请考虑使用专用存储设备存储 etcd 数据和 wal 目录。

-# 网络要求
+## 网络要求

 本节描述了安装 Rancher Server 的节点的网络要求。

@@ -170,6 +170,6 @@ etcd 在集群中的性能决定了 Rancher 的性能。因此，为了获得最

 为了确保能正常运行，Rancher 需要在 Rancher 节点和下游 Kubernetes 集群节点上开放一些端口。不同集群类型的 Rancher 和下游集群的所有必要端口，请参见[端口要求](../getting-started/installation-and-upgrade/installation-requirements/port-requirements.md)。

-# Dockershim 支持
+## Dockershim 支持

 有关 Dockershim 支持的详情，请参见[此页面](../getting-started/installation-and-upgrade/installation-requirements/dockershim.md)。
@@ -6,7 +6,7 @@ title: 设置指南

 如果你使用 Istio 进行流量管理，则需要允许外部流量进入集群。在这种情况下，你将需要执行以下所有步骤。

-# 先决条件
+## 先决条件

 本指南假设你已经[安装 Rancher](installation-and-upgrade.md)，且已经[配置了一个单独的 Kubernetes 集群](kubernetes-clusters-in-rancher-setup.md)并要在该集群上安装 Istio。

@@ -14,8 +14,7 @@ title: 设置指南

 Istio 控制的工作负载和服务必须满足 [Istio 要求](https://istio.io/docs/setup/additional-setup/requirements/)。

-
-# 安装
+## 安装

 :::tip 快速设置提示：

@@ -11,7 +11,7 @@ title: Kubernetes 组件
 - [nginx-proxy 节点故障排除](../troubleshooting/kubernetes-components/troubleshooting-nginx-proxy.md)
 - [Worker 节点和通用组件故障排除](../troubleshooting/kubernetes-components/troubleshooting-worker-nodes-and-generic-components.md)

-# Kubernetes 组件图
+## Kubernetes 组件图

 ![集群图](/img/clusterdiagram.svg)<br/>
 <sup>线条表示组件之间的通信。而颜色纯粹用于视觉辅助。</sup>
@@ -34,7 +34,7 @@ Rancher 还可以创建节点池。在托管在云厂商的节点池上安装 Ku

 有关详细信息，请参阅[自定义节点](use-existing-nodes.md)。

-# 以编程方式创建 RKE 集群
+### 以编程方式创建 RKE 集群

 通过 Rancher 以编程方式部署 RKE 集群的最常见方法是使用 Rancher 2 Terraform Provider。详情请参见[使用 Terraform 创建集群](https://registry.terraform.io/providers/rancher/rancher2/latest/docs/resources/cluster)。

@@ -75,6 +75,6 @@ RKE2 还支持在预配置的虚拟机或裸机节点上安装自定义集群。

 如果要重复使用之前的自定义集群中的节点，请在复用之前清理节点。如果你重复使用尚未清理的节点，则集群配置可能会失败。

-# 以编程方式创建 RKE2 集群
+### 以编程方式创建 RKE2 集群

 通过 Rancher 以编程方式部署 RKE2 集群的最常见方法是使用 Rancher 2 Terraform Provider。详情请参见[使用 Terraform 创建集群](https://registry.terraform.io/providers/rancher/rancher2/latest/docs/resources/cluster_v2)。
@@ -23,11 +23,11 @@ Monitoring 应用允许你：
 - 根据 Prometheus 收集的指标，将预先计算的、经常需要的，或计算成本高的表达式定义为新的时间序列
 - 通过 Prometheus Adapter，将从 Prometheus 收集的指标公开给 Kubernetes Custom Metrics API，以便在 HPA 中使用

-# Monitoring 的工作原理
+## Monitoring 的工作原理

 有关 monitoring 组件如何协同工作的说明，请参阅[此页面](../integrations-in-rancher/monitoring-and-alerting/how-monitoring-works.md)。

-# 默认组件和部署
+## 默认组件和部署

 ### 内置仪表板

@@ -48,11 +48,11 @@ Monitoring 应用会默认部署一些告警。要查看默认告警，请转到

 有关 Rancher UI 中公开的监控组件列表，以及编辑它们的常见用例，请参阅[本节](../integrations-in-rancher/monitoring-and-alerting/how-monitoring-works.md#rancher-ui-中公开的组件)。

-# RBAC
+## RBAC

 有关配置 monitoring 访问权限的信息，请参阅[此页面](../integrations-in-rancher/monitoring-and-alerting/rbac-for-monitoring.md)。

-# 指南
+## 指南

 - [启用 monitoring](../how-to-guides/advanced-user-guides/monitoring-alerting-guides/enable-monitoring.md)
 - [卸载 monitoring](../how-to-guides/advanced-user-guides/monitoring-alerting-guides/uninstall-monitoring.md)
@@ -62,7 +62,7 @@ Monitoring 应用会默认部署一些告警。要查看默认告警，请转到
 - [调试高内存使用率](../how-to-guides/advanced-user-guides/monitoring-alerting-guides/debug-high-memory-usage.md)
 - [从 Monitoring V1 迁移到 V2](../how-to-guides/advanced-user-guides/monitoring-alerting-guides/migrate-to-rancher-v2.5+-monitoring.md)

-# 配置
+## 配置

 ### 在 Rancher 中配置 Monitoring 资源

@@ -79,7 +79,7 @@ Monitoring 应用会默认部署一些告警。要查看默认告警，请转到

 有关 `rancher-monitoring` Chart 选项的更多信息，包括设置资源限制和请求的选项，请参阅[此页面](../reference-guides/monitoring-v2-configuration/helm-chart-options.md)。

-# Windows 集群支持
+## Windows 集群支持

 如果 Monitoring 部署到 RKE1 Windows 集群，Monitoring V2 将自动部署 [windows-exporter](https://github.com/prometheus-community/windows_exporter) DaemonSet 并设置 ServiceMonitor，以从每个部署的 Pod 中收集指标。这将使用 `windows_` 指标填充 Prometheus，这些指标与 [node_exporter](https://github.com/prometheus/node_exporter) 为 Linux 主机导出的 `node_` 指标类似。

@@ -88,8 +88,7 @@ Monitoring 应用会默认部署一些告警。要查看默认告警，请转到
 有关如何在现有 Windows 主机上升级 wins 版本的更多详细信息，请参阅 [Windows 集群对 Monitoring V2 的支持](../integrations-in-rancher/monitoring-and-alerting/windows-support.md)。


-
-# 已知问题
+## 已知问题

 有一个[已知问题](https://github.com/rancher/rancher/issues/28787#issuecomment-693611821)，即 K3s 集群需要更多的默认内存。如果你在 K3s 集群上启用 monitoring，我们建议将 `prometheus.prometheusSpec.resources.memory.limit` 设置为 2500 Mi，并将 `prometheus.prometheusSpec.resources.memory.request` 设置为 1750 Mi。

@@ -6,7 +6,7 @@ title: 配置

 有关为 Prometheus 配置自定义抓取目标和规则的信息，请参阅 [Prometheus Operator](https://github.com/prometheus-operator/prometheus-operator) 的上游文档。Prometheus Operator [设计文档](https://github.com/prometheus-operator/prometheus-operator/blob/master/Documentation/design.md)中解释了一些最重要的自定义资源。Prometheus Operator 文档还可以帮助你设置 RBAC、Thanos 或进行自定义配置。

-# 设置资源限制和请求
+## 设置资源限制和请求

 安装 `rancher-monitoring` 时可以配置 Monitoring 应用的资源请求和限制。有关默认限制的更多信息，请参阅[此页面](../reference-guides/monitoring-v2-configuration/helm-chart-options.md#配置资源限制和请求)。

@@ -16,7 +16,7 @@ title: 配置

 :::

-# Prometheus 配置
+## Prometheus 配置

 通常不需要直接编辑 Prometheus 自定义资源。

@@ -31,7 +31,7 @@ title: 配置

 有关直接编辑 Prometheus 自定义资源（对高级用例可能有帮助）的更多信息，请参阅[此页面](../how-to-guides/advanced-user-guides/monitoring-v2-configuration-guides/advanced-configuration/prometheus.md)。

-# Alertmanager 配置
+## Alertmanager 配置

 Alertmanager 自定义资源通常不需要直接编辑。在常见用例中，你可以通过更新路由和接收器来管理告警。

@@ -12,6 +12,6 @@ Nutanix 集群可能由多组具有不同属性（例如内存或 vCPU 数量）
 - [创建 Nutanix 集群](../how-to-guides/new-user-guides/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/nutanix/provision-kubernetes-clusters-in-aos.md#创建-nutanix-aos-集群)
 - [配置存储](../how-to-guides/new-user-guides/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/nutanix/provision-kubernetes-clusters-in-aos)

-# 创建 Nutanix 集群
+## 创建 Nutanix 集群

 在[本节](../how-to-guides/new-user-guides/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/nutanix/provision-kubernetes-clusters-in-aos.md)中，你将学习如何使用 Rancher 在 Nutanix AOS 中安装 [RKE](https://rancher.com/docs/rke/latest/en/) Kubernetes 集群。
@@ -6,7 +6,7 @@ title: 使用 HTTP 代理安装 Rancher

 另外，用户也可以在没有任何互联网访问的情况下离线设置 Rancher。详情请参见 [Rancher 官方文档](air-gapped-helm-cli-install.md)。

-# 安装概要
+## 安装概要

 1. [配置基础设施](../getting-started/installation-and-upgrade/other-installation-methods/rancher-behind-an-http-proxy/set-up-infrastructure.md)
 2. [配置 Kubernetes 集群](../getting-started/installation-and-upgrade/other-installation-methods/rancher-behind-an-http-proxy/install-kubernetes.md)
@@ -17,19 +17,19 @@ Rancher 的 Docker 安装仅推荐用于开发和测试环境中。Rancher 版

 Rancher backup operator 可将 Rancher 从单个 Docker 容器迁移到高可用 Kubernetes 集群上。详情请参见[把 Rancher 迁移到新集群](../how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/migrate-rancher-to-new-cluster.md)。

-### Rancher 特权访问
+## Rancher 特权访问

 当 Rancher Server 部署在 Docker 容器中时，容器内会安装一个本地 Kubernetes 集群供 Rancher 使用。为 Rancher 的很多功能都是以 deployment 的方式运行的，而在容器内运行容器是需要特权模式的，因此你需要在安装 Rancher 时添加 `--privileged` 选项。

-# 操作系统，Docker，硬件和网络要求
+## 操作系统，Docker，硬件和网络要求

 请确保你的节点满足常规的[安装要求](installation-requirements.md)。

-# 1. 配置 Linux 主机
+## 1. 配置 Linux 主机

 按照[要求](installation-requirements.md)配置一个 Linux 主机，用于运行 Rancher Server。

-# 2. 选择一个 SSL 选项并安装 Rancher
+## 2. 选择一个 SSL 选项并安装 Rancher

 出于安全考虑，使用 Rancher 时请使用 SSL（Secure Sockets Layer）。SSL 保护所有 Rancher 网络通信（如登录和与集群交互）的安全。

@@ -9,7 +9,7 @@ description: 要创建具有自定义节点的集群，你需要访问集群中

 本节介绍如何设置自定义集群。

-# 使用自定义节点创建集群
+## 使用自定义节点创建集群

 :::note 使用 Windows 主机作为 Kubernetes Worker 节点？

@@ -17,7 +17,6 @@ description: 要创建具有自定义节点的集群，你需要访问集群中

 :::

-
 ### 1. 配置 Linux 主机

 你可以通过配置 Linux 主机，来创建自定义集群。你的主机可以是：
@@ -130,7 +129,7 @@ Key=kubernetes.io/cluster/<CLUSTERID>, Value=owned
 Key=kubernetes.io/cluster/CLUSTERID, Value=shared
 ```

-# 可选的后续步骤
+## 可选的后续步骤

 创建集群后，你可以通过 Rancher UI 访问集群。最佳实践建议你设置以下访问集群的备用方式：