| Monty Taylor | 36ddea3 | 2017-10-02 10:05:17 -0500 | [diff] [blame] | 1 | Write the local.conf file for use by devstack |
| 2 | |
| 3 | **Role Variables** |
| 4 | |
| 5 | .. zuul:rolevar:: devstack_base_dir |
| 6 | :default: /opt/stack |
| 7 | |
| 8 | The devstack base directory. |
| 9 | |
| 10 | .. zuul:rolevar:: devstack_local_conf_path |
| 11 | :default: {{ devstack_base_dir }}/devstack/local.conf |
| 12 | |
| 13 | The path of the local.conf file. |
| 14 | |
| 15 | .. zuul:rolevar:: devstack_localrc |
| 16 | :type: dict |
| 17 | |
| 18 | A dictionary of variables that should be written to the localrc |
| 19 | section of local.conf. The values (which are strings) may contain |
| 20 | bash shell variables, and will be ordered so that variables used by |
| 21 | later entries appear first. |
| 22 | |
| 23 | .. zuul:rolevar:: devstack_local_conf |
| 24 | :type: dict |
| 25 | |
| 26 | A complex argument consisting of nested dictionaries which combine |
| 27 | to form the meta-sections of the local_conf file. The top level is |
| 28 | a dictionary of phases, followed by dictionaries of filenames, then |
| 29 | sections, which finally contain key-value pairs for the INI file |
| 30 | entries in those sections. |
| 31 | |
| 32 | The keys in this dictionary are the devstack phases. |
| 33 | |
| 34 | .. zuul:rolevar:: [phase] |
| 35 | :type: dict |
| 36 | |
| 37 | The keys in this dictionary are the filenames for this phase. |
| 38 | |
| 39 | .. zuul:rolevar:: [filename] |
| 40 | :type: dict |
| 41 | |
| 42 | The keys in this dictionary are the INI sections in this file. |
| 43 | |
| 44 | .. zuul:rolevar:: [section] |
| 45 | :type: dict |
| 46 | |
| 47 | This is a dictionary of key-value pairs which comprise |
| 48 | this section of the INI file. |
| 49 | |
| 50 | .. zuul:rolevar:: devstack_services |
| 51 | :type: dict |
| 52 | |
| 53 | A dictionary mapping service names to boolean values. If the |
| 54 | boolean value is ``false``, a ``disable_service`` line will be |
| 55 | emitted for the service name. If it is ``true``, then |
| Andrea Frittoli (andreaf) | 5551170 | 2017-11-30 15:49:39 +0000 | [diff] [blame^] | 56 | ``enable_service`` will be emitted. All other values are ignored. |
| 57 | The special key ``base`` can be used to enable or disable the base set of |
| 58 | services enabled by default. If ``base`` is found, it will processed before |
| 59 | all other keys. If its value is ``False`` a ``disable_all_services`` will be |
| 60 | emitted; if its value is ``True`` nothing will be emitted since base |
| 61 | services are enabled by default. |
| Monty Taylor | 36ddea3 | 2017-10-02 10:05:17 -0500 | [diff] [blame] | 62 | |
| 63 | .. zuul:rolevar:: devstack_plugins |
| 64 | :type: dict |
| 65 | |
| 66 | A dictionary mapping a plugin name to a git repo location. If the |
| 67 | location is a non-empty string, then an ``enable_plugin`` line will |
| 68 | be emmitted for the plugin name. |