aboutsummaryrefslogtreecommitdiff
path: root/specs
diff options
context:
space:
mode:
authorKonstantinos Mouzakitis <kon.mouzakitis@vscaler.com>2020-06-09 12:59:52 -0400
committerRadosław Piliszek <radoslaw.piliszek@gmail.com>2020-06-18 17:33:51 +0000
commitf6d8c0d481306a45d61ed224c02ff12615e83ec9 (patch)
tree97b2fa40bcb50682abb4cbb0578e0ec0d093e257 /specs
parentce1dc6da0a9de197c149cd045d48ff7a25c54701 (diff)
downloadkolla-ansible-f6d8c0d481306a45d61ed224c02ff12615e83ec9.tar.gz
kolla-ansible-f6d8c0d481306a45d61ed224c02ff12615e83ec9.zip
Adding support for multiple globals files
Added a spec file for this blueprint. Changed the kolla-ansible script to accept more than one globals.yml file. That will still be the main one but operators will be able to create more, under the /etc/kolla/globals.d directory. Also added some paragraphs in the quickstart documentation about this. Finally, Adding a release note Change-Id: I34eb91d0e2ed80694594b8fc6801cf8ad77da754 Implements: blueprint multiple-globals-files
Diffstat (limited to 'specs')
-rw-r--r--specs/multiple-globals-files.rst88
1 files changed, 88 insertions, 0 deletions
diff --git a/specs/multiple-globals-files.rst b/specs/multiple-globals-files.rst
new file mode 100644
index 000000000..ab9dc8767
--- /dev/null
+++ b/specs/multiple-globals-files.rst
@@ -0,0 +1,88 @@
+..
+ This work is licensed under a Creative Commons Attribution 3.0 Unported
+ License.
+
+ http://creativecommons.org/licenses/by/3.0/legalcode
+
+..
+ This template should be in ReSTructured text. The filename in the git
+ repository should match the launchpad URL, for example a URL of
+ https://blueprints.launchpad.net/kolla/+spec/awesome-thing should be named
+ awesome-thing.rst . Please do not delete any of the sections in this
+ template. If you have nothing to say for a whole section, just write: None
+ For help with syntax, see http://www.sphinx-doc.org/en/stable/rest.html
+ To test out your formatting, see http://www.tele3.cz/jbar/rest/rest.html
+
+======================================
+Add support for multiple globals files
+======================================
+
+https://blueprints.launchpad.net/kolla-ansible/+spec/multiple-globals-files
+
+Adding this feature to the kolla-ansible script, which will make it, automatically,
+read multiple globals files. This would give operators the ability to have
+separate globals files for some services, giving them a bit more granular control,
+without the need to add the ``-e @/path/to/file`` flag. These files will be placed
+under a new ``/etc/kolla/globals.d`` directory and ``kolla-ansible`` will search
+for ``globals.d/*.yml`` files. The main ``globals.yml`` file will still exist
+under ``/etc/kolla``, as usual.
+
+Problem description
+===================
+
+There's no problem, per say, to solve. This feature will basically give operators
+the ability to have separate globals files for some services, giving them a bit
+more granular control, without the need to add the ``-e @/path/to/file`` flag.
+
+Use cases
+---------
+1. Allow a more granular controler over individual service's options
+2. Better file and directory structure
+
+Proposed change
+===============
+
+- Add the capability in the ``tools/kolla-ansible`` script
+ - Check if the ``globals.d`` directory exists
+ - If it is, add its files in the ``CONFIG_OPTS`` variable at the end of the ``tools/kolla-ansible`` script
+
+Security impact
+---------------
+
+None
+
+Performance Impact
+------------------
+
+None
+
+
+Implementation
+==============
+
+Assignee(s)
+-----------
+
+Konstantinos Mouzaitis <kon.mouzakitis@vscaler.com>
+
+Milestones
+----------
+
+Target Milestone for completion:
+ ussuri-10.0.0
+
+Work Items
+----------
+
+- Add the capability in the ``tools/kolla-ansible`` script
+ - Check if the ``globals.d`` directory exists
+ - If it is, add its files in the ``CONFIG_OPTS`` variable at the end of the ``tools/kolla-ansible`` script
+
+Testing
+=======
+Test the new kolla-ansible script when the ``globals.d`` directory exists and
+includes some more yml files, as well as when it doesn't exist.
+
+Documentation Impact
+====================
+``doc/source/user/quickstart.rst`` will need to be updated to include the options discussed in this feature