@@ -30,7 +30,7 @@ Flux Architecture
3030A *Flux instance * consists of one or more Flux brokers communicating over a
3131tree-based overlay network. Most of Flux's distributed systems and services
3232that aren't directly associated with a running job are embedded in the
33- :core: man1: `flux-broker ` executable or its dynamically loaded plugins.
33+ :man1: `flux-broker ` executable or its dynamically loaded plugins.
3434
3535Flux may be used in *single-user mode *, where a Flux instance is launched as
3636a parallel job, and the *instance owner * (the user that submitted the parallel
@@ -87,54 +87,54 @@ time the primary component types are
8787broker modules
8888 Each broker module runs in its own thread as part of the broker executable,
8989 communicating with other components using messages. Broker modules are
90- dynamically loadable with the :core: man1: `flux-module ` command. Core
90+ dynamically loadable with the :man1: `flux-module ` command. Core
9191 services like the KVS, job manager, and scheduler are implemented using
9292 broker modules.
9393
9494jobtap plugins
9595 The job manager orchestrates a job's life cycle. Jobtap plugins extend the
9696 job manager, arranging for callbacks at different points in the job life
9797 cycle. Jobtap plugins may be dynamically loaded with the
98- :core: man1: `flux-jobtap ` command. An example of a jobtap plugin is the Flux
98+ :man1: `flux-jobtap ` command. An example of a jobtap plugin is the Flux
9999 accounting multi-factor priority plugin, which updates a job's priority value
100100 when it enters the PRIORITY state.
101101
102102shell plugins
103- When a job is started, the :core: man1: `flux-shell ` is the process parent
103+ When a job is started, the :man1: `flux-shell ` is the process parent
104104 of job tasks on each node. Shell plugins extend the job environment and
105105 can be configured on a per-job basis using the ``--setopt `` option of
106- :core: man1: `flux-run ` and related job submission commands. ``affinity ``,
106+ :man1: `flux-run ` and related job submission commands. ``affinity ``,
107107 ``pmi ``, and ``pty `` are examples of Flux shell plugins.
108108
109109connectors
110110 Flux commands open a connection to a particular Flux instance by specifying
111111 a URI. The *scheme * portion of the URI may refer to a *native * connection
112112 method such as ``local `` or ``ssh ``. Native connection methods are
113- implemented as plugins called *connectors *. See :core: man3: `flux_open `.
113+ implemented as plugins called *connectors *. See :man3: `flux_open `.
114114
115115URI resolver plugins
116116 Other URI schemes must be *resolved * to a native form before they can be used.
117117 Resolvers for new schemes may be added as plugins. For example, the ``lsf ``
118118 resolver plugin enables LSF users to connect to Flux instances running as LSF
119- jobs by specifying a ``lsf:JOBID `` URI. See :core: man1: `flux-uri `.
119+ jobs by specifying a ``lsf:JOBID `` URI. See :man1: `flux-uri `.
120120
121121validator plugins
122122 Jobs may be rejected at ingest if their jobspec fails one of a set of
123123 configured validator plugins. The basic validator ensures the jobspec
124124 conforms to the jobspec specification. The ``feasibility `` plugin rejects
125125 job that the scheduler determines would be unable to run given the instance's
126126 resource set. The ``require-instance `` plugin rejects jobs that do not run
127- in a new Flux instance. See :core: man5: `flux-config-ingest `.
127+ in a new Flux instance. See :man5: `flux-config-ingest `.
128128
129129frobnicator plugins
130130 The frobnicator allows a set of configured plugins to modify jobspec at
131131 submission time. For example the ``defaults `` plugin sets configured default
132132 values for jobspec attributes such as *duration * and *queue *. See
133- :core: man5: `flux-config-ingest `.
133+ :man5: `flux-config-ingest `.
134134
135135Independently developed Flux components are generally packaged and versioned
136136separately. Each package may provide one or more of the above components
137- as well as man pages and :core: man1: `flux ` subcommands. At this stage of Flux
137+ as well as man pages and :man1: `flux ` subcommands. At this stage of Flux
138138development, it is good practice to combine only contemporaneously released
139139components as the interfaces are not stable yet.
140140
@@ -223,7 +223,7 @@ drain request messages that have the owner role. Similarly, any job can be
223223canceled by a cancel request message with the owner role, but in addition, jobs
224224can be canceled by guests whose message userid matches the target job userid.
225225
226- A Flux job is launched when brokers launch one :core: man1: `flux-shell ` per
226+ A Flux job is launched when brokers launch one :man1: `flux-shell ` per
227227node with the credentials of the user that submitted the job. When that is a
228228guest user, Flux employs a setuid helper called the :security:man8: `flux-imp `
229229to launch the shells with the guest credentials. The shells in turn launch
@@ -351,7 +351,7 @@ into multiple files. In the examples below, one file per configuration space
351351is used.
352352
353353For more information on the three configuration spaces, please refer to
354- :core: man5: `flux-config `, :security:man5: `flux-config-security `, and
354+ :man5: `flux-config `, :security:man5: `flux-config-security `, and
355355:security:man5: `flux-config-security-imp `.
356356
357357Configuring flux-security
@@ -435,7 +435,7 @@ Configuring the Network Certificate
435435
436436Overlay network security requires a certificate to be distributed to all nodes.
437437It should be readable only by the ``flux `` user. To create a new certificate,
438- run :core: man1: `flux-keygen ` as the ``flux `` user, then copy the result to
438+ run :man1: `flux-keygen ` as the ``flux `` user, then copy the result to
439439``/etc/flux/system `` since the ``flux `` user will not have write access to
440440this location:
441441
@@ -547,11 +547,11 @@ Example file installed path: ``/etc/flux/system/conf.d/system.toml``
547547 match-policy = "lonodex"
548548 match-format = "rv1_nosched"
549549
550- See also: :core: man5: `flux-config-exec `, :core :man5: `flux-config-access `
551- :core: man5: `flux-config-bootstrap `, :core :man5: `flux-config-tbon `,
552- :core: man5: `flux-config-resource `, :core :man5: `flux-config-ingest `,
553- :core: man5: `flux-config-archive `, :core :man5: `flux-config-job-manager `,
554- :core: man5: `flux-config-policy `, :core :man5: `flux-config-kvs `,
550+ See also: :man5: `flux-config-exec `, :man5: `flux-config-access `
551+ :man5: `flux-config-bootstrap `, :man5: `flux-config-tbon `,
552+ :man5: `flux-config-resource `, :man5: `flux-config-ingest `,
553+ :man5: `flux-config-archive `, :man5: `flux-config-job-manager `,
554+ :man5: `flux-config-policy `, :man5: `flux-config-kvs `,
555555:sched:man5: `flux-config-sched-fluxion-qmanager `,
556556:sched:man5: `flux-config-sched-fluxion-resource `.
557557
@@ -674,7 +674,7 @@ these directories can be ignored and should be empty or nonexistent.
674674To run scripts from a different directory, use the ``-d, --exec-directory ``
675675option in the configured ``command ``.
676676
677- See also: :core: man5: `flux-config-job-manager `,
677+ See also: :man5: `flux-config-job-manager `,
678678:security:man5: `flux-config-security-imp `.
679679
680680Adding Job Request Validation
@@ -716,16 +716,16 @@ considered for scheduling.
716716
717717The ``require-instance `` plugin rejects jobs that do not start another
718718instance of Flux. That is, jobs are required to be submitted via tools
719- like :core: man1: `flux-batch ` and :core :man1: `flux-alloc `, or the equivalent.
720- For example, with this plugin enabled, a user running :core: man1: `flux-run `
719+ like :man1: `flux-batch ` and :man1: `flux-alloc `, or the equivalent.
720+ For example, with this plugin enabled, a user running :man1: `flux-run `
721721will have their job rejected with the message:
722722
723723.. code-block :: console
724724
725725 $ flux run -n 1000 myapp
726726 flux-run: ERROR: [Errno 22] Direct job submission is disabled for this instance. Please use the flux-batch(1) or flux-alloc(1) commands.
727727
728- See also: :core: man5: `flux-config-ingest `.
728+ See also: :man5: `flux-config-ingest `.
729729
730730Adding Queues
731731=============
@@ -770,7 +770,7 @@ Here is an example that puts these concepts together:
770770 requires = ["batch"]
771771 policy.limits.duration = "4h"
772772
773- When named queues are configured, :core: man1: `flux-queue ` may be used to
773+ When named queues are configured, :man1: `flux-queue ` may be used to
774774list them:
775775
776776.. code-block :: console
@@ -780,8 +780,8 @@ list them:
780780 debug: Job submission is enabled
781781 Scheduling is enabled
782782
783- See also: :core: man5: `flux-config-policy `, :core :man5: `flux-config-queues `,
784- :core: man5: `flux-config-resource `, :core :man1: `flux-queue `.
783+ See also: :man5: `flux-config-policy `, :man5: `flux-config-queues `,
784+ :man5: `flux-config-resource `, :man1: `flux-queue `.
785785
786786Policy Limits
787787=============
@@ -823,7 +823,7 @@ an example which implements duration and job size limits for two queues:
823823 policy.limits.job-size.max.nnodes = 16
824824 policy.limits.job-size.max.ncores = 128
825825
826- See also: :core: man5: `flux-config-policy `.
826+ See also: :man5: `flux-config-policy `.
827827
828828Use PAM to Restrict Access to Compute Nodes
829829===========================================
@@ -861,8 +861,8 @@ until their parent in the tree based overlay network is available.
861861
862862If Flux was not shut down properly, for example if the rank 0 broker
863863crashed or was killed, then Flux starts in a safe mode with job submission
864- and scheduling disabled. :core: man1: `flux-uptime ` shows the general state
865- of Flux, and :core: man1: `flux-startlog ` prints a record of Flux starts and
864+ and scheduling disabled. :man1: `flux-uptime ` shows the general state
865+ of Flux, and :man1: `flux-startlog ` prints a record of Flux starts and
866866stops, including any crashes.
867867
868868Stopping Flux
@@ -878,7 +878,7 @@ the following on the rank 0 node:
878878 This kills any running jobs, but preserves job history and the queue of
879879jobs that have been submitted but have not yet allocated resources.
880880This state is held in the ``content.sqlite `` that was configured above.
881- See also :core: man1: `flux-shutdown `.
881+ See also :man1: `flux-shutdown `.
882882
883883.. note ::
884884 ``flux-shutdown --gc `` should be used from time to time to perform offline
@@ -917,7 +917,7 @@ at job launch.
917917
918918.. warning ::
919919 Many configuration changes have no effect until the Flux broker restarts.
920- This should be assumed unless otherwise noted. See :core: man5: `flux-config `
920+ This should be assumed unless otherwise noted. See :man5: `flux-config `
921921 for more information.
922922
923923Viewing resource status
@@ -1045,7 +1045,7 @@ This queue can be managed using the ``flux-queue`` command.
10451045 drain Wait for queue to become empty.
10461046 idle Wait for queue to become idle.
10471047
1048- The queue may be listed with the :core: man1: `flux-jobs ` command.
1048+ The queue may be listed with the :man1: `flux-jobs ` command.
10491049
10501050Disabling job submission
10511051------------------------
@@ -1230,7 +1230,7 @@ of RANK may be listed with
12301230 Using ``flux ping `` and ``flux overlay parentof `` iteratively, one should
12311231be able to isolate the problem rank.
12321232
1233- See also :core: man1: `flux-overlay `, :core :man1: `flux-ping `.
1233+ See also :man1: `flux-overlay `, :man1: `flux-ping `.
12341234
12351235Systemd journal
12361236===============
0 commit comments