命令行工具

Rancher的命令行界面(CLI)是用来管理Rancher Server的工具。 使用此工具，您可以管理您的环境，主机，应用，服务和容器。

安装

二进制文件可以直接从UI下载。 该链接可以在UI中的页脚右侧找到。 我们有Windows，Mac和Linux的二进制文件。 您还可以查看我们CLI的发布页面 ，您可以从该页面直接下载二进制文件。

配置Rancher命令行界面

有几种方法可以配置Rancher命令行界面与Rancher进行交互时使用的参数。这些参数包括Rancher URL和帐户API密钥等。帐户的API密钥可以在UI中的API中创建。

参数配置有如下的加载优先级。

  • 在执行rancher config时，您需要设置Rancher URL和API密钥。如果您有多个环境，那么您可以选择一个默认环境。
  • 您可以在环境变量中设置相关参数，这将覆盖rancher config中设置的值。
  • 您可以将参数值直接传递给Rancher命令行，那么这些值将覆盖其他方式配置的参数。

使用Rancher配置命令

您可以运行rancher config来设置与Rancher Server连接的配置

  1. $ rancher config
  2. URL []: http://<server_ip>:8080
  3. Access Key []: <accessKey_of_account_api_key>
  4. Secret Key []:  <secretKey_of_account_api_key>
  5. # If there are more than one environment,
  6. # you will be asked to select which environment to work with
  7. Environments:
  8. [1] Default(1a5)
  9. [2] k8s(1a10)
  10. Select: 1
  11. INFO[0017] Saving config to /Users/<username>/.rancher/cli.json

使用环境变量

您可以设置以下环境变量RANCHER_URL，RANCHER_ACCESS_KEY和RANCHER_SECRET_KEY。

  1. # Set the url that Rancher is on
  2. $ export RANCHER_URL=http://<server_ip>:8080
  3. # Set the access key, i.e. username
  4. $ export RANCHER_ACCESS_KEY=<accessKey_of_account_api_key>
  5. # Set the secret key, i.e. password
  6. $ export RANCHER_SECRET_KEY=<secretKey_of_account_api_key>

如果您的Rancher Server中有多个环境，您还需要设置一个环境变量来选择默认环境，即“RANCHER_ENVIRONMENT”。

  1. # Set the environment to use, you can use either environment ID or environment name
  2. $ export RANCHER_ENVIRONMENT=<environment_id>

可选参数传递

如果您选择不运行rancher config或设置环境变量，那么您可以传递相同的值作为rancher命令参数选项的一部分。

  1. $ rancher --url http://server_ip:8080 --access-key <accessKey_of_account_api_key> --secret-key <secretKey_of_account_api_key> --env <environment_id> ps

使用Rancher命令行界面调试

当您使用Rancher命令行时，可以将环境变量“RANCHER_CLIENT_DEBUG”设置为“true”，这样当API被调用时，所有的CLI命令将打印出详细信息。

  1. # Print verbose messages for all CLI calls
  2. $ export RANCHER_CLIENT_DEBUG=true

如果您不想每个CLI命令都打印详细信息，请将环境变量“RANCHER_CLIENT_DEBUG”设置为“false”，然后将—debug传递给指定命令来获取详细消息。

  1. $ rancher --debug env create newEnv

使用环境变量

如果您使用账户的API密钥，您将能够创建和更新环境。 如果您使用一个环境的API密钥，您将无法创建或更新其他环境，您将只能看到现有的环境。

  1. $ rancher env ls
  2. ID        NAME        STATE     CATALOG                           SYSTEM    DETAIL
  3. 1e1       zookeeper   healthy   catalog://community:zookeeper:1   false
  4. 1e2       Default     healthy                                     false
  5. 1e3       App1        healthy                                     false

使用指定的主机

有一些命令(比如说rancher docker和rancher ssh)需要选择指定的主机来使用。您可以设置一个环境变量来选择主机，即RANCHER_DOCKER_HOST，或者传递 –host参数来指定主机。

选择主机之前，您可以列出环境中的所有主机。

  1. $ rancher hosts
  2. ID        HOSTNAME      STATE     IP
  3. 1h1       host-1        active    111.222.333.444
  4. 1h2       host-3        active    111.222.333.445
  5. 1h3       host-2        active    111.222.333.446

现在您可以设置RANCHER_DOCKER_HOST环境变量，或者使用–host参数传入主机ID或主机名来选择不同的主机

  1. # Set the host to always select host-1 (1h1)
  2. $ export RANCHER_DOCKER_HOST=1h1
  3. # List the containers running on host-1
  4. $ rancher docker ps
  5. # List the containers running on host-2
  6. $ rancher --host host-2 docker ps

使用服务和容器

列出所有的服务

在您选择的环境中，您可以查看在环境中运行的所有服务。

  1. $ rancher ps
  2. ID   TYPE                 NAME                IMAGE                       STATE     SCALE   ENDPOINTS            DETAIL
  3. 1s1  service              zookeeper/zk        rawmind/alpine-zk:3.4.8-4   healthy   3
  4. 1s2  service              Default/nginxApp    nginx                       healthy   1
  5. 1s4  service              App1/db1            mysql                       healthy   1
  6. 1s5  service              App1/wordpress      wordpress                   healthy   4
  7. 1s6  loadBalancerService  App1/wordpress-lb                               healthy   1       111.222.333.444:80

列出所有的容器

同样您可以查看环境中的所有容器。

  1. $ rancher ps -c
  2. ID      NAME                       IMAGE                              STATE     HOST   IP              DOCKER         DETAIL
  3. 1i1     zookeeper_zk_zk-volume_1   rawmind/alpine-volume:0.0.1-1      stopped   1h1                    a92b6d3dad18
  4. 1i2     zookeeper_zk_zk-conf_1     rawmind/rancher-zk:0.3.3           stopped   1h1                    2e8085a4b517
  5. 1i3     zookeeper_zk_1             rawmind/alpine-zk:3.4.8-4          healthy   1h1    10.42.150.2     e3ef1c6ff70e
  6. 1i5     zookeeper_zk_zk-volume_2   rawmind/alpine-volume:0.0.1-1      stopped   1h2                    e716f562e0a4
  7. 1i6     zookeeper_zk_zk-conf_2     rawmind/rancher-zk:0.3.3           stopped   1h2                    5cd1cebea5a3
  8. 1i7     zookeeper_zk_2             rawmind/alpine-zk:3.4.8-4          healthy   1h2    10.42.88.102    21984a4445d1
  9. 1i9     zookeeper_zk_zk-volume_3   rawmind/alpine-volume:0.0.1-1      stopped   1h3                    7c614003f08c
  10. 1i10    zookeeper_zk_zk-conf_3     rawmind/rancher-zk:0.3.3           stopped   1h3                    53fb77cd8ae0
  11. 1i11    zookeeper_zk_3             rawmind/alpine-zk:3.4.8-4          healthy   1h3    10.42.249.162   84a80eb8e037
  12. 1i13    Default_nginxApp_1         nginx                              running   1h1    10.42.107.28    e1195a563280
  13. 1i15    App1_db1_1                 mysql                              running   1h3    10.42.116.171   0624e0a7f2fc
  14. 1i16    App1_wordpress_1           wordpress                          running   1h1    10.42.66.199    4bb77abebc08
  15. 1i17    App1_wordpress-lb_1        rancher/lb-service-haproxy:v0.4.2  healthy   1h2    10.42.199.163   5d3a005278d3
  16. 1i18    App1_wordpress_2           wordpress                          running   1h2    10.42.88.114    01ec967c49ac
  17. 1i19    App1_wordpress_3           wordpress                          running   1h3    10.42.218.81    3aae3fc6163a
  18. 1i20    App1_wordpress_4           wordpress                          running   1h1    10.42.202.31    0b67ef86db22

列出指定服务的容器

如果要查看特定服务的容器，可以通过添加服务ID或服务名称列出运行服务的所有容器。

  1. $ rancher ps 1s5
  2. ID      NAME               IMAGE       STATE     HOST      IP             DOCKER         DETAIL
  3. 1i16    App1_wordpress_1   wordpress   running   1h1       10.42.66.199   4bb77abebc08
  4. 1i18    App1_wordpress_2   wordpress   running   1h2       10.42.88.114   01ec967c49ac
  5. 1i19    App1_wordpress_3   wordpress   running   1h3       10.42.218.81   3aae3fc6163a
  6. 1i20    App1_wordpress_4   wordpress   running   1h1       10.42.202.31   0b67ef86db22

使用docker compose文件启动简单的服务

要开始向Rancher添加服务时，您可以创建一个简单的docker-compose.yml文件，以及可选的rancher-compose.yml文件。 如果没有rancher-compose.yml文件，则所有服务的数量将默认为1。

docker-compose.yml示例

  1. version: '2'
  2. services:
  3.   service1:
  4.     image: nginx

rancher-compose.yml示例

  1. version: '2'
  2. services:
  3.   # Reference the service that you want to extend
  4.   service1:
  5.     scale: 2

创建文件后，您可以在Rancher Server中启动对应的服务。

  1. # Creating and starting a service without environment variables and selecting a stack
  2. # If no stack is provided, the stack name will be the folder name that the command is running from
  3. # If the stack does not exist in Rancher, it will be created
  4. # Add in -d at the end to not block and log
  5. $ rancher --url URL_of_Rancher --access-key <username_of_account_api_key> --secret-key <password_of_account_api_key> --env Default up -s stack1 -d
  6.  
  7. # Creating and starting a service with environment variables already set
  8. # Add in -d at the end to not block and log
  9. $ rancher up -s stack1 -d
  10.  
  11. # To change the scale of an existing service, you can use stackName/serviceName or service ID
  12. $ rancher scale Default/service1=3
  13. $ rancher scale 1s4=5

使用Rancher run来启动一个服务

您可以使用Docker CLI添加容器，也可以使用rancher run添加容器到Rancher中。

  1. # Services should be stackName/service_name
  2. $ rancher run --name stackA/service1 nginx

命令参考

要了解更多的命令行支持，请查看我们的Rancher命令文档.