Skip to content

Commit 01e5a0f

Browse files
committed
docs: document global= configuration option
Add documentation for the new global= option in both the configuration options table and the CMake options section. Update the example configuration to demonstrate usage.
1 parent 2e0be2a commit 01e5a0f

1 file changed

Lines changed: 3 additions & 1 deletion

File tree

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,7 @@ CMake option | Default
4949
`-DSLURM_PLUGSTACK_CONF_D=...` | `${SLURM_SYSCONFDIR}/plugstack.conf.d` | Slurm plugstack conf dir
5050
`-DPLUGIN_DEFAULT_ARG=...` | `""` | Plugin default= arg
5151
`-DPLUGIN_BIND_ARG=...` | `${SLURM_SYSCONFDIR},/var/spool/slurm,/var/run/munge` | Plugin bind= arg
52+
`-DPLUGIN_GLOBAL_ARG=...` | `""` | Plugin global= arg
5253
`-DPLUGIN_EXTRA_ARGS=...` | `""` | Plugin args= arg
5354
`-DSLURM_INCLUDE_DIR=...` | Detected by CMake, typically `/usr/include` | Slurm include dir passed to compiler via `-I` so `#include <slurm/spank.h>` resolves
5455
`-DCMAKE_INSTALL_LIBEXECDIR=...` | `libexec` on RHEL-based systems | FHS "internal binaries" directory [^sSrfT]
@@ -82,7 +83,7 @@ include /etc/slurm/plugstack.conf.d/*.conf'
8283
EOF
8384
# reference the path to the plug-in and the wrapper script
8485
cat > /etc/slurm/plugstack.conf.d/singularity-exec.conf <<EOF
85-
required /usr/lib64/slurm/singularity-exec.so default= script=/usr/libexec/slurm-singularity-wrapper.sh bind= args=disabled
86+
required /usr/lib64/slurm/singularity-exec.so default= script=/usr/libexec/slurm-singularity-wrapper.sh bind= global= args=disabled
8687
EOF
8788
```
8889

@@ -95,6 +96,7 @@ Option | Description
9596
`default=<path>` | Path to the Singularity container launched by default. If this is set user require to explicitly use an empty `--singularity-container=` option to prevent the start of a container.
9697
`script=<path>` | Path to the wrapper script which consumes the input arguments and environment variables set by the plugin to launch the Singularity container.
9798
`bind=<spec>` | List of paths to bind-mount into the container by default. Please reference the section about [User-defined bind paths][95] in the Singularity User Documentation [^E9F6O].
99+
`global=<options>` | List of [global command-line options][93] passed to the `singularity` command itself (e.g., `--silent`, `--quiet`). Equivalent to using the environment variable `SLURM_SINGULARITY_GLOBAL`.
98100
`args=<string>` | List of [command-line arguments][94] passed to `singularity exec`. Disable support for this feature by setting `args=disabled`. This will prompt an error for an unrecognized option if the user adds the `--singularity-args=` option. Use an empty string `args=""` to enable support for singularity arguments without a default configuration. Supply default for all users by adding a list of options i.e. `args="--home /network/$USER"`
99101

100102
Passing `-DINSTALL_PLUGSTACK_CONF=ON` to the CMake configure command will automate the above configuration.

0 commit comments

Comments
 (0)