openstack/fuel-library
Code Issues Proposed changes
RETIRED, Fuel Library
11,036 Commits 4 Branches 3 Tags 267 MiB
4fec63f8d0
Go to file
Jenkins 4fec63f8d0 Merge "Fix few small issues with dockerctl inspect"
2015-10-06 10:20:19 +00:00
debian Moving socat to a fuel-misc dependency 2015-09-25 13:13:34 +00:00
deployment Merge "Remove duplicated constant MAX_BR_NAME_LENGTH" 2015-10-06 10:15:08 +00:00
files Fix few small issues with dockerctl inspect 2015-10-05 13:00:45 +02:00
specs Moving socat to a fuel-misc dependency 2015-09-25 13:13:34 +00:00
tests Merge "Move keystone module to librarian" 2015-10-06 08:24:51 +00:00
utils Fix openstack module tests 2015-09-25 08:40:35 -05:00
.gitignore Fix error in the noops tests framework 2015-08-11 16:14:15 +03:00
.gitreview Setup git-review 2013-12-11 14:31:13 +04:00
CHANGELOG Edit Changelog 2013-05-23 13:38:03 +03:00
LICENSE LICENCE added 2014-06-05 20:00:54 +00:00
README.md Update README.md 2015-09-29 09:37:12 -05:00

README.md

fuel-library

Table of Contents

  1. Overview - What is the fuel-library?
  2. Structure - What is in the fuel-library?
  3. Granular Deployment - What is the granular deployment for Fuel?
  4. Upstream Modules - How to work with librarian.
  5. Testing - How to run fuel-library tests.
  6. Development
  7. Core Reviers
  8. 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.

Development

Core Reviewers

Contributors