CLI

了解 DC/OS 中的命令行界面实用程序

DC/OS 命令行界面 (DC/OS CLI) 实用程序让您可以管理群集节点、安装和管理软件包、检查群集状态以及管理服务和任务。

DC/OS 1.12 需要 DC/OS CLI >= 0.7。安装时,请遵循说明

若要列出可用命令,请运行不带参数的 dcos

$ dcos

Command line utility for the Mesosphere Datacenter Operating
System (DC/OS). The Mesosphere DC/OS is a distributed operating
system built around Apache Mesos. This utility provides tools
for easy management of a DC/OS installation.

Available DC/OS commands:

	auth           	Authenticate to DC/OS cluster
	cluster        	Manage your DC/OS clusters
	config         	Manage the DC/OS configuration file
	help           	Display help information about DC/OS
	job            	Deploy and manage jobs in DC/OS
	marathon       	Deploy and manage applications to DC/OS
	node           	View DC/OS node information
	package        	Install and manage DC/OS software packages
	service        	Manage DC/OS services
	task           	Manage DC/OS tasks

Get detailed command description with 'dcos <command> --help'.

表 1 - 命令

名称 说明
auth 验证 DC/OS 群集
cluster 管理 DC/OS 群集
config 管理 DC/OS 配置文件
help 有关任何命令的帮助
job 在 DC/OS 中部署和管理作业
marathon 在 DC/OS 中部署和管理应用程序
node 查看 DC/OS 节点信息
package 安装和管理 DC/OS 软件包
plugin 管理 CLI 插件
service 管理 DC/OS 服务
task 管理 DC/OS 任务

表 2 - 选项

名称 说明
--version 打印版本信息
-v, -vv 输出详细信息(详细或非常详细)
-h, --help 显示用法帮助。使用“DCOS [命令] -帮助”获取有关命令的更多信息。

如需更多信息,请参阅以下扩展描述:

设置群集

要与群集进行交互,首先需要设置 CLI。

若要显示 DC/OS CLI 版本,请运行:

dcos --version

您将获得类似以下内容的输出信息:

$ dcos --version
dcoscli.version=0.6.1
dcos.version=N/A
dcos.commit=N/A
dcos.bootstrap-id=N/A

DC/OS CLI 版本和配置文件

DC/OS CLI 0.4.x 和 0.5.x 针对配置文件的位置使用不同的结构。

DC/OS CLI 0.4.x 具有单个配置文件,默认情况下存储在 ~/.dcos/dcos.toml。在 DC/OS CLI 0.4.x 中,您可以选择使用 DCOS_CONFIG 环境变量更改配置文件的位置。

DC/OS CLI 0.5.x 具有每个连接群集的配置文件,默认情况下存储在 ~/.dcos/clusters/<cluster_id>/dcos.toml 中。在 DC/OS CLI 0.5.x 中,您可以选择使用 [DCOS_DIR](#dcos-cdir)环境变量更改配置目录的基本部分(~/.dcos)。

  • 如果更新到 DC/OS CLI 0.5.x 并运行任何 CLI 命令,它将触发从旧配置结构到新配置结构的转换。
  • 在调用 dcos cluster setup 后(或已经发生转换),如果您尝试使用 dcos config set 命令更新群集配置,该命令将显示一条警告消息,指出该命令已弃用且群集配置状态现在可能已损坏。

环境变量

DC/OS CLI 支持以下环境变量,可以动态设置。您正在使用的 CLI 版本将决定应使用哪个命令。

DCOS_CLUSTER (仅限 DC/OS CLI 0.5.x 及更高版本)

连接的群集。要设置连接的群集,请使用以下命令设置变量:

dcos cluster setup <cluster-url>

接受所有登录和身份认证问题:

dcos cluster setup https://10.15.150.126 
SHA256 fingerprint of cluster certificate bundle:
FF:65:FE:B4:FF:B8:B6:30:C9:BE:D4:18:EE:03:31:8D:91:D2:A5:56:E8:3D:DF:06:02:E3:98:56:BA:58:07:21 [yes/no] yes
10.15.150.126's username: <username>
username@10.15.150.126's password: <password>

在完成登录程序后,您的 CLI 已准备好与您的群集进行交互。

DC/OS Enterprise CLI

dcos cluster setup 命令安装 插件dcos-core-cli,但不安装 dcos-enterprise-cli。DC/OS Enterprise CLI 必须单独安装。请参阅 安装 DC/OS Enterprise CLI

安装 DC/OS Enterprise CLI 后,您将看到添加的新命令:

  • dcos backup
  • dcos license
  • dcos security
dcos
Command line utility for the Mesosphere Datacenter Operating
System (DC/OS). The Mesosphere DC/OS is a distributed operating
system built around Apache Mesos. This utility provides tools
for easy management of a DC/OS installation.

Available DC/OS commands:

	auth           	Authenticate to DC/OS cluster
	backup         	Access DC/OS backup functionality
	cluster        	Manage your DC/OS clusters
	config         	Manage the DC/OS configuration file
	help           	Display help information about DC/OS
	job            	Deploy and manage jobs in DC/OS
	license        	Manage your DC/OS licenses
	marathon       	Deploy and manage applications to DC/OS
	node           	View DC/OS node information
	package        	Install and manage DC/OS software packages
	security       	DC/OS security related commands
	service        	Manage DC/OS services
	task           	Manage DC/OS tasks

Get detailed command description with 'dcos <command> --help'.

表 3 - DC/OS Enterprise 命令

名称 说明
backup 在其中创建备份和恢复
license 查看许可证的状态、审核您的许可证以及获取或更新许可证
security 管理 DC/OS 证书颁发机构凭据

DCOS_CONFIG(仅限 DC/OS CLI 0.4.x)

此命令显示 DC/OS 配置文件的路径。如果将 DC/OS 配置文件放入 /home/jdoe/config/dcos.toml,请使用以下命令设置变量:

export DCOS_CONFIG=/home/jdoe/config/dcos.toml

如果您已经配置了 DCOS_CONFIG 环境变量:

  • 在转换为[新配置结构] (#configuration-files) 后,不再接受 DCOS_CONFIG
  • 在调用 dcos cluster setup 之前,您可使用 dcos config set 更改 DCOS_CONFIG 指向的配置。该命令会显示一条警告消息,指出该命令已弃用,建议使用 dcos cluster setup

列出群集

DC/OS CLI 可以使用以下命令与多个群集配合使用。

以下命令显示最新配置的群集:

DCOS_DIR(仅限 DC/OS CLI 0.5.x 及更高版本)

如果您希望 DC/OS 配置目录为 /home/jdoe/config 等特定路径,请使用以下命令设置变量:

export DCOS_DIR=/home/jdoe/config

可选择地设置 DCOS_DIR 并运行 dcos cluster setup 命令。

export DCOS_DIR=<path/to/config_dir> (optional, default when not set is ~/.dcos)
dcos cluster setup <url>

此设置根据 $DCOS_DIR/clusters/<cluster_id> 下的群集配置生成和更新。将新设置的群集设置为已连接的群集。

DCOS_SSL_VERIFY

该命令指示是否验证 SSL 证书或设置 SSL 证书路径。您必须手动设置此变量。设置此环境变量相当于在 DC/OS 配置[文件] (#configuration-files) 中设置 dcos config set core.ssl_verify 选项。例如,指示您想要设置 SSL 证书的路径:

export DCOS_SSL_VERIFY=false

列出群集

DC/OS CLI 可以与多个群集配合使用。以下命令显示最新配置的群集:

dcos cluster list
        NAME               ID                        STATUS     VERSION      URL
  *   cluster 26f72c2f-8d03-47d7-b95f-972b1fd3dea2  AVAILABLE    1.12  <cluster-url>

注意:* 表示 CLI 当前已连接到群集名称。如果使用另一个群集再次运行设置命令,您将在列表中看到一个新项目。

DCOS_LOG_LEVEL

该命令向指示级别或更高级别的 stderr 显示日志消息。这相当于 --log-level 命令行选项。严重级别为:

  • debug - 向 stderr 打印所有消息,包括信息、警告、错误以及关键消息。
  • info - 向 stderr 打印信息、警告、错误和关键消息。
  • warning - 向 stderr 打印警告、错误和关键消息。
  • error - 向 stderr 打印错误和关键消息。
  • critical - 仅向 stderr 打印关键信息。

例如,将日志级别设置为 warning

export DCOS_LOG_LEVEL=warning

DCOS_DEBUG

该命令指示是否将其他调试消息打印到 stdout。该参数默认设置为 false。例如:

export DCOS_DEBUG=true