DC/OS E2E is a tool for spinning up and managing DC/OS clusters in test environments.

See the full documentation on Read the Docs.

DC/OS E2E consists of a library and a CLI.

The CLI works only with the Docker backend, while the library supports multiple backends. The CLI can be installed with Homebrew on macOS, and the library and CLI can be installed together with pip on any Linux and macOS.

Windows is not currently supported, but we provide instructions on using DC/OS E2E on Windows with Vagrant on particular backends' documentation.

To install the CLI on macOS, install Homebrew. To install the CLI on Linux, install Linuxbrew. Or, if you prefer, see "Library and CLI with Python" below for an alternative.

Then install the latest stable version:

brew install https://raw.githubusercontent.com/dcos/dcos-e2e/master/dcosdocker.rb

To upgrade from an older version, run the following command:

brew upgrade https://raw.githubusercontent.com/dcos/dcos-e2e/master/dcosdocker.rb

Run dcos-docker doctor to make sure that your system is ready to go:

$ dcos-docker doctor

If the CLI has been installed with Homebrew or Linuxbrew, you do not need to install the library to use the CLI.

Requires Python 3.5.2+. To avoid interfering with your system's Python, we recommend using a virtualenv.

Check the Python version:

python3 --version

On Fedora, install Python development requirements:

sudo dnf install -y git python3-devel

On Ubuntu, install Python development requirements:

apt install -y gcc python3-dev

Optionally replace master with a particular version of DC/OS E2E. See available versions.

If you are not in a virtualenv, you may have to use sudo before the following command, or --user after install.

pip3 install --upgrade git+https://github.com/dcos/dcos-e2e.git@master

Run dcos-docker doctor to make sure that your system is ready to go for the Docker backend:

$ dcos-docker doctor

Below is a small example of using DC/OS E2E as a Python library with a Docker backend. See the full documentation for more details on these and other features.

from pathlib import Path

from dcos_e2e.backends import Docker
from dcos_e2e.cluster import Cluster

oss_artifact = Path('/tmp/dcos_generate_config.sh')

with Cluster(cluster_backend=Docker()) as cluster:
    cluster.install_dcos_from_path(
        build_artifact=oss_artifact,
        dcos_config={
            **cluster.base_config,
            **{
                'check_time': True,
            },
        },
    )
    (master, ) = cluster.masters
    result = master.run(args=['echo', '1'])
    print(result.stdout)
    cluster.wait_for_dcos_oss()
    cluster.run_integration_tests(pytest_command=['pytest', '-x', 'test_tls.py'])

There is also a CLI tool. This is useful for quickly creating, managing and destroying clusters.

A typical CLI workflow may look like this:

# Fix issues shown by dcos-docker doctor
$ dcos-docker doctor
$ dcos-docker create /tmp/dcos_generate_config.sh --agents 0
default
$ dcos-docker wait
$ dcos-docker run --sync-dir /path/to/dcos/checkout pytest -k test_tls
...
$ dcos-docker destroy

Each of these commands and more described in detail in the full CLI documentation.