From c6fb9c30cc02d5e27cfc87ed986a190a92d7e213 Mon Sep 17 00:00:00 2001 From: Stephen Finucane Date: Mon, 16 Sep 2019 09:41:02 +0100 Subject: [PATCH] Update READMEs for sample policy/config generation Add a combined README for config generation and replace references to nova for policy generation. Change-Id: I3e5fe46f1a63f929e7a73b454507c287574fb83a Signed-off-by: Stephen Finucane --- etc/placement/README-policy.yaml.txt | 11 ----------- etc/placement/README.rst | 28 ++++++++++++++++++++++++++++ 2 files changed, 28 insertions(+), 11 deletions(-) delete mode 100644 etc/placement/README-policy.yaml.txt create mode 100644 etc/placement/README.rst diff --git a/etc/placement/README-policy.yaml.txt b/etc/placement/README-policy.yaml.txt deleted file mode 100644 index a4dcab683..000000000 --- a/etc/placement/README-policy.yaml.txt +++ /dev/null @@ -1,11 +0,0 @@ -Placement -========= - -To generate the sample placement policy.yaml file, run the following command -from the top level of the nova directory: - - tox -e genpolicy - -For a pre-generated example of the latest placement policy.yaml, see: - - https://docs.openstack.org/nova/latest/configuration/sample-policy.html diff --git a/etc/placement/README.rst b/etc/placement/README.rst new file mode 100644 index 000000000..ee37cce67 --- /dev/null +++ b/etc/placement/README.rst @@ -0,0 +1,28 @@ +Sample policy and config files +============================== + +This directory contains sample ``placement.conf`` and ``policy.yaml`` files. + +Sample Config +------------- + +To generate the sample ``placement.conf`` file, run the following command from +the top level of the placement directory:: + + tox -e genconfig + +For a pre-generated example of the latest ``placement.conf``, see: + + https://docs.openstack.org/placement/latest/configuration/sample-config.html + +Sample Policy +------------- + +To generate the sample ``policy.yaml`` file, run the following command from the +top level of the placement directory:: + + tox -e genpolicy + +For a pre-generated example of the latest placement ``policy.yaml``, see: + + https://docs.openstack.org/placement/latest/configuration/sample-policy.html