一、Rancher Cli 简介
Rancher命令行界面(CLI)是用于管理Rancher服务器的统一工具。使用此工具,您可以控制环境,主机,堆栈,服务和容器。
官方网站:https://www.rancher.cn/docs/rancher/v2.x/cn/configuration/cli/
二、Rancher Cli 安装
1、使用脚本安装 Rancher Cli(推荐)
# 下载特定版本 rancher
sudo wget https://releases.rancher.com/cli2/v2.2.0/rancher-linux-amd64-v2.2.0.tar.gz
# 解压到当前目录
sudo tar -zxvf rancher-linux-amd64-v2.2.0.tar.gz
# 切换到rancher目录
sudo cd rancher-v2.2.0/
# 制作kubectl二进制可执行文件
sudo chmod +x ./rancher
# 将二进制文件移动到PATH中
sudo mv ./rancher /usr/local/bin/rancher
# 测试以确保您安装的版本是最新的
rancher --version
2、使用安装包管理安装 Rancher Cli
Rancher CLI有Windows,Mac和Linux的二进制文件。Rancher CLI二进制文件可以直接从Rancher UI下载,下载链接可以从Rancher UI右下角找到。
但是,UI上的下载链接是在Github上,可能网络原因会下载很慢。因此,您还可以从文件下载页面下载最新版本的二进制文件。
https://www.cnrancher.com/docs/rancher/v2.x/cn/install-prepare/download/cli/
下载最近版本安装包后,使用SSH工具上传到服务器的根目录:
然后执行如下命令:
# 解压到当前目录
sudo tar -zxvf rancher-linux-amd64-v2.2.0.tar.gz
# 切换到rancher目录
sudo cd rancher-v2.2.0/
# 制作kubectl二进制可执行文件
sudo chmod +x ./rancher
# 将二进制文件移动到PATH中
sudo mv ./rancher /usr/local/bin/rancher
# 测试以确保您安装的版本是最新的
rancher --version
三、Rancher Cli 配置
1、运行要求
下载 Rancher CLI 后,您需要进行一些配置。 Rancher CLI 要求:
- 需要使用Rancher Server URL去连接Rancher Server.
- API KEY,用于向Rancher进行身份验证。更多信息,请参考创建API Key.
2、获取 API KEY
1、点击管理界面右侧logo;进入 “API & Keys” 界面
2、点击 “添加Key”;
3、输入 “Rancher Client Token”,选择作用集群范围(如果需要操作所有的集群,务必选择“未指定作用范围”)
,点击“创建” 按钮。
4、记录下 API Key 界面的内容,以便后面使用。
API访问地址:
https://192.168.1.114/v3
Access Key(用户名):
token-flhdm
Secret Key(密码):
wl2wcwkrzjnmbdbvzlng5ntzsj98jn6r5dkr8j5kcdgv9tfx4khczd
Bearer Token:
token-flhdm:wl2wcwkrzjnmbdbvzlng5ntzsj98jn6r5dkr8j5kcdgv9tfx4khczd
3、CLI登录认证
1、在使用Rancher CLI控制Rancher Server之前,必须使用API Bearer Token登录进行身份验证。
使用以下命令登录:
./rancher login https://SERVER_URL --token BEARER_TOKEN
- 替换 BEARER_TOKEN 和 SERVER_URL
如下格式:
rancher login https://192.168.1.114/v3 --token token-flhdm:wl2wcwkrzjnmbdbvzlng5ntzsj98jn6r5dkr8j5kcdgv9tfx4khczd
2、如果Rancher Server使用自签名证书,Rancher CLI会提示您是否继续连接
3、输入yes,接着会让您选择默认项目:(输入编号)
4、输入番号后,会自动保存一个cli配置文件,后期的登录就不会再次要求登录了
5、接着可以输入rancher node查看节点信息:
四、项目切换
如果需要操作其他项目,需要先进行项目切换,通过 ./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/.rancher/cli2.json
五、命令参数
使用CLI登录Rancher Server后,输入./rancher –help以获取命令列表。 所有命令都接受–help标志,该标志记录每个命令的用法。
命令 | 结果 |
---|---|
apps, [app] | 对应用商店(即单个Helm chart或Rancher chart)执行操作。 |
catalog | 对应用商店)执行操作。 |
clusters, [cluster] | 在集群上执行操作。 |
context | 在Rancher 项目之间切换。有关示例,请参阅项目选择。 |
inspect [OPTIONS] [RESOURCEID RESOURCENAME] | 显示有关Kubernetes资源或Rancher资源(即:项目和工作负载)的详细信息。按名称或ID指定资源。 |
kubectl | 运行kubectl命令。 |
login, [l] | 登录Rancher Server。有关示例,请参阅CLI身份验证。 |
namespaces, [namespace] | 对命名空间执行操作。 |
nodes, [node] | 在节点上执行操作。 |
projects, [project] | 在项目执行操作。 |
ps | 显示项目中的工作负载。 |
settings, [setting] | 显示Rancher Server的当前设置。 |
ssh | 使用SSH协议连接到您的一个集群节点。 |
help, [h] | 显示一个命令的命令列表或帮助。 |
更新时间:2024-08-02 14:28