Add v2.13 preview docs

2026-05-04 20:23:24 +00:00 · 2025-10-24 15:50:13 -07:00
parent 1eecb56ddb
commit 51a03551a5
871 changed files with 91807 additions and 0 deletions
@@ -0,0 +1,59 @@
+---
+title: API 密钥
+---
+
+## API 密钥和用户身份验证
+
+如果你想通过外部应用程序来访问 Rancher 集群、项目或其他对象，你可以使用 Rancher API。但是，在你的应用程序可以访问 API 之前，你必须为应用程序提供用于向 Rancher 进行身份验证的密钥。你可以通过 Rancher UI 获取密钥。
+
+使用 Rancher CLI 也需要 API 密钥。
+
+API 密钥由四个组件组成：
+
+- **端点**：其他应用程序用来向 Rancher API 发送请求的 IP 地址和路径。
+- **访问密钥**：Token 的用户名。
+- **密文密钥**：Token 的密码。如果应用程序提示你输入两个不同的字符串进行 API 身份验证，你通常需要将两个密钥一起输入。
+- **持有者令牌**：连接在一起的令牌用户名和密码。如果应用程序提示你输入一个身份验证字符串，则使用此字符串。
+
+:::note
+
+用户可以选择启用[令牌哈希（token hashing）](../../api/api-tokens.md)。
+
+:::
+
+## 创建 API 密钥
+
+1. 从右上角选择**用户头像 > 账号 & API 密钥**。
+
+2. 单击**创建 API 密钥**。
+
+3. **可选**：输入 API 密钥的描述并选择有效期或范围。我们建议设置到期日期。
+
+   API 密钥过期后将失效。有效期短一点会更安全。
+
+   有效期将受 `v3/settings/auth-token-max-ttl-minutes` 约束。如果超过 max-ttl，则会以 max-ttl 为有效期创建 API 密钥。
+
+   范围将限制 API 密钥，使其仅适用于指定集群的 Kubernetes API。如果集群配置了授权集群端点，你将能够直接针对集群的 API 使用设定了范围的令牌，而无需通过 Rancher Server 进行代理。有关详细信息，请参阅[授权集群端点](../../reference-guides/rancher-manager-architecture/communicating-with-downstream-user-clusters.md#4-授权集群端点)。
+
+4. 单击**创建**。
+
+   **步骤结果**：已创建 API 密钥。将会显示你的 API **端点**、**访问密钥**、**密文密钥**和**持有者令牌**。
+
+   使用**持有者令牌**通过 Rancher CLI 进行身份验证。
+
+5. 将显示的信息复制到安全位置。此信息仅显示一次，因此如果你丢失了密钥，则必须制作一个新的。
+
+## 后续操作
+
+- 将 API 密钥信息输入到将向 Rancher API 发送请求的应用程序中。
+- 要了解 Rancher 端点和参数的更多信息，你可以为 Rancher UI 中的对象选择**在 API 中查看**。
+- API 密钥可用于 API 调用和 [Rancher CLI](../cli-with-rancher/cli-with-rancher.md)。
+
+## 删除 API 密钥
+
+如果要撤销 API 密钥，请将其删除。如果出现以下情况，你需要删除 API 密钥：
+
+- API 密钥可能已经泄露。
+- API 密钥已过期。
+
+要删除 API，选择密钥并单击**删除**。
@@ -0,0 +1,51 @@
+---
+title: 管理云凭证
+---
+
+如果要创建[由基础设施提供商托管](../../how-to-guides/new-user-guides/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/use-new-nodes-in-an-infra-provider.md)的集群，则可以使用[节点模板](../../how-to-guides/new-user-guides/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/use-new-nodes-in-an-infra-provider.md#节点模板)来配置集群节点。这些模板使用 Docker Machine 配置选项来定义节点的操作系统镜像以及设置/参数。
+
+节点模板可以使用云凭证来访问在基础设施提供商中配置节点所需的凭证信息。多个节点模板可以使用相同的云凭证。云凭证省去了为同一云提供商重新输入访问密钥的麻烦。云凭证存储在 Kubernetes 密文中。
+
+只有存在标记为 `password` 的字段时，节点模板才会使用云凭证。默认的 `active` 主机驱动将其账号访问字段标记为 `password`，但可能有一些 `inactive` 主机驱动没有使用它们。这些主机驱动不会使用云凭证。
+
+你可以在两种情况下创建云凭证：
+
+- [在为集群创建节点模板期间](../../how-to-guides/new-user-guides/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/use-new-nodes-in-an-infra-provider.md#节点模板)。
+- 在**用户设置**中。
+
+所有云凭证都绑定到创建者的用户配置文件。**不能**与其他用户共享。
+
+## 使用用户设置创建云凭证
+
+1. 点击 **☰ > 集群管理**。
+1. 单击**云凭证**。
+1. 单击**创建**。
+1. 单击云凭证类型。下拉列表中的选项取决于 Rancher 中的 `active` [主机驱动](../../how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/about-provisioning-drivers/manage-node-drivers.md)。
+1. 输入云凭证的名称。
+1. 根据所选的云凭证类型输入所需的值，从而向基础设施提供商进行身份验证。
+1. 单击**创建**。
+
+**结果**：已创建云凭证，它可以立即用于[创建节点模板](../../how-to-guides/new-user-guides/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/use-new-nodes-in-an-infra-provider.md#节点模板)。
+
+## 更新云凭证
+
+如果访问凭证更改或泄露了，你可以通过更新云凭证来进行轮换，同时保留相同的节点模板。
+
+1. 点击 **☰ > 集群管理**。
+1. 单击**云凭证**。
+1. 选择要编辑的云凭证，然后单击 **⋮ > 编辑配置**。
+1. 更新凭证信息并单击**保存**。
+
+**结果**：已使用新的访问凭证更新云凭证。[添加新节点](../../how-to-guides/new-user-guides/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/use-new-nodes-in-an-infra-provider.md)时，所有使用此云凭证的现有节点模板都会自动使用更新的信息。
+
+## 删除云凭证
+
+如果要删除云凭证，云凭证不能有关联的节点模板。如果你无法删除云凭证，请[删除与该云凭证关联的所有节点模板](manage-node-templates.md#删除节点模板)。
+
+1. 点击 **☰ > 集群管理**。
+1. 单击**云凭证**。
+1. 你可以删除单个云凭证或进行批量删除。
+
+   - 要单独删除一个云凭证，请选择你要编辑的云凭证，然后单击 **⋮ > 删除**。
+   - 要批量删除云凭证，请从列表中选择一个或多个云凭证。单击**删除**。
+1. 确认你需要删除这些云凭证。
@@ -0,0 +1,54 @@
+---
+title: 管理节点模板
+---
+
+如果要配置[由基础设施提供商托管](../../how-to-guides/new-user-guides/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/use-new-nodes-in-an-infra-provider.md)的集群，则可以使用[节点模板](../../how-to-guides/new-user-guides/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/use-new-nodes-in-an-infra-provider.md#节点模板)来配置集群节点。这些模板使用 Docker Machine 配置选项来定义节点的操作系统镜像以及设置/参数。你可以在两种情况下创建节点模板：
+
+- [配置节点池集群](../../how-to-guides/new-user-guides/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/use-new-nodes-in-an-infra-provider.md)。
+- 在任何时间使用[用户设置](./user-settings.md)。
+
+创建节点模板时，它会绑定到你的用户配置文件。节点模板不能在用户之间共享。你可以从用户设置中删除不再使用的旧节点模板。
+
+## 创建节点模板
+
+1. 点击 **☰ > 集群管理**。
+1. 单击 **RKE1 配置 > 节点模板**。
+1. 单击**添加模板**。
+1. 选择一个可用的云提供商。然后按照屏幕上的说明配置模板。
+
+**结果**：模板已配置。你可以稍后在[配置节点池集群](../../how-to-guides/new-user-guides/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/use-new-nodes-in-an-infra-provider.md)时使用该模板。
+
+## 更新节点模板
+
+1. 点击 **☰ > 集群管理**。
+1. 单击 **RKE1 配置 > 节点模板**。
+1. 选择要编辑的节点模板并单击 **⋮ > 编辑**。
+
+   :::note
+
+   默认的 `active` [主机驱动](../../how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/about-provisioning-drivers/manage-node-drivers.md)和任何标记了 `password` 字段的主机驱动都需要使用[云凭证](../../how-to-guides/new-user-guides/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/use-new-nodes-in-an-infra-provider.md#云凭证)。
+
+   :::
+
+1. 编辑所需信息并单击**保存**。
+
+**结果**：节点模板已更新。添加新节点时，使用此节点模板的所有节点池都会自动使用更新的信息。
+
+## 克隆节点模板
+
+通过用户设置创建新的节点模板时，可以克隆现有模板并快速更新其设置，而无需从头开始创建新的模板。克隆模板避免了为云提供商重新输入访问密钥的麻烦。
+
+1. 点击 **☰ > 集群管理**。
+1. 单击 **RKE1 配置 > 节点模板**。
+1. 找到要克隆的模板。然后选择 **⋮ > 克隆**。
+1. 填写表单的其余部分。
+
+**结果**：已克隆和配置模板。你可以稍后在[配置节点池集群](../../how-to-guides/new-user-guides/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/use-new-nodes-in-an-infra-provider.md)时使用该模板。
+
+## 删除节点模板
+
+不再使用节点模板时，你可以将其从用户设置中删除。
+
+1. 点击 **☰ > 集群管理**。
+1. 单击 **RKE1 配置 > 节点模板**。
+1. 从列表中选择一个或多个模板。然后点击**删除**。出现提示时确认删除。
@@ -0,0 +1,62 @@
+---
+title: 用户偏好
+---
+
+你可以通过偏好设置来个性化你的 Rancher 体验。要更改偏好设置：
+
+1. 单击右上角的用户头像。
+1. 单击**偏好设置**。
+
+## 语言
+
+选择 Rancher UI 显示的语言。选项包括：
+
+- English
+- 简体中文
+
+## 主题
+
+选择 Rancher UI 的背景颜色。如果选择**自动**，背景颜色会在下午 6 点从浅色变为深色，然后在早上 6 点变回浅色。
+
+## 登录页面
+
+选择登录后显示的页面。选项包括：
+
+- 主页。
+- 上次访问的页面。
+- 你选择的特定集群。
+
+## 显示设置
+
+选择信息的显示方式：
+
+- 日期格式
+- 时间格式
+- 每页行数
+- 在侧边栏显示的集群数量
+
+## 确认设置
+
+_从 v2.7.2 起可用_
+
+选择缩减节点池时是否要求确认。
+
+## 高级功能
+
+- 启用“在 API 中查看”。
+- 显示由 Rancher 管理的 system 命名空间（不要编辑或删除）。
+- 使用快捷键（shift+T）来切换深色/浅色主题。
+- 隐藏所有类型描述。
+- 启用扩展开发者功能。
+
+![](/img/user-preferences-2-7.png)
+
+## YAML 编辑器
+
+- 默认
+- Emacs
+- Vim
+
+## Helm Chart
+
+选择仅显示已发布的 Helm Chart 还是同时包含预发布版本。如果版本符合 [Semantic Versioning 2.0.0](https://semver.org/) 定义的[规范](https://semver.org/#spec-item-9)，则那么该版本为预发布版本。例如，要显示版本为 `0.1.3-dev.12ab4f` 的 Helm chart，你需要先选择`包括预发布版本`。
@@ -0,0 +1,19 @@
+---
+title: 用户设置
+---
+
+<head>
+  <link rel="canonical" href="https://ranchermanager.docs.rancher.com/zh/reference-guides/user-settings"/>
+</head>
+
+在 Rancher 中，每个用户都有很多与登录相关的设置，例如个人偏好、API 密钥等。你可以从**用户设置**菜单中配置这些设置。你可以单击主菜单中的头像来打开此菜单。
+
+![用户设置菜单](/img/user-settings.png)
+
+可用的用户设置包括：
+
+- [API & 密钥](api-keys.md)：如果你想以编程方式与 Rancher 交互，你需要一个 API 密钥。你可以按照本节中的说明获取密钥。
+- [云凭证](manage-cloud-credentials.md)：管理[节点模板](../../how-to-guides/new-user-guides/launch-kubernetes-with-rancher/use-new-nodes-in-an-infra-provider/use-new-nodes-in-an-infra-provider.md#节点模板)使用的云凭证，从而[为集群配置节点](../../how-to-guides/new-user-guides/launch-kubernetes-with-rancher/launch-kubernetes-with-rancher.md)。
+- [节点模板](manage-node-templates.md)：管理 [Rancher 用来为集群配置节点](../../how-to-guides/new-user-guides/launch-kubernetes-with-rancher/launch-kubernetes-with-rancher.md)的模板。
+- [偏好设置](user-preferences.md)：设置 Rancher UI 的表面首选项。
+- 登出：结束你的用户会话。