033f4e7c70
Update the cookiecutter templates to reflect various changes : * Move to openstack/ scope * More up to date metadata.json (operatingsystem_support) * Fix white space * Fix README naming and links * Remove duplicated CHANGELOG Change-Id: I520d60952f93a226a318465ec79567662274efde
25 lines
1.0 KiB
Markdown
25 lines
1.0 KiB
Markdown
# puppet-openstack-cookiecutter
|
|
|
|
Cookiecutter template for a compliant Openstack puppet-modules
|
|
|
|
## Installation
|
|
|
|
Install [cookiecutter](https://cookiecutter.readthedocs.org/) either from source, pip or package if it exists
|
|
|
|
## Usage
|
|
|
|
There are two ways to create the boilerplate for the puppet module.
|
|
|
|
### Locally
|
|
|
|
1. Clone locally the [puppet-openstack-cookiecutter](https://github.com/openstack/puppet-openstack-cookiecutter.git) repository.
|
|
2. Run `cookiecutter /path/to/cloned/repo`
|
|
|
|
### Remotely (ie. using a git repo)
|
|
|
|
1. Run `cookiecutter https://github.com/openstack/puppet-openstack-cookiecutter.git`
|
|
|
|
## What's next
|
|
|
|
Once the boilerplate created, in order to be compliant with the other modules, the files managed by [msync](https://github.com/puppet-community/modulesync), (or [configs](https://github.com/openstack/puppet-modulesync-configs)) needs to be in the project folder. Once synced module is ready, announce its existence to the ML, make the proper patch to openstack-infra and finally wait for the reviews to do the rest.
|