Skip to content

Commit d4bb72a

Browse files
scheduler: document localhost platform
1 parent 4ea3db8 commit d4bb72a

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

src/user-guide/writing-workflows/scheduler.rst

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -230,3 +230,20 @@ Example:
230230
.. cylc-scope::
231231

232232
For more information see: :cylc:conf:`global.cylc[scheduler][run hosts]ranking`.
233+
234+
Platform Configuration
235+
^^^^^^^^^^^^^^^^^^^^^^
236+
237+
From the perspective of a running :term:`scheduler` ``localhost`` is the
238+
scheduler host.
239+
240+
The ``localhost`` platform is configured by
241+
:cylc:conf:`global.cylc[platforms][localhost]`.
242+
243+
It configures:
244+
245+
* Jobs that run on the ``localhost`` platform. I.E. any jobs which have
246+
:cylc:conf:`[runtime][<namespace>]platform=localhost` or which don't have a
247+
platform configured.
248+
* Connections to the scheduler hosts (e.g. the
249+
:cylc:conf:`ssh command <global.cylc[platforms][<platform name>]ssh command>`).

0 commit comments

Comments
 (0)