Mantl is a modern, batteries included platform for rapidly deploying globally distributed services
Table of Contents
- Getting Started
- Getting Support
- 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
- Kubernetes for managing, organizing, and scheduling containers
- 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
- ELK Stack for log
collection and analysis
- Logstash for log forwarding
- GlusterFS for container volume storage
- Docker Swarm for clustering Docker daemons between networked hosts
- 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
addons/ directory for the most up-to-date information.
- High availability
- Rapid immutable deployment (with Terraform + Packer)
The base platform contains control nodes that manage the cluster and any number of agent nodes. Containers automatically register themselves into DNS so that other services can locate them.
The control nodes manage a single datacenter. Each control node runs Consul for service discovery, Mesos and Kubernetes leaders for resource scheduling and Mesos frameworks like Marathon.
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.
Agent nodes launch containers and other Mesos- or Kubernetes-based workloads.
Edge nodes are responsible for proxying external traffic into services running in the cluster.
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/mantl/mantl.git
To use a stable version, use
git tag to list the stable versions:
git tag 0.1.0 0.2.0 ... 1.2.0 git checkout 1.2.0
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:
- 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.
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.
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
Note: The most up-to-date list of Mesos frameworks that are known to work with Mantl is always in the mantl-universe repo.
- 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)
- 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)
- Amazon Web Services
- Cisco Cloud Services
- Cisco MetaCloud
- Joyent Triton
- Google Compute Engine
- Vagrant (Linux/OSX + VirtualBox)
- Apache CloudStack
- Cisco Unified Computing System
- Microsoft Azure
- Vagrant (Windows + VirtualBox)
Community Supported Platforms
Please see milestones for more details on the roadmap.
If you're interested in contributing to the project, install
Terraform and the Python modules
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
Good issues to start with are marked with the low hanging fruit tag.
To keep your fork up to date.
1. Clone your fork:
git clone email@example.com:YOUR-USERNAME/mantl.git
2. Add remote from original repository in your forked repository:
cd into/cloned/fork-repo git remote add upstream git://github.com/mantl/mantl.git git fetch upstream
3. Updating your fork from original repo to keep up with their changes:
git pull upstream master
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.
Copyright © 2015 Cisco Systems, Inc.
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.