CLI reference
apolo-flow
Usage:
Options:
--config PATH
Path to a directory with .apolo folder inside, automatic lookup is performed if not set (default)
-v, --verbose
Give more output. Option is additive, and can be used up to 2 times.
-q, --quiet
Give less output. Option is additive, and can be used up to 2 times.
--show-traceback
Show python traceback on error, useful for debugging the tool.
--version
Show the version and exit.
--help
Show this message and exit.
Command Groups:
Output shell completion code.
Commands:
Start a batch.
List existing bakes.
Build an image.
Cancel a bake.
Clean volume.
Clear cache.
Completely remove flow with all related entities
Download volume.
Initialize a flow from a selected template.
Inspect a bake.
Kill a job.
Print logs.
Create all remote folders for volumes.
List all jobs
Start a batch.
Run a job.
Show output of baked task.
Show job status.
Upload volume.
apolo-flow completion
Output shell completion code.
Usage:
Options:
--help
Show this message and exit.
Commands:
Provide instruction for shell completion generation.
Automatically patch shell configuration profile to enable completion
apolo-flow completion generate
Provide instruction for shell completion generation.
Usage:
Options:
--help
Show this message and exit.
apolo-flow completion patch
Automatically patch shell configuration profile to enable completion
Usage:
Options:
--help
Show this message and exit.
apolo-flow bake
Start a batch.
Run BATCH pipeline remotely on the cluster.
Usage:
Options:
--local-executor
Run primary job locally
-p, --param <TEXT TEXT>...
Set params of the batch config
-n, --name NAME
Optional bake name
--meta-from-file FILE
File with params for batch.
-t, --tag TAG
Optional bake tag, multiple values allowed
--help
Show this message and exit.
apolo-flow bakes
List existing bakes.
Usage:
Options:
-t, --tag TAG
Filter out bakes by tag (multiple option)
--since DATE_OR_TIMEDELTA
Show bakes created after a specific date (including). Use value of format '1d2h3m4s' to specify moment in past relatively to current time.
--until DATE_OR_TIMEDELTA
Show bakes created before a specific date (including). Use value of format '1d2h3m4s' to specify moment in past relatively to current time.
--recent-first / --recent-last
Show newer bakes first or last
--help
Show this message and exit.
apolo-flow build
Build an image.
Assemble the IMAGE remotely and publish it.
Usage:
Options:
-F, --force-overwrite
Build even if the destination image already exists.
--help
Show this message and exit.
apolo-flow cancel
Cancel a bake.
Cancel a bake execution by stopping all started tasks.
Usage:
Options:
-a, --attempt INTEGER
Attempt number, the last attempt by default
--help
Show this message and exit.
apolo-flow clean
Clean volume.
Clean remote files on VOLUME, use clean ALL for cleaning up all volumes.
Usage:
Options:
--help
Show this message and exit.
apolo-flow clear-cache
Clear cache.
Use apolo-flow clear-cache <BATCH> for cleaning up the cache for BATCH; Use apolo-flow clear-cache <BATCH> <TASK_ID> for cleaning up the cache for TASK_ID in BATCH;
apolo-flow clear-cache ALL clears all caches.
Usage:
Options:
--help
Show this message and exit.
apolo-flow delete-flow
Completely remove flow with all related entities
Usage:
Options:
--help
Show this message and exit.
apolo-flow download
Download volume.
Download remote files to local for VOLUME, use download ALL for downloading all volumes.
Usage:
Options:
--help
Show this message and exit.
apolo-flow init
Initialize a flow from a selected template.
Creates required storage as well.
Usage:
Options:
--help
Show this message and exit.
apolo-flow inspect
Inspect a bake.
Display a list of started/finished tasks of BAKE_ID.
Usage:
Options:
-a, --attempt INTEGER
Attempt number, the last attempt by default
-o, --output-graph FILE
A path to Graphviz (DOT) file. Autogenerated from BAKE_ID and attempt number by default
--dot
Save DOT file with tasks statuses.
Save PDF file with tasks statuses.
--view
Open generated PDF file with tasks statuses.
--help
Show this message and exit.
apolo-flow kill
Kill a job.
Kill JOB-ID, use kill ALL for killing all jobs.
Usage:
Options:
--help
Show this message and exit.
apolo-flow logs
Print logs.
Display logs for JOB-ID
Usage:
Options:
--help
Show this message and exit.
apolo-flow mkvolumes
Create all remote folders for volumes.
Usage:
Options:
--help
Show this message and exit.
apolo-flow ps
List all jobs
Usage:
Options:
--help
Show this message and exit.
apolo-flow restart
Start a batch.
Run BATCH pipeline remotely on the cluster.
Usage:
Options:
-a, --attempt INTEGER
Attempt number, the last attempt by default
--local-executor
Run primary job locally
--from-failed / --no-from-failed
Restart from the point of failure
--help
Show this message and exit.
apolo-flow run
Run a job.
RUN job JOB-ID or ATTACH to it if the job is already running
For multi-jobs an explicit job suffix can be used with explicit job arguments.
Usage:
Options:
-s, --suffix TEXT
Optional suffix for multi-jobs
-p, --param <TEXT TEXT>...
Set params of the batch config
--dry-run
Print run command instead of starting job.
--help
Show this message and exit.
apolo-flow show
Show output of baked task.
Display a logged output of TASK_ID from BAKE_ID.
Usage:
Options:
-a, --attempt INTEGER
Attempt number, the last attempt by default
-r, --raw / -R, --no-raw
Raw mode disables the output postprocessing (the output is processed by default)
--help
Show this message and exit.
apolo-flow status
Show job status.
Print status for JOB-ID
Usage:
Options:
--help
Show this message and exit.
apolo-flow upload
Upload volume.
Upload local files to remote for VOLUME, use upload ALL for uploading all volumes.
Usage:
Options:
--help
Show this message and exit.
Last updated