CLI

CLI

You can use the DC/OS command-line interface (CLI) to manage your cluster nodes, install DC/OS packages, inspect the cluster state, and administer the DC/OS service subcommands.

You can quickly install the CLI from the DC/OS web interface.

To list available commands, either run dcos with no parameters or run dcos help:

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
    config             Manage the DC/OS configuration file
    experimental       Experimental commands. These commands are under development and are subject to change
    help               Display help information about DC/OS
    job                Deploy and manage jobs in DC/OS
    marathon           Deploy and manage applications to DC/OS
    node               Administer and manage DC/OS cluster nodes
    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'.

Environment Variables

These environment variables are supported by the DC/OS CLI and can be set dynamically.

DCOS_CONFIG

Set the path to the DC/OS configuration file. By default, this variable is set to DCOS_CONFIG=/<home-directory>/.dcos/dcos.toml. For example, if you moved your DC/OS configuration file to /home/jdoe/config/ you can specify this command:

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

DCOS_SSL_VERIFY

Indicates whether to verify SSL certificates for HTTPS (true) or set the path to the SSL certificates (false). By default, this is variable is set to true. Setting this environment variable is equivalent to setting the core.ssl_config option in the DC/OS configuration file. For example, to indicate that you want to set the path to SSL certificates:

export DCOS_SSL_VERIFY=false

DCOS_LOG_LEVEL

Prints log messages to stderr at or above the level indicated. This is equivalent to the --log-level command-line option. The severity levels are:

  • debug Prints all messages to stderr, including informational, warning, error, and critical.
  • info Prints informational, warning, error, and critical messages to stderr.
  • warning Prints warning, error, and critical messages to stderr.
  • error Prints error and critical messages to stderr.
  • critical Prints only critical messages to stderr.

For example, to set the log level to warning:

export DCOS_LOG_LEVEL=warning

DCOS_DEBUG

Indicates whether to print additional debug messages to stdout. By default this is set to false. For example:

export DCOS_DEBUG=true

Configuration Files

By default, the DC/OS command line stores its configuration files in a directory called ~/.dcos within your HOME directory. However, you can specify a different location by using the DCOS_CONFIG environment variable.

The configuration settings are stored in the dcos.toml file. You can modify these settings with the dcos config command.

dcos_url The the public master IP of your DC/OS installation. This is set by default during installation. For example:

dcos config set core.dcos_url 52.36.102.191

dcos_acs_token The token generated by authenticating to DC/OS with the Access Control Service (ACS). To set the ACS token, run:

dcos config set core.dcos_acs_token <token>

mesos_master_url The Mesos master URL. This must be of the format: http://<host>:<port>. For example, to set your Mesos master URL:

dcos config set core.mesos_master_url 52.34.160.132:5050

pagination Indicates whether to paginate output. By default this is set to True. For example, to set to false:

dcos config set core.pagination False

reporting Indicates whether to report usage events to Mesosphere. By default this is set to True. For example, to set to false:

dcos config set core.reporting False

ssl_verify Indicates whether to verify SSL certs for HTTPS or path to certs. By default this is set to False. For example, to set to true:

dcos config set core.ssl_verify True

timeout Request timeout in seconds, with a minimum value of 1 second. By default this is set to 5 seconds. For example, to set to 3 seconds:

dcos config set core.timeout 3

Installing

The recommended method to install the DC/OS CLI is by clicking the quick-launch icon on the lower-left panel of the DC/OS web interface. Or, you can manually install the CLI by following these instructions.

    Configuring

    You can access DC/OS CLI configuration with this command:

      Updating

      You can update the DC/OS CLI to the latest version or downgrade to an older version.

        Multiple Clusters

        You can connect the CLI to multiple DC/OS clusters at the same time by using the DCOS_CONFIG environment variable. With this variable you can specify a terminal-specific CLI configurations.

          Uninstalling

          You can uninstall the CLI with these commands for your operating system.

            Reference

            By default, dcos node ssh connects to the private IP of the node, which is only accessible from hosts within the same network, so you must use the --master-proxy option to access your cluster from an outside network. For example, in the default AWS configuration, the private agents are unreachable from the public internet, but you can SSH to them using this option, which will proxy the SSH connection through the publicly reachable master.