@@ -672,15 +672,25 @@ recommend the following guidelines.
672
672
* Keep blueprints fairly narrow. One of their main values is to
673
673
document (in code) how a particular feature is enabled and
674
674
configured. Introduce new roles to keep playbooks narrow. Introduce
675
- new values files to keep each example override file narrow.
675
+ new values override files (and other config files) to keep each
676
+ example narrow.
676
677
677
678
* Use Ansible best-practices for defining playbooks. This means using
678
679
Ansible plugins rather than invoking shell scripts, whenever
679
680
possible.
680
681
681
- * Minimize the number of variables exposed in
682
+ * Avoid exposing too many variables in
682
683
``vars/main-blueprint.yml ``. Their main purpose is direct how
683
684
Ansible deploys Aether, and not to configure the individual
684
685
subsystems of a given deployment. The latter details are best
685
- defined in a values override file, which can then be referenced by
686
- ``vars/main-blueprint.yml ``.
686
+ defined in component-specific configuration files (e.g., values
687
+ override files), which can then be referenced by
688
+ ``vars/main-blueprint.yml ``. The main exception is variables
689
+ that enable/disable a particular feature. Two good examples are
690
+ ``core.standalone `` and ``oai.simulation ``.
691
+
692
+ * Avoid embedding configuration parameters in Ansible playbooks.
693
+ Such parameters should be collected in either ``vars/main-blueprint.yml ``
694
+ or a component-specific configuration file, depending on their
695
+ purpose (see previous item).
696
+
0 commit comments