openstack/tripleo-heat-templates
Code Issues Proposed changes

Add deployments/README.rst

Browse Source 
To help clarify current and future naming conventions in this directory.

Change-Id: Ib9d24f9844f5aecd47cdd6a47247562dce2092ee
Related-Blueprint: services-yaml-flattening
This commit is contained in:
Dan Prince 2018-12-13 10:25:09 -05:00
parent 4e9a66ae86
commit bcf80d474a
1 changed files with 32 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
deployment/README.rst Normal file
View File

@ -0,0 +1,32 @@
===================
TripleO Deployments
===================
This directory contains files that represent individual service deployments,
orchestration tools, and the configuration tools used to deploy them.
Directory Structure
-------------------
Each logical grouping of services will have a directory. Example: 'timesync'.
Within this directory related timesync services would exist to for example
configure timesync services on baremetal or via containers.
Filenaming conventions
----------------------
As a convention each deployments service filename will reflect both
the deployment engine (baremetal, or containers) along with the
config tool used to deploy that service.
The convention is <service-name>-<engine>-<config management tool>.
Examples:
deployment/aodh/aodh-api-container-puppet.yaml (containerized Aodh service configured with Puppet)
deployment/aodh/aodh-api-container-ansible.yaml (containerized Aodh service configured with Ansible)
deployment/timesync/chrony-baremetal-ansible.yaml (baremetal Chrony service configured with Ansible)
deployment/timesync/chrony-baremetal-puppet.yaml (baremetal Chrony service configured with Puppet)