Getting Started

• Install Marathon
• Setup Recommendations
• High Availability Mode

Using Marathon

• Application Basics
• Application Deployments
• Application Groups
• Authorization and Access Control
• Blue-Green Deployment
• Constraints
• Event Bus
• Health Checks
• Marathon Web Interface
• Networking
• Pods
• Recipes
• Provisioning Containers
• Stateful Applications Using Local Persistent Volumes
• Stateful Applications Using External Persistent Volumes
• Task Environment Variables
• Task Handling
• Task Handling Configuration
• Secret Configuration
• Unreachable Strategy

Administration

• Command Line Flags
• Backup and Restore
• Data Migration
• Framework Authentication
• High Availability
• Metrics
• Deprecated Metrics
• Readiness Checks
• Checks
• Service Discovery and Load Balancing
• SSL and Basic Authentication
• Using a Private Docker Registry
• Maintenance mode
• Compatibility with Mesos

Upgrading

• Upgrading to a new Version
• Migrating Apps to the 1.5 Networking API
• Migrating Tools to the 1.5 Networking API
• Versioning

Troubleshooting

• Stuck App or Pod Deployments
• No new instances are starting
• An App Requires a Specific Host Port
• Error Using HTTPS with local CA Certificate
• Error Reading Authentication Secret
• Slow Docker apps and deployments
• Exit Codes

Development

• Contributor Guidelines
• Current Marathon Development
• Extend Marathon with Plugins
• Run a Local Version of Marathon

API Reference

• REST API Reference

Docs for Previous Versions

• Version 1.9.x
• Version 1.8.x
• Version 1.7.x

Install Marathon

Requirements

• Apache Mesos 1.0.1+
• Apache ZooKeeper
• JDK 1.8+
• Default JVM set to Java 8

Installation

Install Mesos

Marathon runs atop Apache Mesos. You can install Mesos via your system’s package manager. Current builds and instructions on how to set up repositories for major Linux distributions are available on the Mesosphere downloads page.

If you want to build Mesos from source, see the Mesos Getting Started page or the Mesosphere tutorial for details. Running make install will install Mesos in /usr/local.

Install Marathon

Through your Package Manager

Please see the documentation on Marathon native package repositories.

From a Tarball

Download and unpack the latest Marathon release.

$ curl -O http://downloads.mesosphere.com/marathon/v1.5.1/marathon-1.5.1.tgz
$ tar xzf marathon-1.5.1.tgz

SHA-256 checksums are available by appending .sha256 to the URLs.

Upgrading to a Newer Version

See the Marathon upgrade guide to learn how to upgrade to a new version.

Running in High Availability Mode

Both ZooKeeper and Mesos need to be running in order to launch Marathon in high availability mode.

Point your web browser to localhost:8080 and you should see the Marathon UI.

$ ./bin/marathon --master zk://zk1.foo.bar:2181,zk2.foo.bar:2181/mesos --zk zk://zk1.foo.bar:2181,zk2.foo.bar:2181/marathon

Marathon uses --master to find the Mesos masters, and --zk to find ZooKeepers for storing state. They are separate options because Mesos masters can also be discovered in other ways.

For all configuration options, see the command line flags doc. For more information on the high-availability feature of Marathon, see the high availability doc.

Mesos Library

MESOS_NATIVE_JAVA_LIBRARY: bin/marathon searches the common installation paths, /usr/lib and /usr/local/lib, for the Mesos native library. If the library lives elsewhere in your configuration, set the environment variable MESOS_NATIVE_JAVA_LIBRARY to its full path.

For example:

$ MESOS_NATIVE_JAVA_LIBRARY=/Users/bob/libmesos.dylib ./bin/start --master local --zk zk://localhost:2181/marathon

Launch an Application

For an introduction to Marathon application definitions and how they are executed, see Application Basics.