Command-line interface#
gafaelfawr#
Administrative command-line interface for gafaelfawr.
gafaelfawr [OPTIONS] COMMAND [ARGS]...
Options
- --version#
Show the version and exit.
audit#
Run a consistency check on Gafaelfawr’s data stores.
Any problems found will be reported to Slack.
gafaelfawr audit [OPTIONS]
Options
- --fix#
Fix issues found, if possible
- --config-path <config_path>#
Application configuration file.
Environment variables
- GAFAELFAWR_CONFIG_PATH
Provide a default for
--config-path
delete-all-data#
Delete all data from Redis and the database.
Intended for destructive upgrades, such as when switching from one upstream authentication provider to another when all of the usernames will change. This does not delete or reset UID and GID assignments from Firestore.
gafaelfawr delete-all-data [OPTIONS]
Options
- --config-path <config_path>#
Application configuration file.
Environment variables
- GAFAELFAWR_CONFIG_PATH
Provide a default for
--config-path
generate-key#
Generate a new RSA key pair and print the private key.
gafaelfawr generate-key [OPTIONS]
generate-session-secret#
Generate a new Gafaelfawr session secret.
gafaelfawr generate-session-secret [OPTIONS]
generate-token#
Generate an encoded token (such as the bootstrap token).
gafaelfawr generate-token [OPTIONS]
help#
Show help for any command.
gafaelfawr help [OPTIONS] [TOPIC]
Arguments
- TOPIC#
Optional argument
init#
Initialize the database storage.
gafaelfawr init [OPTIONS]
Options
- --config-path <config_path>#
Application configuration file.
Environment variables
- GAFAELFAWR_CONFIG_PATH
Provide a default for
--config-path
maintenance#
Perform background maintenance.
gafaelfawr maintenance [OPTIONS]
Options
- --config-path <config_path>#
Application configuration file.
Environment variables
- GAFAELFAWR_CONFIG_PATH
Provide a default for
--config-path
openapi-schema#
Generate the OpenAPI schema.
gafaelfawr openapi-schema [OPTIONS]
Options
- --add-back-link#
Add back link (used when generating application documentation)
- --output <output>#
Output path (output to stdout if not given).
run#
Run the application (for testing only).
gafaelfawr run [OPTIONS]
Options
- --port <port>#
Port to run the application on.
Kubernetes operator#
The Kubernetes operator is not started through the gafaelfawr command-line entry point because Kopf wants to have full control over how it’s run.
Instead, to start the operator, use:
kopf run -A --log-format=json -m gafaelfawr.operator