From bcf80d474a987b51ad0b554fc386141ba2f530e8 Mon Sep 17 00:00:00 2001 From: Dan Prince Date: Thu, 13 Dec 2018 10:25:09 -0500 Subject: [PATCH] Add deployments/README.rst To help clarify current and future naming conventions in this directory. Change-Id: Ib9d24f9844f5aecd47cdd6a47247562dce2092ee Related-Blueprint: services-yaml-flattening --- deployment/README.rst | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 deployment/README.rst diff --git a/deployment/README.rst b/deployment/README.rst new file mode 100644 index 0000000000..69a1db1b5d --- /dev/null +++ b/deployment/README.rst @@ -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 --. + +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)