Overview

Mantl is a modern, batteries included platform for rapidly deploying globally distributed services

Table of Contents

Overview

Features

Core Components

Consul for service discovery
Vault for managing secrets
Mesos cluster manager for efficient resource isolation and sharing across distributed services
Marathon for cluster management of long running containerized services
Terraform deployment to multiple cloud providers
Docker container runtime
Traefik for proxying external traffic
mesos-consul populating Consul service discovery with Mesos tasks
Mantl API easily install supported Mesos frameworks on Mantl
Mantl UI a beautiful administrative interface to Mantl

Addons

ELK Stack for log collection and analysis
- Logstash for log forwarding
GlusterFS for container volume storage
etcd distributed key-value store for Calico
Calico a new kind of virtual network
collectd for metrics collection
Chronos a distributed task scheduler
Kong for managing APIs

See the addons/ directory for the most up-to-date information.

Goals

Security
High availability
Rapid immutable deployment (with Terraform + Packer)

Architecture

The base platform contains control nodes that manage the cluster and any number of resource nodes. Containers automatically register themselves into DNS so that other services can locate them.

Control Nodes

The control nodes manage a single datacenter. Each control node runs Consul for service discovery, Mesos leaders for resource scheduling and Mesos frameworks like Marathon.

In general, it's best to provision an odd number (at least 3 or 5) of control nodes to achieve higher availability of services. The Consul Ansible role will automatically bootstrap and join multiple Consul nodes. The Mesos role will provision highly-availabile Mesos and ZooKeeper environments when more than one node is provisioned.

Resource Nodes

Resource nodes launch containers and other Mesos-based workloads.

Edge Nodes

Edge nodes are responsible for proxying external traffic into services running in the cluster.

Getting Started

All development is done on the master branch. Tested, stable versions are identified via git tags. To get started, you can clone or fork this repo:

git clone https://github.com/CiscoCloud/mantl.git

To use a stable version, use git tag to list the stable versions:

git tag
0.1.0
0.2.0
...
1.0.2


git checkout 1.0.2

A Vagrantfile is provided that provisions everything on a few VMs. To run, first ensure that your system has at least 2GB of RAM free, then just:

vagrant up

Note:

There is no support for Windows at this time, however support is planned.
Use the latest version of Vagrant for best results. Version 1.8 is required.
There is no support for the VMware Fusion Vagrant provider; hence your provider is set to Virtualbox in your Vagrantfile.

Software Requirements

The only requirements for running Mantl are working installations of Terraform and Ansible (or Vagrant, if you're deploying to VMs). See the "Development" sections for requirements for developing Mantl.

Deploying on multiple servers

Please refer to the Getting Started Guide, which covers cloud deployments.

Documentation

All documentation is located at http://docs.mantl.io.

To build the documentation locally, run:

sudo pip install -r requirements.txt
cd docs
make html

Roadmap

Mesos Frameworks

Note: The most up-to-date list of Mesos frameworks that are known to work with Mantl is always in the mantl-universe repo.

Security

Manage Linux user accounts
Authentication and authorization for Consul
Authentication and authorization for Mesos
Authentication and authorization for Marathon
Application load balancer (based on Traefik)
Application dynamic firewalls (using consul template)

Operations

Logging (with the ELK stack)
Metrics (with the collectd addon)
In-service upgrade with rollback
Autoscaling of worker nodes
Self maintaining system (log rotation, etc)
Self healing system (automatic failed instance replacement, etc)

Platform Support

Please see milestones for more details on the roadmap.

Development

If you're interested in contributing to the project, install Terraform and the Python modules listed in requirements.txt and follow the Getting Started instructions. To build the docs, enter the docs directory and run make html. The docs will be output to _build/html.

Good issues to start with are marked with the low hanging fruit tag.

Getting Support

If you encounter any issues, please open a Github Issue against the project. We review issues daily.

We also have a gitter chat room. Drop by and ask any questions you might have. We'd be happy to walk you through your first deployment.

Cisco Intercloud Services provides support for OpenStack based deployments of Mantl.

License

Licensed under the Apache License, Version 2.0 (the "License").

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

dbirchak/mantl