28cd52bbb7
Developers run all sorts of different tools within Git repositories, any of which can leave their own special trashfiles all over the place. We can't every hope to catalog them all, so better to recommend developers simply configure a global core.excludesfile to filter the irrelevant files which tend to get created by their personal choice of tools. Add a comment block explaining this, for clarity, and remove the one current editor-specific entry present. We can, and should of course, continue to list files created by the tools recommended by our workflow (test frameworks, documentation and packaging builds, et cetera). This change is a port of Ib58a57267b064e4142686de6c37a70dbff04b9a7 from the openstack-dev/cookiecutter repository. Change-Id: If81507e45cf54c7d77b82deb517d50a936a80d33
Team and repository tags
magnum
Table of Contents
- Overview - What is the magnum module?
- Module Description - What does the module do?
- Setup - The basics of getting started with magnum
- Implementation - An under-the-hood peek at what the module is doing
- Limitations - OS compatibility, etc.
- Development - Guide for contributing to the module
- Contributors - Those with commits
- Release Notes - Release notes for the project
- Repository - The project source code repository
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 itself 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. This is not an exhaustive list of all the components needed, we recommend you consult and understand 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 run 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:
Development
Developer documentation for the entire puppet-openstack project.