diff --git a/docs/_templates/configurator.html b/docs/_templates/configurator.html new file mode 100644 index 0000000000..6a8b006060 --- /dev/null +++ b/docs/_templates/configurator.html @@ -0,0 +1,313 @@ +{% extends "layout.html" %} +{% set title = 'PRRTE DVM Configuration Tool' %} +{% block body %} + + + + + + +PRRTE DVM Configuration Tool + + + + + + +
+

PRRTE Version v{{ release }} DVM Configuration Tool

+

This configuration tool is intended to help system administrators create +a PRRTE configuration file that sets important configuration parameters.

+ +

While every attempt is made to maintain compatibility of the PRRTE +configuration tool and options across versions, we recommend that the +configuration file be built using the tool distributed with the version +being installed on your cluster. Some parameters will be set to default +values, but you can manually edit the resulting prte.conf file as desired +for greater flexibility. See the PRRTE documentation at https://docs.prrte.org, +or your locally generated docs (if available), for more +details about the configuration parameters for this version.

+ +

Note that while PRRTE daemons create log files and other files as needed, +they treat the lack of parent directories (e.g., the specified "DVMTempDir") +as a fatal error. This prevents the daemons from running if critical file +systems are not mounted.

+ +

After you have filled in the fields of interest, use the +"Submit" button on the bottom of the page to display the resulting +prte.conf file. It will appear on your web browser. Save the file +in text format as prte.conf for use by the DVM. + +

NOTE: Hostname values should not be specified as fully qualified domain +names (e.g. use foo rather than foo.bar.com). +

+ +

NOTE: This configuration file must be installed as prte.conf in the +etc directory under the PRRTE installation location on all nodes in your cluster. +For example, if PRRTE was installed in /prrte, then the configuration file +must be stored as /prrte/etc/prte.conf so that all prted daemons can find it. +

+ +

Supported Options

+The following options are supported by PRRTE v{{ release }}. + +

Bootstrap Options

+ +ClusterName: +
+The name of the cluster upon which the DVM is executing. This is used by PRRTE +to form the namespace for the DVM daemons, which is taken as -prte-dvm. +Using different names for each of your clusters is important if you use a single +database to record information from multiple PRRTE-managed clusters. +
+
+ +DVMControllerHost: +
+The host upon which the DVM controller will be executing. The prted that +finds itself booting onto this host will declare itself to be the system controller +and will initialize itself accordingly. +
+
+ +DVMControllerPort: +
+The TCP port upon which the +DVM controller will be listening for connections from its prted daemons +on the remaining system nodes. +
+
+ +PRTEDPort: +
+The TCP port upon which each +prted daemon will be listening for connections from its peer daemons +on the other system nodes. +
+
+ +DVMNodes: +
+Provides a regular expression +identifying the nodes that upon which user applications can run. IP addresses can +be provided in place of hostnames if desired.The regular expression can consist of +a simple comma-delimited list of hostnames, or a comma-delimited list of hostname +ranges (e.g., "linux0,linux[2-10]"), or a PMIx "native" regular expression. +
+
+ + +

Operational Options

+ +DVMTempDir: +
+The temporary directory that the +DVM daemons and controller are to use as the base for their session directories. +Working files/directories for the DVM will be placed under this location. +
+
+ +SessionTmpDir: +
+The temporary directory that +the DVM daemons are to use as the base for session directories for all +application sessions. Working files for each session will be placed under +this location, separated out into a directory for each session. +
+
+ +

Logging Options

+ +ControllerLogJobState: +
+ + +
+Directs the DVM +controller to log each DVM-launched job state transition. Log entry includes +the namespace of the job, the state to which it is transitioning, and the +date/time stamp when the transition was ordered. +
+
+ +ControllerLogProcState: +
+ + +
+Directs the DVM +controller to log each process (in a DVM-launched job) state transition. +Log entry includes the namespace and rank of the process, the state to +which it is transitioning, and the date/time stamp when the transition was +ordered. +
+
+ +ControllerLogPath: +
+Path to where the logs are to be written. If a relative path is provided, +then the directory will be created under the DVMTempDir location. The +path defaults to the specified SessionTmpDir in the absence of any input +to this field. The log filename is formatted as prtectrlr--log. +
+
+ +PRTEDLogJobState: +
+ + +
+Directs each prted +in the DVM to log each DVM-launched job state transition. Log entry includes +the namespace of the job, the state to which it is transitioning, and the +date/time stamp when the transition was ordered. +
+
+ +PRTEDLogProcState: +
+ + +
+Directs each prted +in the DVM to log each process (in a DVM-launched job) state transition. +Log entry includes the namespace and rank of the process, the state to +which it is transitioning, and the date/time stamp when the transition was +ordered. +
+
+ +PRTEDLogPath: +
+Path to where the logs are to be written. If a relative path is provided, +then the directory will be created under the DVMTempDir location. The +path defaults to the specified SessionTmpDir in the absence of any input +to this field. The log filename is formatted as prted--log. + +
+
+ + +
+{% endblock %}