From 4ff8c202801554c1d492c619d6cd1ed00280d5ac Mon Sep 17 00:00:00 2001 From: "Kay-Uwe (Kiwi)" Date: Mon, 26 Oct 2020 14:38:35 +0100 Subject: [PATCH] Add description of environment variables (#2915) --- docs/configuration.rst | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/docs/configuration.rst b/docs/configuration.rst index 4504b8e080..ae790c1807 100644 --- a/docs/configuration.rst +++ b/docs/configuration.rst @@ -12,6 +12,29 @@ Variable Substitution .. autoclass:: molecule.interpolation.Interpolator() :undoc-members: +There are following environment variables available in ``molecule.yml``: + +================================ =========================================================== + Variable Description +================================ =========================================================== +MOLECULE_DEBUG If debug is turned on or off +MOLECULE_FILE Path to molecule config file +MOLECULE_ENV_FILE Path to molecule environment file +MOLECULE_STATE_FILE ? +MOLECULE_INVENTORY_FILE Path to generated inventory file +MOLECULE_EPHEMERAL_DIRECTORY Path to generated directory, usually + ``~/.cache/molecule/`` +MOLECULE_SCENARIO_DIRECTORY Path to scenario directory +MOLECULE_PROJECT_DIRECTORY Path to your project directory +MOLECULE_INSTANCE_CONFIG ? +MOLECULE_DEPENDENCY_NAME Dependency type name, usually 'galaxy' +MOLECULE_DRIVER_NAME Name of the molecule scenario driver +MOLECULE_PROVISIONER_NAME Name of the provisioner tool (usually 'ansible') +MOLECULE_SCENARIO_NAME Name of the scenario +MOLECULE_VERIFIER_NAME Name of the verifier tool (usually 'ansible') +MOLECULE_VERIFIER_TEST_DIRECTORY ? +================================ =========================================================== + .. _dependency: Dependency