Skip to content

Commit 23a221e

Browse files
committed
docs(tofs): update from nginx-formula
* saltstack-formulas/nginx-formula#238 (comment)
1 parent 3425b5a commit 23a221e

File tree

1 file changed

+5
-8
lines changed

1 file changed

+5
-8
lines changed

docs/TOFS_pattern.rst

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Using SaltStack is a simple and effective way to implement configuration managem
3939

4040
To avoid this situation we can use the `pillar mechanism <http://docs.saltstack.com/en/latest/topics/pillar/>`_, which is designed to provide controlled access to data from the minions based on some selection rules. As pillar data could be easily integrated in the `Jinja <http://docs.saltstack.com/en/latest/topics/tutorials/pillar.html>`_ templates, it is a good mechanism to store values to be used in the final rendering of state files and templates.
4141

42-
There are a variety of approaches on the usage of pillar and templates as seen in the `saltstack-formulas <https://github.com/saltstack-formulas>`_' repositories. `Some <https://github.com/saltstack-formulas/nginx-formula/pull/18>`_ `developments <https://github.com/saltstack-formulas/php-formula/pull/14>`_ stress the initial purpose of pillar data into a storage for most of the possible variables for a determined system configuration. This, in my opinion, is shifting too much load from the original template files approach. Adding up some `non-trivial Jinja <https://github.com/spsoit/nginx-formula/blob/81de880fe0276dd9488ffa15bc78944c0fc2b919/nginx/ng/files/nginx.conf>`_ code as essential part of composing the state file definitely makes SaltStack state files (hence formulas) more difficult to read. The extreme of this approach is that we could end up with a new render mechanism, implemented in Jinja, storing everything needed in pillar data to compose configurations. Additionally, we are establishing a strong dependency with the Jinja renderer.
42+
There are a variety of approaches on the usage of pillar and templates as seen in the `saltstack-formulas <https://github.com/saltstack-formulas>`_' repositories. `Some <https://github.com/saltstack-formulas/nginx-formula/pull/18>`_ `developments <https://github.com/saltstack-formulas/php-formula/pull/14>`_ stress the initial purpose of pillar data into a storage for most of the possible variables for a determined system configuration. This, in my opinion, is shifting too much load from the original template files approach. Adding up some `non-trivial Jinja <https://github.com/saltstack-formulas/nginx-formula/blob/f74254c07e188bd448eaf1c5f9c802d78c4c005e/nginx/files/default/nginx.conf>`_ code as essential part of composing the state file definitely makes SaltStack state files (hence formulas) more difficult to read. The extreme of this approach is that we could end up with a new render mechanism, implemented in Jinja, storing everything needed in pillar data to compose configurations. Additionally, we are establishing a strong dependency with the Jinja renderer.
4343

4444
In opposition to the *put the code in file_roots and the data in pillars* approach, there is the *pillar as a store for a set of key-values* approach. A full-blown configuration file abstracted in pillar and jinja is complicated to develop, understand and maintain. I think a better and simpler approach is to keep a configuration file templated using just a basic (non-extensive but extensible) set of pillar values.
4545

@@ -325,7 +325,6 @@ We can simplify the ``conf.sls`` with the new ``files_switch`` macro to use in t
325325
326326
327327
* This uses ``config.get``, searching for ``ntp:tofs:source_files:Configure NTP`` to determine the list of template files to use.
328-
* If this returns a result, the default of ``['/etc/ntp.conf.jinja']`` will be appended to it.
329328
* If this does not yield any results, the default of ``['/etc/ntp.conf.jinja']`` will be used.
330329

331330
In ``libtofs.jinja``, we define this new macro ``files_switch``.
@@ -427,20 +426,18 @@ The list of ``source_files`` can be given:
427426
tofs:
428427
source_files:
429428
Configure NTP:
429+
- '/etc/ntp.conf.jinja'
430430
- '/etc/ntp.conf_alt.jinja'
431431
432432
Resulting in:
433433

434434
.. code-block:: sls
435435
436436
- source:
437-
- salt://ntp/files/theminion/etc/ntp.conf_alt.jinja
438437
- salt://ntp/files/theminion/etc/ntp.conf.jinja
439-
- salt://ntp/files/Debian/etc/ntp.conf_alt.jinja
438+
- salt://ntp/files/theminion/etc/ntp.conf_alt.jinja
440439
- salt://ntp/files/Debian/etc/ntp.conf.jinja
441-
- salt://ntp/files/default/etc/ntp.conf_alt.jinja
440+
- salt://ntp/files/Debian/etc/ntp.conf_alt.jinja
442441
- salt://ntp/files/default/etc/ntp.conf.jinja
443-
444-
Note: This does *not* override the default value.
445-
Rather, the value from the pillar/config is prepended to the default.
442+
- salt://ntp/files/default/etc/ntp.conf_alt.jinja
446443

0 commit comments

Comments
 (0)