openstack/magnum
Code Issues Proposed changes
828aff671d
magnum/doc/source/index.rst
Spyros Trigazis 7c239bfbb1 [install] Add install guide from source 
The installation is done from source in a virtualenv for
a system user. master branch was used.

* Tested on: Ubuntu 14.04, Ubuntu 16.04, Centos 7,
  openSUSE Leap 42.1 and Debian 8
* Add init scripts for Ubuntu 14.04
* Add systemd units for Ubuntu 14.10 or higher,
  RHEL/Fedora/Centos and openSUSE Leap 42.1
* Add: verify that magnum services are running
* Add: links to dependency install guides
* Add: setup log rotation

Change-Id: I0b8a25916734a208b80456c253339974d9423ad6
Partially-Implements: blueprint magnum-installation-guide
2016-06-03 16:47:55 +00:00

3.6 KiB
Raw Blame History

Welcome to Magnum's Developer Documentation!

Magnum is an OpenStack project which offers container orchestration engines for deploying and managing containers as first class resources in OpenStack.

Architecture

There are several different types of objects in the magnum system:

  • Bay: A collection of node objects where work is scheduled
  • BayModel: An object stores template information about the bay which is used to create new bays consistently
  • Pod: A collection of containers running on one physical or virtual machine
  • Service: An abstraction which defines a logical set of pods and a policy by which to access them
  • ReplicationController: An abstraction for managing a group of pods to ensure a specified number of resources are running
  • Container: A Docker container

Two binaries work together to compose the magnum system. The first binary (accessed by the python-magnumclient code) is the magnum-api REST server. The REST server may run as one process or multiple processes. When a REST request is sent to the client API, the request is sent via AMQP to the magnum-conductor process. The REST server is horizontally scalable. At this time, the conductor is limited to one process, but we intend to add horizontal scalability to the conductor as well.

The magnum-conductor process runs on a controller machine and connects to a Kubernetes or Docker REST API endpoint. The Kubernetes and Docker REST API endpoints are managed by the bay object.

When service or pod objects are created, Kubernetes may be directly contacted via the Kubernetes REST API. When container objects are acted upon, the Docker REST API may be directly contacted.

Features

  • Abstractions for bays, containers, nodes, pods, replication controllers, and services
  • Integration with Kubernetes, Swarm, Mesos for backend container technology
  • Integration with Keystone for multi-tenant security
  • Integration with Neutron for Kubernetes multi-tenancy network security
  • Integration with Cinder to provide volume service for containers

Developer Info

dev/quickstart dev/manual-devstack dev/bay-template-example.rst dev/kubernetes-load-balancer.rst dev/tls.rst dev/mesos.rst dev/functional-test.rst dev/reno.rst magnum-proxy.rst contributing heat-templates objects gmr.rst

Work In Progress

troubleshooting-guide.rst userguide.rst configuring.rst install-guide-from-source.rst