@@ -670,28 +670,34 @@ existing features. In addition to meeting the general definition of a
670670blueprint (as introduced in the introduction to this section), we
671671recommend the following guidelines.
672672
673- * Keep blueprints fairly narrow. One of their main values is to
674- document (in code) how a particular feature is enabled and
675- configured. Introduce new roles to keep playbooks narrow. Introduce
676- new values override files (and other config files) to keep each
677- example narrow.
678-
679673* Use Ansible best-practices for defining playbooks. This means using
680674 Ansible plugins rather than invoking shell scripts, whenever
681675 possible.
682676
677+ * Avoid embedding configuration parameters in Ansible playbooks.
678+ Such parameters should be collected in either ``vars/main-blueprint.yml ``
679+ or a component-specific configuration file, depending on their
680+ purpose (see next item).
681+
683682* Avoid exposing too many variables in
684683 ``vars/main-blueprint.yml ``. Their main purpose is direct how
685684 Ansible deploys Aether, and not to configure the individual
686685 subsystems of a given deployment. The latter details are best
687686 defined in component-specific configuration files (e.g., values
688687 override files), which can then be referenced by
689- ``vars/main-blueprint.yml ``. The main exception is variables
690- that enable/disable a particular feature. Two good examples are
688+ ``vars/main-blueprint.yml ``. The exception is variables that
689+ enable/disable a particular feature. Two good examples are
691690 ``core.standalone `` and ``oai.simulation ``.
692691
693- * Avoid embedding configuration parameters in Ansible playbooks.
694- Such parameters should be collected in either ``vars/main-blueprint.yml ``
695- or a component-specific configuration file, depending on their
696- purpose (see previous item).
692+ * Keep blueprints narrow. One of their main values is to document (in
693+ code) how a particular feature is enabled and configured. Introduce
694+ new roles to keep playbooks narrow. Introduce new values override
695+ files (and other config files) to keep each configuration narrow.
696+ Introduce new ``vars/main-blueprint.yml `` files to document how a
697+ single feature is deployed. The exception is "combo" blueprints that
698+ combine multiple existing features (already enabled by
699+ single-feature blueprints) to deploy a comprehensive solution.
700+
701+
702+
697703
0 commit comments