opendev
/
puppet-featuretracker
Code Issues Proposed changes
puppet-featuretracker/README.md

2.2 KiB
Raw Blame History

userstory_dashboard

Table of Contents

  1. Overview - What is the userstory_dashboard module?
  2. Module Description - What does the module do?
  3. Setup - The basics of getting started with userstory_dashboard
  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 userstory_dashboard module is a part of OpenStack-infra, an effort by the OpenStack infrastructure team to provide continuous integration testing and code review for OpenStack-infra projects.

Module Description

The userstory_dashboard module is a thorough attempt to make Puppet capable of managing the entirety of userstory_dashboard. This includes manifests to provision the expected features of this module. Types are shipped as part of the userstory_dashboard module to assist in manipulation of configuration files.

Setup

Installing userstory_dashboard

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

Beginning with userstory_dashboard

To utilize the userstory_dashboard module's functionality please check the README.

Implementation

userstory_dashboard

userstory_dashboard is a combination of Puppet manifests to delivery configuration and extra functionality through types and providers.

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-infra project.