From 98e823e064d4018821f5dfb9858048adea6fc709 Mon Sep 17 00:00:00 2001 From: Tim Pillinger <26465611+wxtim@users.noreply.github.com> Date: Wed, 17 Nov 2021 13:17:20 +0000 Subject: [PATCH 1/4] companion to https://github.com/cylc/cylc-flow/pull/4521 --- .../running-workflows/running-workflows.rst | 27 +++++++++++++++++-- 1 file changed, 25 insertions(+), 2 deletions(-) diff --git a/src/user-guide/running-workflows/running-workflows.rst b/src/user-guide/running-workflows/running-workflows.rst index a55bd07a4d..260f88b167 100644 --- a/src/user-guide/running-workflows/running-workflows.rst +++ b/src/user-guide/running-workflows/running-workflows.rst @@ -171,10 +171,33 @@ 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 where the flow configuration +is recorded, with all templating expanded: + +- ``flow-processed.cylc`` - A record of the current workflow configuration + with templating expanded, but without being fully parsed: Duplicate sections + will not be merged. +- ``-`` - A record of the config at + the time a workflow was started, restarted or reloaded, parsed by Cylc: + Duplicate sections will be merged. + +.. note:: + + These are particularly useful files to look at if you are working with a + workflow definition containing many template variables as these are filled + in these files. + + .. _The Workflow Contact File: The Workflow Contact File -------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^ At start-up, :term:`schedulers ` write a :term:`contact file` ``$HOME/cylc-run/WORKFLOW/.service/contact`` that records workflow host, @@ -186,7 +209,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 ` and the client, From 4a43f52901655253e1ad04d397f4b1e93cec645b Mon Sep 17 00:00:00 2001 From: Tim Pillinger <26465611+wxtim@users.noreply.github.com> Date: Fri, 19 Nov 2021 11:02:30 +0000 Subject: [PATCH 2/4] Update src/user-guide/running-workflows/running-workflows.rst Co-authored-by: Hilary James Oliver --- src/user-guide/running-workflows/running-workflows.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/user-guide/running-workflows/running-workflows.rst b/src/user-guide/running-workflows/running-workflows.rst index 260f88b167..9d17c1135e 100644 --- a/src/user-guide/running-workflows/running-workflows.rst +++ b/src/user-guide/running-workflows/running-workflows.rst @@ -171,7 +171,7 @@ 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 +Files Created at Workflow Start ------------------------------- Configuration Logs From c7ddb6d55c8ae03e6e747aa1455e8ff8ffe82a80 Mon Sep 17 00:00:00 2001 From: Tim Pillinger <26465611+wxtim@users.noreply.github.com> Date: Fri, 19 Nov 2021 11:02:45 +0000 Subject: [PATCH 3/4] Update src/user-guide/running-workflows/running-workflows.rst Co-authored-by: Hilary James Oliver --- src/user-guide/running-workflows/running-workflows.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/user-guide/running-workflows/running-workflows.rst b/src/user-guide/running-workflows/running-workflows.rst index 9d17c1135e..0b94e410a2 100644 --- a/src/user-guide/running-workflows/running-workflows.rst +++ b/src/user-guide/running-workflows/running-workflows.rst @@ -177,8 +177,8 @@ Files Created at Workflow Start Configuration Logs ^^^^^^^^^^^^^^^^^^ -At startup a folder ``log/flow-config`` is created where the flow configuration -is recorded, with all templating expanded: +At startup a folder ``log/flow-config`` is created to record the workflow configuration, +with all templating expanded: - ``flow-processed.cylc`` - A record of the current workflow configuration with templating expanded, but without being fully parsed: Duplicate sections From 8d390320cd22eb90404105c7a95d63876a27d595 Mon Sep 17 00:00:00 2001 From: Tim Pillinger <26465611+wxtim@users.noreply.github.com> Date: Fri, 19 Nov 2021 11:03:13 +0000 Subject: [PATCH 4/4] Apply suggestions from code review Co-authored-by: Hilary James Oliver --- .../running-workflows/running-workflows.rst | 14 +++++--------- 1 file changed, 5 insertions(+), 9 deletions(-) diff --git a/src/user-guide/running-workflows/running-workflows.rst b/src/user-guide/running-workflows/running-workflows.rst index 0b94e410a2..9964470dc6 100644 --- a/src/user-guide/running-workflows/running-workflows.rst +++ b/src/user-guide/running-workflows/running-workflows.rst @@ -180,18 +180,14 @@ Configuration Logs At startup a folder ``log/flow-config`` is created to record the workflow configuration, with all templating expanded: -- ``flow-processed.cylc`` - A record of the current workflow configuration - with templating expanded, but without being fully parsed: Duplicate sections - will not be merged. -- ``-`` - A record of the config at - the time a workflow was started, restarted or reloaded, parsed by Cylc: - Duplicate sections will be merged. +- ``flow-processed.cylc`` - the current workflow configuration + with templating expanded, and duplicate sections unmerged. +- ``-`` - the config at each time the workflow + was started, restarted, or reloaded; with duplicate sections merged. .. note:: - These are particularly useful files to look at if you are working with a - workflow definition containing many template variables as these are filled - in these files. + Look at these files to see the result of templating in the workflow config. .. _The Workflow Contact File: