06107883e5
This change updates the README to include more useful information about fuel-library as an open source project. Change-Id: Ie31cc684307331cf3d51a56e3621101b1edd9505 Closes-Bug: #1500069
3.2 KiB
fuel-library
Table of Contents
- Overview - What is the fuel-library?
- Structure - What is in the fuel-library?
- Granular Deployment - What is the granular deployment for Fuel?
- Upstream Modules - How to work with librarian.
- Testing - How to run fuel-library tests.
- Development
- Core Reviers
- Contributors
Overview
The fuel-library is collection of Puppet modules and related code used by Fuel to deploy OpenStack environments.
Structure
Basic Repository Layout
fuel-library
├── CHANGELOG
├── LICENSE
├── README.md
├── debian
├── deployment
├── files
├── specs
├── tests
└── utils
root
The root level contains important repository documentation and license information.
debian/
This folder contains the required information to create fuel-library debian packages.
deployment/
This folder contains the fuel-library Puppet code, the Puppetfile for upstream modules, and scripts to manage modules with librarian-puppet-simple.
files/
This folder contains scripts and configuration files that are used when creating the packages for fuel-library.
specs/
This folder contains our rpm spec file for fuel-library rpm packages.
tests/
This folder contains our testing scripts for the fuel-library.
utils/
This folder contains scripts that are useful when doing development on fuel-library
Granular Deployment
TODO.
Upstream Modules
In order to be able to pull in upstream modules for use by the fuel-library, the deployment folder contains a Puppetfile for use with librarian-puppet-simple. Upstream modules should be used whenever possible. For additional details on the process for working with upstream modules, please read the Fuel library for Puppet manifests of the Fuel wiki.
Testing
Testing is important for the fuel-library to ensure changes do what they are supposed to do, regressions are not introduced and all code is of the highest quality. The fuel-library leverages existing Puppet module rspec tests, bats tests for bash scripts and noop tests for testing the module deployment tasks in fuel-library.
Puppet module tests
TODO.
Bats: Bash Automated Testing System
TODO.
fuel-library noop
TODO.