Components

Understanding DC/OS components

DC/OS is composed of many open source microservice components meticulously tuned and configured to work together. Mesosphere DC/OS Enterprise includes most of the open source DC/OS components but also includes several additional components, modules, and plugins.

Mesosphere DC/OS Enterprise Components

Figure 1 - DC/OS components

From the top, DC/OS is an inclusive container platform that handles container orchestration, package management, and security. From the bottom, DC/OS is an operating system built on top of Apache Mesos that handles cluster management and software defined networking, while simplifying logging and metrics collection.

Cluster management

DC/OS provides a way to view and operate a large number of individual machine-level systems as a single cluster-level system. It hides the complexity of Mesos, the distributed systems kernel, with higher level abstractions, interfaces, and tools. Cluster management is the core of that functionality, including the kernel, its dependencies, and its user interfaces.

Apache Mesos

Mesos manages resources and tasks as a distributed systems kernel. Mesos Master exposes scheduler, executor, and operator interfaces to facilitate cluster management. Mesos Agent manages individual executors, tasks, and resources on each DC/OS agent node. Mesos Agent Public is a Mesos Agent configured to run on DC/OS public agent nodes.

System services

  • dcos-mesos-master.service
  • dcos-mesos-slave.service
  • dcos-mesos-slave-public.service

Read the following documentation resources to learn more about Apache Mesos:

Apache ZooKeeper

ZooKeeper provides consistent, highly available, distributed key-value storage for configuration, synchronization, name registration, and cluster state storage.

System services

N/A - ZooKeeper is supervised by Exhibitor.

Read the following documentation resources to learn more about Apache ZooKeeper:

Exhibitor

Exhibitor supervises ZooKeeper and provides a management web interface.

System service

  • dcos-exhibitor.service

Read the following documentation resources to learn more about Exhibitor:

DC/OS Installer

The DC/OS Installer (dcos_generate_config.ee.sh) generates install artifacts and installs DC/OS. As part of the install process on each node, the DC/OS Download service downloads the install artifacts from the bootstrap machine and the DC/OS Setup service installs components using the DC/OS Component Package Manager (Pkgpanda).

System services

  • dcos-download.service
  • dcos-setup.service

Read the following documentation resources to learn more about DC/OS and installation methods:

DC/OS backup Enterprise

DC/OS Backup provides backup and restore of DC/OS component state (Marathon-only in 1.10).

System services

  • dcos-backup-master.service
  • dcos-backup-master.socket

Read the following documentation resources to learn more about backing up and restoring your cluster:

DC/OS GUI

The DC/OS GUI (web interface) is a browser-based system dashboard and control center.

System service

N/A - The GUI is served by Admin Router.

Read the following documentation resources to learn more about DC/OS GUI:

DC/OS CLI

The DC/OS CLI is a terminal-based remote client.

System service

N/A - The CLI is a user downloadable binary.

Read the following documentation resources to learn more about DC/OS CLI:

Container orchestration

Container orchestration is the continuous, automated scheduling, coordination, and management of containerized processes and the resources they consume. DC/OS includes built-in orchestration of the most commonly used high level container-based abstractions: jobs and services. Many use cases are handled directly by these basic abstractions, but they also enable the deployment of custom schedulers for tasks that require more flexible programmatic lifecycle management automation.

Marathon

Marathon orchestrates long-lived containerized services (apps and pods).

System service

  • dcos-marathon.service

Read the following documentation resources to learn more about DC/OS Marathon:

DC/OS jobs (Metronome)

DC/OS jobs (Metronome) orchestrates short-lived, scheduled or immediate, containerized jobs.

System service

  • dcos-metronome.service

Read the following documentation resources to learn more about DC/OS Metronome:

Container runtimes

Container runtimes execute and manage machine level processes in isolated operating system level environments. DC/OS supports multiple container runtimes using Mesos’ containerizer abstraction.

Universal Container Runtime

Universal Container Runtime (Mesos Containerizer) is a logical component built into the Mesos Agent, not technically a separate process. It containerizes Mesos tasks with configurable isolators. Universal Container Runtime supports multiple image formats, including Docker images without using Docker Engine.

System service

N/A - Universal Container Runtime is part of Mesos Agent.

Read the following documentation resource to learn more about Universal Container Runtime:

Docker Engine

Docker Engine is not installed by the DC/OS Installer, but rather is a system dependency that runs on each node. The Mesos Agent also includes a separate logical component called Docker Containerizer which delegates the containerization of Mesos task to Docker Engine.

System service

  • docker.service - Docker Engine is not installed by the DC/OS Installer.

Read the following documentation resource to learn more about Docker Engine:

Docker GC

Docker GC periodically collects Docker “garbage” containers and images.

System services

  • dcos-docker-gc.service
  • dcos-docker-gc.timer

Read the following documentation resource to learn more about Docker GC:

Logging and metrics

No software runs perfectly, especially not the first time. Distributing tasks across a cluster, as well as the normal patterns of analyzing and debugging these services, become tedious. DC/OS includes several components to help ease the pain of debugging distributed systems by aggregating, caching, and streaming logs, metrics, and cluster state metadata.

DC/OS network metrics Enterprise

DC/OS network metrics exposes networking-related metrics. DC/OS network metrics are also known as the DC/OS Networking API.

System service

  • dcos-networking_api.service

DC/OS diagnostics

DC/OS diagnostics aggregate and expose component health. DC/OS diagnostics are also known as DC/OS Distributed Diagnostics Tool.

System services

  • dcos-diagnostics.service
  • dcos-diagnostics.socket

Read the following documentation resources to learn more about DC/OS Diagnostics:

DC/OS log

The DC/OS log service exposes node, component, and container (task) logs.

System services

  • dcos-log-master.service
  • dcos-log-master.socket
  • dcos-log-agent.service
  • dcos-log-agent.socket

Read the following documentation resources to learn more about DC/OS Logs:

Logrotate

Logrotate manages rotation, compression, and deletion of historical log files.

System services

  • dcos-logrotate-master.service
  • dcos-logrotate-master.timer
  • dcos-logrotate-agent.service
  • dcos-logrotate-agent.timer

Read the following documentation resources to learn more about DC/OS Logrotate:

Telegraf

Telegraf is a configurable metrics pipeline. By default, it collects system, container, and application metrics.

System services

  • dcos-telegraf.service
  • dcos-telegraf.socket

Read the following documentation resources to learn more about DC/OS Telegraf:

DC/OS signal

The DC/OS signal service reports cluster telemetry and analytics to help improve DC/OS. Administrators can opt out of telemetry at installation time.

System services

  • dcos-signal.service
  • dcos-signal.timer

Read the following documentation resources to learn more about DC/OS Signal:

DC/OS history

The DC/OS history service caches and exposes the historical system state to facilitate cluster usage statistics in the GUI.

Deprecated

This service is deprecated and will be removed in a future version.

System service

  • dcos-history.service

Read the following documentation resources to learn more about DC/OS History:

Networking

In a world where machines are given numbers instead of names, tasks are scheduled automatically, dependencies are declaratively defined, and services run in distributed sets, network administration also needs to be elevated from plugging in cables to configuring software-defined networks. To accomplish this, DC/OS includes a fleet of networking components for routing, proxying, name resolution, virtual IPs, load balancing, and distributed reconfiguration.

Admin Router

Admin Router exposes a unified control plane proxy for components and services using NGINX. Admin Router Agent provides proxies for node-specific health, logs, metrics, and package management internal endpoints.

System services

  • dcos-adminrouter.service
  • dcos-adminrouter-agent.service

Read the following documentation resource to learn more about DC/OS Admin Router:

Mesos DNS

Mesos DNS provides domain name based service discovery within the cluster.

System service

  • dcos-mesos-dns.service

Read the following documentation resources to learn more about Mesos DNS:

DC/OS Net

dcos-net is an Erlang VM that hosts the following networking applications:

  • dcos-dns: A distributed DNS-based service discovery.
  • dcos-overlay: An SDN solution for UCR and Docker containers.
  • dcos-l4lb: A distributed layer-4 load-balancer.

System services

  • dcos-net.service
  • dcos-net-watchdog.service

Read the following documentation resource to learn more about DC/OS Net:

Generate resolv.conf

Generate resolv.conf configures network name resolution by updating /etc/resolv.conf to facilitate DC/OS’s software defined networking.

System services

  • dcos-gen-resolvconf.service
  • dcos-gen-resolvconf.timer

Read the following documentation resource to learn more about Generate resolv.conf:

Package management

Just as machine operating systems need package management to install, upgrade, configure, and remove individual applications and services, a datacenter operating system needs package management to do the same for distributed services. In DC/OS there are two levels of package management: machine-level for components; and cluster-level for user services.

DC/OS package manager (Cosmos)

The DC/OS package manager (Cosmos) installs and manages DC/OS packages from DC/OS package repositories, such as the Mesosphere Catalog.

System service

  • dcos-cosmos.service

Read the following documentation resources to learn more about DC/OS Package Manager (Cosmos):

DC/OS Component Package Manager (Pkgpanda)

DC/OS Component Package Manager (Pkgpanda) installs and manages DC/OS components.

System Service

  • dcos-pkgpanda-api.service
  • dcos-pkgpanda-api.socket

Read the following documentation resources to learn more about DC/OS Component Package Manager (Pkgpanda):

IAM and Security Enterprise

Identity and access management in DC/OS Enterprise is governed by an internal database of users, user groups, and permissions. External identity providers can also be attached to take advantage of existing databases. Permissions are enforced both at the edge by Admin Router’s reverse proxy and also at the component level for controlling access to specific actions. Secrets, like SSL certificates, can also be securely generated, managed, stored, and injected into user services.

DC/OS Identity and Access Manager (Bouncer)

DC/OS Identity and Access Manager (IAM) controls access to DC/OS components and services by managing users, user groups, service accounts, permissions, and identity providers. In addition to managing a local user database, DC/OS IAM can delegate to external identity providers using LDAP, SAML, or Open ID Connect. For fine grained access control, other DC/OS components, like Mesos and Marathon, integrate with DC/OS IAM directly. DC/OS IAM is also known as Bouncer.

System service

  • dcos-bouncer.service

Read the following documentation resources to learn more about DC/OS Identity and Access Manager (Bouncer):

CockroachDB

CockroachDB is a distributed SQL database built on a transactional and strongly consistent key-value store.

NOTE: CockroachDB is currently only used by DC/OS Identity and Access Manager.

System service

  • dcos-cockroach.service

Read the following documentation resources to learn more about CockroachDB:

DC/OS Certificate Authority

DC/OS Certificate Authority (CA) issues signed digital certificates for secure communication. DC/OS CA is based on Cloudflare’s Cfssl.

System service

  • dcos-ca.service

Read the following documentation resources to learn more about DC/OS Certificate Authority:

DC/OS secrets

DC/OS secrets provide a secure API for storing and retrieving secrets from Vault, a secret store.

System service

  • dcos-secrets.service

Read the following documentation resources to learn more about DC/OS Secrets:

Vault

Vault is a tool for securely managing secrets. A secret is anything that you want to control access to, such as API keys, passwords, certificates, and more. Vault provides a unified interface to any secret, while providing tight access control and recording a detailed audit log.

System service

  • dcos-vault.service

Read the following documentation resources to learn more about Vault:

Storage

DC/OS provides many different ways to provision and allocate disk space and volumes to tasks. One of those methods, external persistent volumes, is managed by its own component.

REX-Ray

REX-Ray orchestrates provisioning, attachment, and mounting of external persistent volumes.

System service

  • dcos-rexray.service

Read the following documentation resources to learn more about REX-Ray:

Sockets and timers

Several components are configured to use on-demand systemd sockets which allows them to be started when a request comes in, rather than running continuously and consuming resources unnecessarily. While these sockets are separate systemd units they are not considered separate components.

Several components are configured to use systemd timers which allows them to be periodically executed or restarted. Periodic execution avoids continuous execution and consuming resources unnecessarily. Periodic restarting allows for picking up new configurations from downstream dependencies, like time-based DNS cache expiration. While these timers are separate systemd units they are not considered separate components.

Component installation

DC/OS components are installed, upgraded, and managed by DC/OS Component Package Manager (Pkgpanda), a package manager for systemd units.

To see the full list of packages managed by the DC/OS installer, see the packages directory of the DC/OS source repository.

Systemd services

Most DC/OS components run as systemd services on the DC/OS nodes.

To see a list of the systemd components running on any particular node, list the contents of the /etc/systemd/system/dcos.target.wants/ directory or execute systemctl | grep dcos- to see their current status.

Master node

ls /etc/systemd/system/dcos.target.wants/ -1
dcos-adminrouter.service
dcos-backup-master.service
dcos-backup-master.socket
dcos-bouncer.service
dcos-ca.service
dcos-checks-api.service
dcos-checks-api.socket
dcos-checks-poststart.service
dcos-checks-poststart.timer
dcos-cluster-linker.service
dcos-cluster-linker.socket
dcos-cockroachdb-config-change.service
dcos-cockroachdb-config-change.timer
dcos-cockroach.service
dcos-cosmos.service
dcos-diagnostics-mesos-state.service
dcos-diagnostics-mesos-state.timer
dcos-diagnostics.service
dcos-diagnostics.socket
dcos-exhibitor.service
dcos-fluent-bit.service
dcos-gen-resolvconf.service
dcos-gen-resolvconf.timer
dcos-history.service
dcos-iam-ldap-sync.service
dcos-iam-ldap-sync.timer
dcos-licensing.service
dcos-licensing.socket
dcos-log-master.service
dcos-log-master.socket
dcos-logrotate-master.service
dcos-logrotate-master.timer
dcos-marathon.service
dcos-mesos-dns.service
dcos-mesos-master.service
dcos-metronome.service
dcos-net.service
dcos-net-watchdog.service
dcos-pkgpanda-api.service
dcos-registry.service
dcos-secrets.service
dcos-secrets.socket
dcos-signal.service
dcos-signal.timer
dcos-telegraf.service
dcos-telegraf.socket
dcos-ui-update-service.service
dcos-ui-update-service.socket
dcos-vault.service

Private agent node

ls /etc/systemd/system/dcos.target.wants/ -1
dcos-adminrouter-agent.service
dcos-checks-api.service
dcos-checks-api.socket
dcos-checks-poststart.service
dcos-checks-poststart.timer
dcos-diagnostics.service
dcos-diagnostics.socket
dcos-docker-gc.service
dcos-docker-gc.timer
dcos-fluent-bit.service
dcos-gen-resolvconf.service
dcos-gen-resolvconf.timer
dcos-log-agent.service
dcos-log-agent.socket
dcos-logrotate-agent.service
dcos-logrotate-agent.timer
dcos-mesos-slave.service
dcos-net.service
dcos-net-watchdog.service
dcos-pkgpanda-api.service
dcos-rexray.service
dcos-telegraf.service
dcos-telegraf.socket

Public agent node

ls /etc/systemd/system/dcos.target.wants/ -1
dcos-adminrouter-agent.service
dcos-checks-api.service
dcos-checks-api.socket
dcos-checks-poststart.service
dcos-checks-poststart.timer
dcos-diagnostics.service
dcos-diagnostics.socket
dcos-docker-gc.service
dcos-docker-gc.timer
dcos-fluent-bit.service
dcos-gen-resolvconf.service
dcos-gen-resolvconf.timer
dcos-log-agent.service
dcos-log-agent.socket
dcos-logrotate-agent.service
dcos-logrotate-agent.timer
dcos-mesos-slave-public.service
dcos-net.service
dcos-net-watchdog.service
dcos-pkgpanda-api.service
dcos-rexray.service
dcos-telegraf.service
dcos-telegraf.socket