3.0 KiB
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.
- Free software: under the Apache license
- Source: https://opendev.org/openstack/magnum
- Blueprints: https://blueprints.launchpad.net/magnum
- Bugs: https://bugs.launchpad.net/magnum
- REST Client: https://opendev.org/openstack/python-magnumclient
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
CLI Guide
cli/index
Sample Configurations and Policies
configuration/index
Work In Progress
admin/troubleshooting-guide.rst user/index.rst admin/configuring.rst