openstack/puppet-openstack-cookiecutter
Code Issues Proposed changes
033f4e7c70
puppet-openstack-cookiecutter/puppet-{{cookiecutter.project_name}}
History
Yanis Guenane 033f4e7c70 Update templates to reflect various changes 
Update the cookiecutter templates to reflect various changes :

  * Move to openstack/ scope
  * More up to date metadata.json (operatingsystem_support)
  * Fix white space
  * Fix README naming and links
  * Remove duplicated CHANGELOG

Change-Id: I520d60952f93a226a318465ec79567662274efde
2015-06-30 13:00:24 +02:00
..
lib/puppet drop api_paste_ini support 2015-05-22 13:34:20 -07:00
manifests drop api_paste_ini support 2015-05-22 13:34:20 -07:00
spec Update templates to reflect various changes 2015-06-30 13:00:24 +02:00
tests Initial Commit 2015-05-21 21:13:03 +02:00
.fixtures.yml Update templates to reflect various changes 2015-06-30 13:00:24 +02:00
.gitignore skel: Add a gitignore filr (vendor, pkg and spec files) 2015-05-21 23:22:44 -07:00
.gitreview Update templates to reflect various changes 2015-06-30 13:00:24 +02:00
CHANGELOG.md changelog: Add a changelog example file 2015-06-28 17:07:04 +02:00
LICENSE config: Add a central date place (for License) 2015-05-21 23:21:41 -07:00
metadata.json Update templates to reflect various changes 2015-06-30 13:00:24 +02:00
README.md Update templates to reflect various changes 2015-06-30 13:00:24 +02:00

README.md

{{cookiecutter.project_name}}

Table of Contents

  1. Overview - What is the {{cookiecutter.project_name}} module?
  2. Module Description - What does the module do?
  3. Setup - The basics of getting started with {{cookiecutter.project_name}}
  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 {{cookiecutter.project_name}} 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 FIXME service for Openstack.

Module Description

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

Setup

What the {{cookiecutter.project_name}} module affects

  • {{cookiecutter.project_name}}, the FIXME service for Openstack.

Installing {{cookiecutter.project_name}}

example% puppet module install puppetlabs/{{cookiecutter.project_name}}

Beginning with {{cookiecutter.project_name}}

To utilize the {{cookiecutter.project_name}} 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.

Define a {{cookiecutter.project_name}} node

class { '{{cookiecutter.project_name}}':
  verbose             => true,
  database_connection => 'mysql://{{cookiecutter.project_name}}_admin:super_secret_db_password@openstack-controller.example.com/{{cookiecutter.project_name}}',
}

Implementation

{{cookiecutter.project_name}}

{{cookiecutter.project_name}} is a combination of Puppet manifest and ruby code to delivery configuration and extra functionality through types and providers.

Limitations

  • All the {{cookiecutter.project_name}} types use the CLI tools and so need to be ran on the {{cookiecutter.project_name}} 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.

Contributors