diff --git a/docs/source/index.rst b/docs/source/index.rst index 85ec42161861bffb8816bc46a966b37699bb1278..73d885fa97a6a79bb4a54f90cc198a492e380eec 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,7 +1,7 @@ -GOAT Lightweight Service Orchestrator -===================================== +Lightweight service orchestrator +================================ -Documentation for LSO: a Lightweight Service Orchestrator +Documentation for LSO (Lightweight Service Orchestrator). .. toctree:: :maxdepth: 1 diff --git a/docs/source/quickstart.rst b/docs/source/quickstart.rst index fe28eb9743b3d60740afd527c2f06d78ba1abcab..4258a1aab099ddc6e198682396a37f608b554715 100644 --- a/docs/source/quickstart.rst +++ b/docs/source/quickstart.rst @@ -35,6 +35,7 @@ Running the app ------------------- * Create a settings file, see `config.json.example` for an example. +* If necessary, set the environment vairable `ANSIBLE_HOME` to a custom path. * Run the app like this (`app.py` starts the server on port 44444): .. code-block:: bash diff --git a/lso/__init__.py b/lso/__init__.py index 757477d2543bb01ef487c8160a03a9a1a8934c8d..84133fbf8c54d4da1f9560800275a522567cd549 100644 --- a/lso/__init__.py +++ b/lso/__init__.py @@ -34,7 +34,7 @@ def create_app(): app.include_router(default.router, prefix='/api') app.include_router(device.router, prefix='/api/device') - # test that config params are available and can be loaded + # test that config params are loaded and available config.load() logging.info('FastAPI app initialized') diff --git a/lso/playbook.py b/lso/playbook.py index c3d403ff2deeb4dab2b273ae106a78534e5c83da..c9fb60d8c5071445a280ed27038cf5355d4acea0 100644 --- a/lso/playbook.py +++ b/lso/playbook.py @@ -117,8 +117,8 @@ def run_playbook( :param dict extra_vars: Any extra vars needed for the playbook to run. :param str inventory: The inventory that the playbook is executed against. :param str callback: Callback URL where the playbook should send a status - update when execution is completed. This is used for WFO to continue - with the next step in a workflow. + update when execution is completed. This is used for + workflow-orchestrator to continue with the next step in a workflow. :return: Result of playbook launch, this could either be successful or unsuccessful. :rtype: :class:`PlaybookLaunchResponse`