DC/OS Documentation

DC/OS Documentation

Welcome to the DC/OS documentation. The DC/OS documentation can help you set up, learn about the system, and get your applications and workloads running on DC/OS.


Overview

The overview topics help you get started and learn the DC/OS fundamentals.

Installing and Upgrading

DC/OS can be installed on any cluster of physical or virtual machines.

GUI

The DC/OS web interface provides a rich graphical view of your DC/OS cluster. With the web interface you can view the current state of your entire cluster and DC/OS services. The web interface is installed as a part of your DC/OS installation.

    CLI

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

    Networking

    DC/OS provides a number of tools out-of-the-box, ranging from basic network connectivity between containers to more advanced features, such as load balancing and service discovery.

    Security

    You can enable authentication in your datacenter with DC/OS oauth. Authentication is managed through the DC/OS web interface. The Admin Router enforces access control.

    Storage

    DC/OS applications lose their state when they terminate and are relaunched. In some contexts, for instance, if your application uses MySQL, or if you are using a stateful service like Kafka or Cassandra, you’ll want your application to preserve its state.

    Metrics

    The metrics component provides metrics from DC/OS cluster hosts, containers running on those hosts, and from applications running on DC/OS that send statsd metrics to the Mesos Metrics Module. The metrics component is natively integrated with DC/OS and is available per-host from the /system/v1/metrics/v0 HTTP API endpoint. No additional setup is required.

    Monitoring, Logging, and Debugging

    Monitoring the health of all the pieces that make up DC/OS is vital to datacenter operators and for troubleshoooting hard-to-diagnose bugs. You can monitor the health of your cluster components from the DC/OS UI component health page. The component health page displays information from the system health API, which monitors the core DC/OS components.

    Deploying Jobs

    You can create scheduled jobs in DC/OS without installing a separate service. Create and administer jobs in the DC/OS web interface, the DC/OS CLI, or via an API.

    Deploying Services and Pods

    DC/OS uses Marathon to manage processes and services. Marathon is the “init system” for DC/OS. Marathon starts and monitors your applications and services, automatically healing failures.

    Tutorials

    This is a collection of tutorials about using DC/OS. Learn how to run services and operate services in production.

    API Reference

    The DC/OS API is a collection of routes backed by DC/OS components that are made available through an API gateway called Admin Router.

    Developing Services

    This section describes the developer-specific DC/OS components, explaining what is necessary to package and provide your own service on DC/OS.

    Support

    DC/OS is a free and open source project and community-supported product.