Skip to content

Commit

Permalink
Merge pull request #320 from wxtim/parsed_config_files_should_contain…
Browse files Browse the repository at this point in the history
…_the_output_of_cylc_config

companion to cylc/cylc-flow#4521
  • Loading branch information
hjoliver authored Nov 22, 2021
2 parents 07da1b3 + 8d39032 commit 8c58043
Showing 1 changed file with 21 additions and 2 deletions.
23 changes: 21 additions & 2 deletions src/user-guide/running-workflows/running-workflows.rst
Original file line number Diff line number Diff line change
Expand Up @@ -171,10 +171,29 @@ reload are not inserted into the pool automatically. The first instance of each
must be inserted manually at the right cycle point, with ``cylc insert``.


Files Created at Workflow Start
-------------------------------

Configuration Logs
^^^^^^^^^^^^^^^^^^

At startup a folder ``log/flow-config`` is created to record the workflow configuration,
with all templating expanded:

- ``flow-processed.cylc`` - the current workflow configuration
with templating expanded, and duplicate sections unmerged.
- ``<datetime-stamp>-<start/restart/reload>`` - the config at each time the workflow
was started, restarted, or reloaded; with duplicate sections merged.

.. note::

Look at these files to see the result of templating in the workflow config.


.. _The Workflow Contact File:

The Workflow Contact File
-------------------------
^^^^^^^^^^^^^^^^^^^^^^^^^

At start-up, :term:`schedulers <scheduler>` write a :term:`contact file`
``$HOME/cylc-run/WORKFLOW/.service/contact`` that records workflow host,
Expand All @@ -186,7 +205,7 @@ commands can read this file, if they have access to it, to find the target
.. _Authentication Files:

Authentication Files
--------------------
^^^^^^^^^^^^^^^^^^^^

Cylc uses `CurveZMQ`_ to ensure that
any data, sent between the :term:`scheduler <scheduler>` and the client,
Expand Down

0 comments on commit 8c58043

Please sign in to comment.