slurm-web gen-jwt-key command

This page describes all slurm-web gen-jwt-key command options available, with many examples and descriptions of its behaviours. The content of the page this also available in slurm-web-gen-jwt-key(1) manpage after installation.

Synopsis

slurm-web gen-jwt-key [GENERAL OPTIONS]

Description

Slurm-web is a web dashboard for Slurm HPC cluster. Its architecture is based on two components: the gateway and agents. Both of these components authentication user requests with JWT and signing key. This command generates the JWT signing key file and protect it with restrictive permissions.

When run as root, the generated key file is assigned to the slurm-web system user. When run as a non-root user, the key file is created with the caller’s ownership and no ownership or ACL changes are applied. The parent directory of the JWT key path must already exist.

General Options

-h, --help

Show this help message and exit.

-v, --version

Show Slurm-web version number and exit.

--debug

Enable debug mode with more debug messages in logs.

--log-flags=FLAGS

Libraries for which logs (except debug messages) are enabled. Multiple values can be selected among slurmweb, rfl, racksdb, werkzeug, urllib3. Special value ALL enable logs for all libraries. Default value is ALL. This option can be used to filter out logs of too verbose libraries.

--log-component=COMPONENT

Add COMPONENT as prefix of all log entries.

--debug-flags=FLAGS

Libraries for which debug logs are enabled when --debug option is used. Multiple values can be selected among slurmweb, rfl, racksdb, werkzeug, urllib3. Special value ALL enable debug logs for all libraries. Default value is slurmweb.

--conf-defs=DEFS

Path to Slurm-web gateway YAML configuration definition file. Default value is /usr/share/slurm-web/conf/gateway.yml.

--conf=CONF

Path to Slurm-web gateway site configuration file. Default value is /etc/slurm-web/gateway.ini.

--set-ownership

Require root and assign the generated key file to the slurm-web system user. Exit with an error when not run as root.

--with-slurm

Add read ACL permission on JWT signing key for slurm system user as well. This option requires root.

Exit status

0

slurm-web gen-jwt-key has processed command with success.

1

slurm-web gen-jwt-key encountered an error.