openstack
/
fuel-web
Code Issues Proposed changes

Address new rules for bringing in external puppet modules 

See
[0] https://lists.launchpad.net/fuel-dev/msg00650.html
[1] https://etherpad.openstack.org/p/adding_fuel_lib_modules

Partial-bug: #1280470

Change-Id: I04a3f608625cf95f7633832295e583059729226e
Signed-off-by: Bogdan Dobrelya <bdobrelia@mirantis.com>
This commit is contained in:
Bogdan Dobrelya 2014-04-07 11:06:10 +03:00
parent 209cd46cbe
commit 68b1ec4650
1 changed files with 31 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
docs/develop/module_structure.rst
View File

@ -7,6 +7,37 @@ and how to avoid different problems and potential mistakes. Fuel Library is a
very big project and even experienced Puppet user will have problems
understanding its structure and internal workings.
Adding new modules to fuel-library
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*Case A. Pulling in an existing module*
If you are adding a module that is the work of another project and is already
tracked in separate repo then:
1. Create a review request with a unmodified copy of the upstream module from
whichever point you are working from and *no* other related modifications.
* This review should also contain the commit hash from the upstream repo
in the commit message.
* The review should be evaluated to determine its suitability and either rejected
(for licensing, code quality, outdated version requested) or accepted
without requiring modifications.
* The review should not include code that calls this new module.
2. Any changes necessary to make it work with Fuel should then be proposed
as a dependent change(s).
*Case B. Adding a new module*
If you are adding a new module that is a work purely for Fuel and will not be
tracked in a separate repo then submit incremental reviews that consist of
working implementation of features for your module.
If you have features that are necessary, but do not work fully yet, then prevent
them from running during the deployment. Once your feature is complete, submit
a review to activate the module during deployment.
The Puppet modules structure
~~~~~~~~~~~~~~~~~~~~~~~~~~~~