1
1
2
2
.. _AdminGuide.PlatformConfigs :
3
3
4
+ Platform Configuration
5
+ ======================
6
+
4
7
Writing Platform Configurations
5
- ===============================
8
+ -------------------------------
6
9
7
10
.. versionadded :: 8.0.0
8
11
@@ -16,7 +19,7 @@ Writing Platform Configurations
16
19
.. _ListingAvailablePlatforms :
17
20
18
21
Listing available platforms
19
- ---------------------------
22
+ ^^^^^^^^^^^^^^^^^^^^^^^^^^^
20
23
21
24
If you are working on an institutional network platforms may already
22
25
have been configured for you.
@@ -32,7 +35,7 @@ To see the full configuration of available platforms::
32
35
This is equivalent to ``cylc config -i 'platforms' -i 'platform groups' ``
33
36
34
37
What Are Platforms?
35
- -------------------
38
+ ^^^^^^^^^^^^^^^^^^^
36
39
37
40
Platforms define settings, most importantly:
38
41
@@ -42,7 +45,7 @@ Platforms define settings, most importantly:
42
45
- An ``install target `` for Cylc to install task job files on.
43
46
44
47
Why Were Platforms Introduced?
45
- ------------------------------
48
+ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
46
49
47
50
- Allow a compute cluster with multiple login nodes to be treated as a single
48
51
unit.
@@ -54,7 +57,7 @@ Why Were Platforms Introduced?
54
57
.. _Install Targets :
55
58
56
59
What Are Install Targets?
57
- -------------------------
60
+ ^^^^^^^^^^^^^^^^^^^^^^^^^
58
61
59
62
Install targets represent file systems. More than one platform can use the
60
63
same file system. It defaults to the name of the platform.
@@ -69,10 +72,10 @@ Each cluster would be both a platform, and have its own install target.
69
72
70
73
71
74
Example Platforms
72
- =================
75
+ -----------------
73
76
74
77
On the Scheduler Host (Cylc Server)
75
- -----------------------------------
78
+ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
76
79
77
80
- **There is a built in localhost platform **
78
81
@@ -84,7 +87,7 @@ If a job doesn't set a platform it will run on the Cylc scheduler host
84
87
using a default ``localhost `` platform.
85
88
86
89
Simple Remote Platform
87
- ----------------------
90
+ ^^^^^^^^^^^^^^^^^^^^^^
88
91
89
92
- **Platforms don't need to be complicated **
90
93
- **``install target`` specifies a file system for the task using that platform **
@@ -104,7 +107,7 @@ Simple Remote Platform
104
107
105
108
106
109
Cluster with Multiple Login Nodes
107
- ---------------------------------
110
+ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
108
111
109
112
- **Platforms can group multiple hosts together. **
110
113
@@ -130,7 +133,7 @@ Since the platform hosts do not share a file system with the scheduler
130
133
host we need to ask Cylc to retrieve job logs.
131
134
132
135
Background Jobs on Cluster with Other Options
133
- ---------------------------------------------
136
+ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
134
137
135
138
- **Platforms are the unique combination of all settings. **
136
139
@@ -162,7 +165,7 @@ Background Jobs on Cluster with Other Options
162
165
163
166
164
167
Submit PBS Jobs from Localhost
165
- ------------------------------
168
+ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
166
169
167
170
- **Platforms can share hosts and not share batch systems. **
168
171
@@ -195,7 +198,7 @@ As a result the above configuration can be simplified to:
195
198
196
199
197
200
Two Similar Clusters
198
- --------------------
201
+ ^^^^^^^^^^^^^^^^^^^^
199
202
200
203
- **Platform groups allow users to ask for jobs to be run on any
201
204
suitable computer. **
@@ -235,7 +238,7 @@ Two Similar Clusters
235
238
236
239
237
240
Preferred and Backup Hosts and Platforms
238
- ----------------------------------------
241
+ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
239
242
240
243
- **You can set how hosts are selected from platforms. **
241
244
- **You can set how platforms are selected from groups. **
@@ -272,7 +275,7 @@ Preferred and Backup Hosts and Platforms
272
275
Random is the default selection method.
273
276
274
277
Lots of desktop computers
275
- -------------------------
278
+ ^^^^^^^^^^^^^^^^^^^^^^^^^
276
279
277
280
- **Platform names are regular expressions. **
278
281
@@ -309,7 +312,7 @@ platform. Job files can be installed on the workflow host.
309
312
used in both.
310
313
311
314
Platform with no ``$HOME `` directory
312
- ------------------------------------
315
+ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
313
316
314
317
.. admonition :: Scenario
315
318
0 commit comments