mirror of
https://github.com/rancher/rancher-docs.git
synced 2026-05-04 20:23:24 +00:00
Add version-2.7 docs
This commit is contained in:
Billy Tat
+32
@@ -0,0 +1,32 @@
|
||||
---
|
||||
title: kubectl 实用程序
|
||||
---
|
||||
|
||||
## kubectl
|
||||
|
||||
kubectl 用于与 Rancher 进行交互。
|
||||
|
||||
### kubectl 实用程序
|
||||
|
||||
安装 `kubectl`。详情请参见[安装 kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/)。
|
||||
|
||||
要配置 kubectl，通过 Rancher Web UI 访问你的集群，单击 `Kubeconfig`，然后复制内容并将其粘贴到你的 `~/.kube/config` 文件中。
|
||||
|
||||
检查是否可以成功运行 `kubectl cluster-info` 或 `kubectl get pods` 命令。
|
||||
|
||||
### 使用 kubectl 和 kubeconfig 令牌进行 TTL 认证
|
||||
|
||||
_要求_
|
||||
|
||||
如果管理员[关闭了 kubeconfig 令牌生成](../about-the-api/api-tokens.md#在生成的-kubeconfig-中禁用令牌)，当你运行 `kubectl` 时，kubeconfig 文件需要 [Rancher CLI](./rancher-cli.md) 存在于你的 PATH 中。否则，你会看到这样的错误信息：
|
||||
`Unable to connect to the server: getting credentials: exec: exec: "rancher": executable file not found in $PATH`。
|
||||
|
||||
该功能可以让 kubectl 与 Rancher Server 进行身份验证，并在需要时获得新的 kubeconfig token。目前支持以下验证提供程序：
|
||||
|
||||
1. 本地
|
||||
2. Active Directory (仅限 LDAP)
|
||||
3. FreeIPA
|
||||
4. OpenLDAP
|
||||
5. SAML 身份提供商：Ping，Okta，ADFS，Keycloak 和 Shibboleth
|
||||
|
||||
如果你是第一次运行 kubectl（例如，`kubectl get pods`），它会要求你选择一个验证提供程序并使用 Rancher Server 登录。kubeconfig token 会被缓存到 `./.cache/token` 下你运行 kubectl 的路径中。该 Token 在[过期](../about-the-api/api-tokens.md#在生成的-kubeconfig-中禁用令牌)或[从 Rancher Server 删除](../about-the-api/api-tokens.md#删除令牌)之前都是有效的。过期后，下一个 `kubectl get pods` 命令会要求你再次使用 Rancher Server 登录。
|
||||
+87
@@ -0,0 +1,87 @@
|
||||
---
|
||||
title: Rancher CLI
|
||||
description: Rancher CLI 是一个命令行工具，用于在工作站中与 Rancher 进行交互。
|
||||
---
|
||||
|
||||
Rancher CLI（命令行界面）是一个命令行工具，可用于与 Rancher 进行交互。使用此工具，你可以使用命令行而不用通过 GUI 来操作 Rancher。
|
||||
|
||||
### 下载 Rancher CLI
|
||||
|
||||
你可以直接 UI 下载二进制文件。
|
||||
|
||||
1. 点击左上角的 **☰**。
|
||||
1. 单击底部的 **v2.6.x**，**v2.6.x** 是一个超链接文本，表示已安装的 Rancher 版本。
|
||||
1. 在 **CLI 下载**中，有 Windows、Mac 和 Linux 的二进制文件下载链接。你还可以访问我们的 CLI [发布页面](https://github.com/rancher/cli/releases)直接下载二进制文件。
|
||||
|
||||
### 要求
|
||||
|
||||
下载 Rancher CLI 后，你需要进行一些配置。Rancher CLI 需要：
|
||||
|
||||
- 你的 Rancher Server URL，用于连接到 Rancher Server。
|
||||
- API 持有者令牌（Bearer Token），用于向 Rancher 进行身份验证。有关获取持有者令牌的更多信息，请参阅[创建 API 密钥](../user-settings/api-keys.md)。
|
||||
|
||||
### CLI 身份验证
|
||||
|
||||
在使用 Rancher CLI 控制你的 Rancher Server 之前，你必须使用 API 持有者令牌进行身份验证。运行以下命令进行登录（将 `<BEARER_TOKEN>` 和 `<SERVER_URL>` 替换为你的实际信息）：
|
||||
|
||||
```bash
|
||||
$ ./rancher login https://<SERVER_URL> --token <BEARER_TOKEN>
|
||||
```
|
||||
|
||||
如果 Rancher Server 使用自签名证书，Rancher CLI 会提示你继续连接。
|
||||
|
||||
### 项目选择
|
||||
|
||||
在执行命令之前，你必须先选择一个 Rancher 项目来执行这些命令。要选择[项目](../../how-to-guides/new-user-guides/manage-clusters/projects-and-namespaces.md)，请运行 `./rancher context switch` 命令。输入此命令后，会显示可用项目的列表。输入一个数字以选择项目。
|
||||
|
||||
**示例：`./rancher context switch` 输出**
|
||||
```
|
||||
User:rancher-cli-directory user$ ./rancher context switch
|
||||
NUMBER CLUSTER NAME PROJECT ID PROJECT NAME
|
||||
1 cluster-2 c-7q96s:p-h4tmb project-2
|
||||
2 cluster-2 c-7q96s:project-j6z6d Default
|
||||
3 cluster-1 c-lchzv:p-xbpdt project-1
|
||||
4 cluster-1 c-lchzv:project-s2mch Default
|
||||
Select a Project:
|
||||
```
|
||||
|
||||
输入数字后，控制台会显示你所选项目的消息。
|
||||
|
||||
```
|
||||
INFO[0005] Setting new context to project project-1
|
||||
INFO[0005] Saving config to /Users/markbishop/.ranchcli2.json
|
||||
```
|
||||
|
||||
请确保你可以成功运行 `rancher kubectl get pods`。
|
||||
|
||||
### 命令
|
||||
|
||||
以下命令可用于 Rancher CLI：
|
||||
|
||||
| 命令 | 结果 |
|
||||
|---|---|
|
||||
| `apps, [app]` | 对商店应用（即单个 [Helm Chart](https://docs.helm.sh/developing_charts/)）或 Rancher Chart 执行操作。 |
|
||||
| `catalog` | 对[应用商店](../../pages-for-subheaders/helm-charts-in-rancher.md)执行操作。 |
|
||||
| `clusters, [cluster]` | 对[集群](../../pages-for-subheaders/kubernetes-clusters-in-rancher-setup.md)执行操作。 |
|
||||
| `context` | 在 Rancher [项目](../../how-to-guides/new-user-guides/manage-clusters/projects-and-namespaces.md)之间切换。有关示例，请参阅[项目选择](#项目选择)。 |
|
||||
| `inspect [OPTIONS] [RESOURCEID RESOURCENAME]` | 显示 [Kubernetes 资源](https://kubernetes.io/docs/reference/kubectl/cheatsheet/#resource-types)或 Rancher 资源（即[项目](../../how-to-guides/new-user-guides/manage-clusters/projects-and-namespaces.md)和[工作负载](../../pages-for-subheaders/workloads-and-pods.md)）的详细信息。按名称或 ID 指定资源。 |
|
||||
| `kubectl` | 运行 [kubectl 命令](https://kubernetes.io/docs/reference/kubectl/overview/#operations)。 |
|
||||
| `login, [l]` | 登录 Rancher Server。有关示例，请参阅 [CLI 身份验证](#cli-身份验证)。 |
|
||||
| `namespaces, [namespace]` | 执行命名空间操作。 |
|
||||
| `nodes, [node]` | 执行节点空间操作。 |
|
||||
| `projects, [project]` | 执行[项目](../../how-to-guides/new-user-guides/manage-clusters/projects-and-namespaces.md)操作。 |
|
||||
| `ps` | 显示项目中的[工作负载](../../pages-for-subheaders/workloads-and-pods.md)。 |
|
||||
| `settings, [setting]` | 显示 Rancher Server 的当前设置。 |
|
||||
| `ssh` | 使用 SSH 协议连接到你的某个集群节点。 |
|
||||
| `help, [h]` | 显示命令列表或某个命令的帮助。 |
|
||||
|
||||
|
||||
### Rancher CLI 帮助
|
||||
|
||||
使用 CLI 登录 Rancher Server 后，输入 `./rancher --help` 以获取命令列表。
|
||||
|
||||
所有命令都支持 `--help` 标志，该标志解释了每个命令的用法。
|
||||
|
||||
### 限制
|
||||
|
||||
Rancher CLI **不能**用于安装[仪表板应用程序或 Rancher 功能 Chart](../../pages-for-subheaders/helm-charts-in-rancher.md)。
|
||||
Reference in New Issue
Block a user