summaryrefslogtreecommitdiff
path: root/README.md
blob: 41e9e28fd40eb36d51dfa883b07f9a62a838ff02 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
Team and repository tags
========================

[![Team and repository tags](https://governance.openstack.org/tc/badges/puppet-openstack-cookiecutter.svg)](https://governance.openstack.org/tc/reference/tags/index.html)

<!-- Change things from this point on -->

# 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://git.openstack.org/cgit/openstack/puppet-openstack-cookiecutter/) repository.
  2. Run `cookiecutter /path/to/cloned/repo`

### Remotely (ie. using a git repo)

  1. Run `cookiecutter https://git.openstack.org/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://git.openstack.org/cgit/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.