openstack/tripleo-puppet-elements
Code Issues Proposed changes

[Documentation] Migrate the format.

Browse Source 
Moved the file to README.rst for consistency with other OpenStack
project documentation.

Change-Id: I47035688b15edc1b7f6b70ee5d336b00ab22d5ff
This commit is contained in:
Natal Ngétal 2018-12-24 10:04:33 +01:00
parent a72c6b33de
commit 47aba4556d
2 changed files with 15 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
README.md → README.rst
View File

@ -1,28 +1,31 @@
========================
Team and repository tags
========================
[![Team and repository tags](http://governance.openstack.org/badges/tripleo-puppet-elements.svg)](http://governance.openstack.org/reference/tags/index.html)
.. image:: http://governance.openstack.org/badges/tripleo-puppet-elements.svg
:target: http://governance.openstack.org/reference/tags/index.html
<!-- Change things from this point on -->
.. Change things from this point on
Puppet building rules for OpenStack images
==========================================
These elements are used to build disk images for deploying OpenStack via Heat.
They are built as part of the TripleO (https://wiki.openstack.org/wiki/TripleO)
umbrella project.
They are built as part of the TripleO_ umbrella project.
.. _TripleO: https://wiki.openstack.org/wiki/TripleO
Instructions
------------
Checkout this source tree and also the diskimage builder, export an
ELEMENTS\_PATH to add elements from this tree, and build any disk images you
need.
ELEMENTS_PATH to add elements from this tree, and build any disk images you
need::
git clone https://git.openstack.org/openstack/diskimage-builder.git
git clone https://git.openstack.org/openstack/tripleo-puppet-elements.git
export ELEMENTS_PATH=tripleo-puppet-elements/elements
diskimage-builder/bin/disk-image-create -u base vm bootstrap local-config stackuser heat-cfntools -a i386 -o bootstrap
git clone https://git.openstack.org/openstack/diskimage-builder.git
git clone https://git.openstack.org/openstack/tripleo-puppet-elements.git
export ELEMENTS_PATH=tripleo-puppet-elements/elements
diskimage-builder/bin/disk-image-create -u base vm bootstrap local-config stackuser heat-cfntools -a i386 -o bootstrap
Common element combinations
---------------------------
@ -80,9 +83,7 @@ Copyright
Licensed under the Apache License, Version 2.0 (the "License"); you may
not use this file except in compliance with the License. You may obtain
a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT

2
setup.cfg
View File

@ -2,7 +2,7 @@
name = tripleo-puppet-elements
summary = Puppet building rules for OpenStack images.
description-file =
README.md
README.rst
author = OpenStack
author-email = openstack-discuss@lists.openstack.org
license = Apache License (2.0)