flux-config(1)
SYNOPSIS
DESCRIPTION
The flux config manipulates the Flux instance configuration.
COMMANDS
get
flux config get queries the TOML configuration. if NAME is unspecified, it dumps the entire configuration object. Otherwise, NAME is expected to be a period-delimited path name representing a TOML key. Return values are printed in string-encoded JSON form, except for string values, which are printed without quotes to simplify their use in shell scripts.
- -d, --default=VALUE
Substitute VALUE if NAME is not set in the configuration, and exit with a return code of zero.
- -q, --quiet
Suppress printing of errors if NAME is not set and
--defaultwas not specified. This may be convenient to avoid needing to redirect standard error in a shell script.
- -t, --type=TYPE
Require that the value has the specified type, or exit with a nonzero exit code. Valid types are string, integer, real, boolean, object, and array. In addition, types of fsd, fsd-integer, and fsd-real ensure that a value is a both a string and valid Flux Standard Duration. fsd prints the value in its human-readable, string form. fsd-integer and fsd-real print the value in integer and real seconds, respectively.
- -c, --config-path=PATH
Read configuration from PATH instead of fetching configuration from local broker. If PATH is a directory, then read all TOML files from that directory. If PATH is a file, then load configuration as JSON if the file extension is
.json, otherwise load the file as TOML. As a special case,system,security, andimpmay be used as shorthand for the compiled-in paths to system configuration objects.
set
flux config set updates the value of NAME in the current configuration. NAME is expected to be a period-delimited path name representing a TOML key. This command may only be used on the leader (rank 0) broker and is restricted to the instance owner
- -t, --type=TYPE
Specify the type of VALUE. Valid types are string, integer, real, boolean, object, array, and fsd. If the type is unspecified and NAME already has a value, the type of the existing value is used.
unset
flux config unset deletes NAME in the current configuration. NAME is expected to be a period-delimited path name representing a TOML key. This command may only be used on the leader (rank 0) broker and is restricted to the instance owner.
builtin
flux config builtin prints compiled-in Flux configuration values. See BUILTIN VALUES below for a list of builtin configuration key names. This command is available to all users.
Note
flux config get and flux config builtin refer to disjoint key namespaces. Flux behavior is determined by a combination of these values, flux-broker-attributes(7), and other factors. This disjoint configuration scheme is subject to change in future releases of Flux.
Note
flux config builtin uses a heuristic to determine if flux(1) was run from the flux-core source tree, and substitutes source tree specific values if found to be in tree. This enables Flux testing without requiring installation.
- --intree
Force flux config builtin to return in-tree paths.
- --installed
Force flux config builtin to return installed paths.
load
flux config load replaces the current configuration with an object read
from standard input (JSON or TOML), or from *.toml in PATH, if specified.
This command may only be used on the leader (rank 0) broker and is restricted
to the instance owner.
reload
flux config reload reloads the configuration from disk. This command may only be used on the leader (rank 0) broker and is restricted to the instance owner. It has no effect if the configuration has not changed.
On Flux instances started with systemd(1), systemctl reload flux invokes this command.
- --follower-noop
Do nothing if invoked on a follower broker. This is intended for the systemd unit file so that configuration management software can invoke systemctl reload flux without the need to special-case follower nodes.
Configuration changes do not have an immediate effect in all cases. For more information, refer to the CAVEATS section of flux-config(5).
BUILTIN VALUES
The following configuration keys may be printed with flux config builtin:
- rc1_path
The rc1 command used by flux-broker(1), unless overridden by the
broker.rc1_pathbroker attribute.- rc3_path
The rc3 command used by flux-broker(1), unless overridden by the
broker.rc1_pathbroker attribute.- shell_path
The path to the flux-shell(1) executable used by the exec service.
- shell_pluginpath
The search path used by flux-shell(1) to locate plugins, unless overridden by setting the
conf.shell_pluginpathbroker attribute.- shell_initrc
The initrc script path used by flux-shell(1), unless overridden by setting the
conf.shell_initrcbroker attribute.- jobtap_pluginpath
The search path used by the job manager to locate flux-jobtap-plugins(7).
- rundir
The configured
${runstatedir}/fluxdirectory.- confdir
The configured
${sysconfdir}/fluxdirectory.- libexecdir
The configured
${libexecdir}/fluxdirectory.- lua_cpath_add
Consulted by flux(1) when setting the
LUA_CPATHenvironment variable.- lua_path_add
Consulted by flux(1) when setting the
LUA_PATHenvironment variable.- python_path
Consulted by flux(1) when setting the
PYTHONPATHenvironment variable.- man_path
Consulted by flux(1) when setting the
MANPATHenvironment variable.- exec_path
Consulted by flux(1) when setting the
FLUX_EXEC_PATHenvironment variable.- connector_path
Consulted by flux(1) when setting the
FLUX_CONNECTOR_PATHenvironment variable.- module_path
Consulted by flux(1) when setting the
FLUX_MODULE_PATHenvironment variable.- pmi_library_path
Consulted by the flux-shell(1) pmi plugin when setting the
FLUX_PMI_LIBRARY_PATHenvironment variable.- cmdhelp_pattern
Used by flux(1) to generate a list of common commands when run without arguments.
no_docs_path
EXAMPLES
$ flux config get --type=fsd-integer tbon.tcp_user_timeout
60
$ flux config set --type=fsd tbon.torpid_min 5m
RESOURCES
Flux: http://flux-framework.org
Flux RFC: https://flux-framework.readthedocs.io/projects/flux-rfc
Issue Tracker: https://github.com/flux-framework/flux-core/issues