magnum

Table of Contents

1. Overview - What is the magnum module?
2. Module Description - What does the module do?
3. Setup - The basics of getting started with magnum
4. Implementation - An under-the-hood peek at what the module is doing
5. Limitations - OS compatibility, etc.
6. Development - Guide for contributing to the module
7. Contributors - Those with commits

Overview

The magnum module is a part of OpenStack, an effort by the Openstack infrastructure team to provide continuous integration testing and code review for Openstack and Openstack community projects not part of the core software. The module its self is used to flexibly configure and manage the container service for Openstack.

Module Description

The magnum module is a thorough attempt to make Puppet capable of managing the entirety of magnum. This includes manifests to provision region specific endpoint and database connections. Types are shipped as part of the magnum module to assist in manipulation of configuration files.

Setup

What the magnum module affects

• Magnum, the container service for Openstack.

Installing magnum

magnum is not currently in Puppet Forge, but is anticipated to be added soon.  Once that happens, you'll be able to install magnum with:
puppet module install openstack/magnum

Beginning with magnum

To utilize the magnum module's functionality you will need to declare multiple resources. The following is a modified excerpt from the openstack module. This is not an exhaustive list of all the components needed, we recommend you consult and understand the openstack module and the core openstack documentation.

Implementation

magnum

magnum is a combination of Puppet manifest and ruby code to delivery configuration and extra functionality through types and providers.

Limitations

• All the magnum types use the CLI tools and so need to be ran on the magnum node.

Beaker-Rspec

This module has beaker-rspec tests

To run the tests on the default vagrant node:

bundle install
bundle exec rake acceptance

For more information on writing and running beaker-rspec tests visit the documentation:

• https://github.com/puppetlabs/beaker/wiki/How-to-Write-a-Beaker-Test-for-a-Module

Development

Developer documentation for the entire puppet-openstack project.

• https://wiki.openstack.org/wiki/Puppet

Contributors

• https://github.com/openstack/puppet-magnum/graphs/contributors