Command-line interface#
nublado#
Command-line interface for nublado.
Usage
nublado [OPTIONS] COMMAND [ARGS]...
Options
- --version#
Show the version and exit.
help#
Show help for any command.
Usage
nublado help [OPTIONS] [TOPIC] [SUBTOPIC]
Arguments
- TOPIC#
Optional argument
- SUBTOPIC#
Optional argument
inithome#
Provision user home directory.
All of NUBLADO_UID, NUBLADO_GID, and NUBLADO_HOME must be set.
Usage
nublado inithome [OPTIONS]
purger#
Purge files, or plan future purge.
Usage
nublado purger [OPTIONS] COMMAND [ARGS]...
Options
- -x, --dry-run#
Do not act, but report what would be done
- -p, --policy-file <policy_file>#
Purger policy configuration file
- -c, --config-file <config_file>#
Application configuration file
- -d, --debug#
Enable debug logging
Environment variables
- DEBUG
Provide a default for
--debug
execute#
Make a plan, report, and purge files.
Usage
nublado purger execute [OPTIONS]
Options
- -x, --dry-run#
Do not act, but report what would be done
- -p, --policy-file <policy_file>#
Purger policy configuration file
- -c, --config-file <config_file>#
Application configuration file
- -d, --debug#
Enable debug logging
Environment variables
- DEBUG
Provide a default for
--debug
report#
Report what files would be purged.
Usage
nublado purger report [OPTIONS]
Options
- -x, --dry-run#
Do not act, but report what would be done
- -p, --policy-file <policy_file>#
Purger policy configuration file
- -c, --config-file <config_file>#
Application configuration file
- -d, --debug#
Enable debug logging
Environment variables
- DEBUG
Provide a default for
--debug
warn#
Make a plan for some time in the future, and report as if it were that time.
Usage
nublado purger warn [OPTIONS]
Options
- -t, --future-duration <future_duration>#
Duration from now to future time to build a plan for
- -x, --dry-run#
Do not act, but report what would be done
- -p, --policy-file <policy_file>#
Purger policy configuration file
- -c, --config-file <config_file>#
Application configuration file
- -d, --debug#
Enable debug logging
Environment variables
- DEBUG
Provide a default for
--debug
Controller#
The Nublado controller doesn’t have a command-line interface.
It should be started via uvicorn, using nublado.controller.main:create_app as the entry point, with host 0.0.0.0 and port 8080.
Filesystem Administration#
The filesystem administration function is simply to start the container with root privilege and then keep the container alive while allowing kubectl exec access to the pod.
Typically it will be started with an innocuous command such as tail -f /dev/null.
Repository Cloning#
The repository cloner is not started through the nublado command-line interface.
Instead, the shell entrypoint will be invoked directly as /usr/local/bin/repo-cloner.sh (typically from a Kubernetes CronJob).