openstack/puppet-openstack-cookiecutter
Code Issues Proposed changes
15cf931d7e
puppet-openstack-cookiecutter/puppet-{{cookiecutter.project_name}}
History
ZhongShengping eff79a8629 Add Beaker-Rspec to the table of contents 
Change-Id: I23bba54ec05808d6feca5c8764333a9cd1992f7d
2019-04-17 09:42:45 +08:00
..
doc Follow the new PTI for document build 2018-02-28 17:01:03 +08:00
examples Fix module structure 2018-12-12 11:21:51 +01:00
lib/puppet Updates on config provider 2015-10-01 09:23:26 -04:00
manifests Merge "Use validate_legacy" 2019-02-25 17:32:01 +00:00
releasenotes/source Title overline too short. 2019-01-15 23:19:10 +00:00
spec Remove redundantly tested code 2019-01-18 10:50:18 +01:00
.gitignore Dissuade .gitignore references to personal tools 2018-10-05 18:27:10 +00:00
.gitreview Update templates to reflect various changes 2015-06-30 13:00:24 +02:00
bindep.txt Add bindep support 2017-03-13 12:38:14 -04:00
LICENSE Update LICENSE 2018-04-06 20:20:32 +08:00
metadata.json Use puppet 4 compatible mysql functions 2019-02-08 12:02:06 +01:00
README.md Add Beaker-Rspec to the table of contents 2019-04-17 09:42:45 +08:00
setup.cfg Update contact address to openstack-discuss ML 2018-11-30 19:15:37 +00:00
setup.py Add basic structure for ReNo 2016-10-06 13:45:00 -06:00
tox.ini update min tox version to 2.0 2018-10-16 11:42:05 +08:00

README.md

Team and repository tags

Team and repository tags

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. Beaker-Rspec - Beaker-rspec tests for the project
  7. Development - Guide for contributing to the module
  8. 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

Installing {{cookiecutter.project_name}}

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

Beginning with {{cookiecutter.project_name}}

To utilize the {{cookiecutter.project_name}} module's functionality you will need to declare multiple resources.

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