openstack/magnum
Code Issues Proposed changes
974399a912
magnum/doc/source/index.rst
sayalilunkad 16ce059e3e Adding glossary.rst 
This patch attemps to take some of the content from the guides and make a
glossary which can then be referenced where needed.

Change-Id: Ifb360401556fb0aacd4136e7a08ee1440b7c9d62
Partially-Implements: blueprint docs-refactor
2018-04-10 11:31:27 +02:00

2.9 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:

  • Cluster: A collection of node objects where work is scheduled
  • ClusterTemplate: An object stores template information about the cluster which is used to create new clusters consistently

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.

Features

  • Abstractions for Clusters
  • 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

User Documentation

user/index user/glossary.rst

Contributor Guide

contributor/index

Admin Guide

admin/index

Installation Guide

install/index

Sample Configurations and Policies

configuration/index

Work In Progress

admin/troubleshooting-guide.rst user/index.rst admin/configuring.rst