openstack
/
puppet-openstack-cookiecutter
Code Issues Proposed changes
puppet-openstack-cookiecutter/puppet-{{cookiecutter.proje...
History
Zuul 8a12fd99de Merge "Drop Fedora support" 2021-08-18 11:51:34 +00:00
..
doc Update sphinx to the latest version 2021-03-27 15:31:57 +08:00
examples Convert all class usage to relative names 2019-12-08 23:15:47 +01:00
lib/puppet Updates on config provider 2015-10-01 09:23:26 -04:00
manifests Get rid of the $pyvers variable 2021-06-09 16:19:15 +02:00
releasenotes/source Switch to newer openstackdocstheme and reno versions 2020-06-02 16:21:51 +02:00
spec Add support for oslo_policy/policy_dirs 2021-04-22 11:57:44 +09:00
.gitignore Fix outdated files 2020-09-17 01:03:49 +02:00
.gitreview Move to opendev 2019-04-24 14:54:02 +08:00
LICENSE Update LICENSE 2018-04-06 20:20:32 +08:00
README.md Change rpsec to rspec 2020-04-30 13:24:46 +08:00
bindep.txt Fix outdated files 2020-09-17 01:03:49 +02:00
metadata.json Merge "Drop Fedora support" 2021-08-18 11:51:34 +00:00
setup.cfg setup.cfg: Replace dashes with underscores 2021-05-11 13:22:18 +00:00
setup.py Add basic structure for ReNo 2016-10-06 13:45:00 -06:00
tox.ini Replace deprecated UPPER_CONSTRAINTS_FILE variable 2020-11-11 09:08:36 +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