ciscocloud/mantl repository overview

⁠Microservices-Infrastructure is now MANTL.

See http://mantl.io⁠ for more details.

Existing Developer? For information on how the rename affects you, see our handy FAQ⁠

⁠Overview

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

Table of Contents

• Overview⁠
  • Features⁠
    • Architecture⁠
    • Control Nodes⁠
    • Resource Nodes⁠
  • Getting Started⁠
    • Software Requirements⁠
    • Deploying on multiple servers⁠
  • Documentation⁠
  • Roadmap⁠
    • Core Components and Features⁠
    • Mesos Frameworks⁠
    • Security⁠
    • Operations⁠
    • Platform Support⁠
  • Development⁠
  • License⁠

⁠Features

• Terraform⁠ deployment to multiple cloud providers
• etcd⁠ distributed key-value store for Calico
• Calico⁠ a new kind of virtual network
• Mesos⁠ cluster manager for efficient resource isolation and sharing across distributed services
• Marathon⁠ for cluster management of long running containerized services
• Consul⁠ for service discovery
• Vault⁠ for managing secrets
• Docker⁠ container runtime
• collectd⁠ for metrics collection
• Logstash⁠ for log forwarding
• mesos-consul⁠ populating Consul service discovery with Mesos tasks
• marathon-consul⁠ update consul k/v with Marathon tasks
• GlusterFS⁠ for container volume storage
• Traefik⁠ for proxying external traffic
• Mantl API⁠ easily install supported Mesos frameworks on Mantl
• Mantl UI⁠ a beautiful administrative interface to Mantl
• Multi-datacenter support
• High availability
• Security

⁠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.

Once WAN joining is configured, each cluster can locate services in other data centers via DNS or the Consul API⁠.

⁠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 3 or 5 control nodes to achieve higher availability of services. The Consul Ansible role will automatically bootstrap and join multiple Consul nodes. The Mesos Ansible 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.

    git clone https://github.com/CiscoCloud/microservices-infrastructure.git

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

git tag
0.1.0
0.2.0
...
0.5.0

git checkout 0.5.0

A Vagrantfile is provided that provisions everything on a single VM. To run, first ensure that your system has 4GB of RAM free, then:

sudo pip install -r requirements.txt
./security-setup
vagrant up

Note:

• There is no support for Windows at this time, however support is planned.
• Vagrant 1.7.3+ is required for best results.
• There is no support for the VMware Fusion Vagrant provider; hence your provider is set to Virtualbox in your Vagrantfile. In order to start running just issue the vagrant up command.

⁠Software Requirements

Requirements for running the project are listed in requirements.txt. Of note: Ansible 1.9 or later is required; also Python 2.7 is required. All the software requirements are currently distributed as Python modules, and you can pip install -r requirements.txt to get them all at once.

⁠Deploying on multiple servers

Please refer to the Getting Started Guide⁠, which covers multi-server and OpenStack deployments.

⁠Documentation

All documentation is located at https://microservices-infrastructure.readthedocs.org⁠.

To build the documentation locally, run:

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

⁠Roadmap

⁠Core Components and Features

• Calico
• Mesos
• Consul
• Multi-datacenter
• High availability
• Rapid immutable deployment (with Terraform + Packer)

⁠Mesos Frameworks

• Marathon
• Kubernetes
• Kafka
• Riak
• Cassandra
• Elasticsearch
• HDFS
• Spark
• Storm
• Chronos
• MemSQL

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
• Metrics
• In-service upgrade with rollback
• Autoscaling of Resource Nodes
• Self maintaining system (log rotation, etc)
• Self healing system (automatic failed instance replacement, etc)

⁠Platform Support

• Vagrant (Mac OSX + VirtualBox)
• Vagrant (Windows + VirtualBox)
• OpenStack
• Cisco Cloud Services
• Cisco MetaCloud
• Cisco Unified Computing System
• Amazon Web Services
• Microsoft Azure
• Google Compute Engine
• VMware vSphere
• Apache CloudStack
• Digital Ocean

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

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.