Browse Source

Update README.rst

This commit renames and updates the rather outdated README
for this project.

Change-Id: Ibd1531dc14a2c04d8d91a3339c1df47a41c94790
changes/75/230675/6
Dan Prince 7 years ago
parent
commit
84aa3e8c39
  1. 10
      README.md
  2. 55
      README.rst
  3. 2
      setup.cfg

10
README.md

@ -1,10 +0,0 @@
templates
=========
Generic templates to describe multi-host infrastructure, consumable by OpenStack Heat, Crowbar, others.
merge.py
========
The Makefile contains several targets for generated templates, see its contents for all of them. To run functional tests for merge.py, run 'make test'.

55
README.rst

@ -0,0 +1,55 @@
======================
tripleo-heat-templates
======================
Heat templates to deploy OpenStack using OpenStack.
* Free software: Apache license
* Documentation: http://docs.openstack.org/developer/tripleo-docs
* Source: http://git.openstack.org/cgit/openstack/tripleo-heat-templates
* Bugs: http://bugs.launchpad.net/tripleo
Features
--------
The ability to deploy a multi-node, role based OpenStack deployment using
OpenStack Heat. Notable features include:
* Choice of deployment/configuration tooling: puppet, os-apply-config, and
(soon) docker
* Role based deployment: roles for the controller, compute, ceph, swift,
and cinder storage
* physical network configuration: support for isolated networks, bonding,
and standard ctlplane networking
Directories
-----------
A description of the directory layout in TripleO Heat Templates.
* deprecated: contains templates that have been deprecated
* environments: contains heat environment files that can be used with -e
on the command like to enable features, etc.
* extraconfig: templates used to enable 'extra' functionality. Includes
functionality for distro specific registration and upgrades.
* firstboot: example first_boot scripts that can be used when initially
creating instances.
* network: heat templates to help create isolated networks and ports
* puppet: templates mostly driven by configuration with puppet. To use these
templates you can use the overcloud-resource-registry-puppet.yaml.
* os-apply-config: templates mostly driven by configuration w/
os-collect-config and bash based
elements (which use the Heat os-apply-config group).
These will soon be deprecated and are no longer part
of the upstream CI testing efforts.
* validation-scripts: validation scripts useful to all deployment
configurations

2
setup.cfg

@ -2,7 +2,7 @@
name = tripleo-heat-templates
summary = Heat templates for deploying OpenStack with OpenStack.
description-file =
README.md
README.rst
author = OpenStack
author_email = openstack-dev@lists.openstack.org
license = Apache License (2.0)

Loading…
Cancel
Save