puppet-nova/README.md
Flavio Percoco 1a13220c06 Show team and repo badges on README
This patch adds the team's and repository's badges to the README file.
The motivation behind this is to communicate the project status and
features at first glance.

For more information about this effort, please read this email thread:

http://lists.openstack.org/pipermail/openstack-dev/2016-October/105562.html

To see an example of how this would look like check:

https://gist.github.com/24ea4c4972e293d584f2516466374da4

Change-Id: Ia1a92a9892cbb68f2adb5bad23b212ef2f329bb6
2016-11-25 17:21:31 +01:00

4.1 KiB

Team and repository tags

Team and repository tags

nova

Table of Contents

  1. Overview - What is the nova module?
  2. Module Description - What does the module do?
  3. Setup - The basics of getting started with nova
  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 nova 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 as part of the core software. The module its self is used to flexibly configure and manage the compute service for OpenStack.

Module Description

The nova module is a thorough attempt to make Puppet capable of managing the entirety of nova. This includes manifests to provision such things as keystone endpoints, RPC configurations specific to nova, and database connections. Types are shipped as part of the nova module to assist in manipulation of configuration files.

This module is tested in combination with other modules needed to build and leverage an entire OpenStack software stack.

Setup

What the nova module affects:

  • Nova, the compute service for OpenStack.

Installing nova

puppet module install openstack/nova

Beginning with nova

To utilize the nova 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.

class { 'nova':
  database_connection => 'mysql://nova:a_big_secret@127.0.0.1/nova?charset=utf8',
  rabbit_userid       => 'nova',
  rabbit_password     => 'an_even_bigger_secret',
  image_service       => 'nova.image.glance.GlanceImageService',
  glance_api_servers  => 'localhost:9292',
  rabbit_host         => '127.0.0.1',
}

class { 'nova::compute':
  enabled                       => true,
  vnc_enabled                   => true,
}

class { 'nova::compute::libvirt':
  migration_support => true,
}

Implementation

nova

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

Types

nova_config

The nova_config provider is a children of the ini_setting provider. It allows one to write an entry in the /etc/nova/nova.conf file.

nova_config { 'DEFAULT/image_service' :
  value => nova.image.glance.GlanceImageService,
}

This will write image_service=nova.image.glance.GlanceImageService in the [DEFAULT] section.

name

Section/setting name to manage from nova.conf

value

The value of the setting to be defined.

secret

Whether to hide the value from Puppet logs. Defaults to false.

ensure_absent_val

If value is equal to ensure_absent_val then the resource will behave as if ensure => absent was specified. Defaults to <SERVICE DEFAULT>

Limitations

  • Supports libvirt, xenserver and vmware compute drivers.
  • Tested on EL and Debian derivatives.

Development

Developer documentation for the entire puppet-openstack project.

Beaker-Rspec

This module has beaker-rspec tests

To run the tests on the default vagrant node:

bundle install
bundle exec rspec spec/acceptance

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

Contributors