CLI Reference
Last updated
Last updated
Auxiliary scripts and recipes for automating routine tasks.
Usage:
Options:
| Name | Description |
|---|---|
Command Groups:
| Usage | Description |
|---|---|
Commands:
| Usage | Description |
|---|---|
Configuration operations.
Usage:
Options:
Commands:
Generate docker auth for accessing remote registry.
Usage:
Options:
Save docker auth file for accessing platform registry.
Usage:
Options:
Data transfer operations.
Usage:
Options:
Commands:
Copy data between external object storage and cluster. Supported external object storage systems: ['AWS', 'GCS', 'AZURE', 'HTTP', 'HTTPS']. Note: originally, Azure's blob storage scheme is 'http(s)', but we prepend 'azure+' to differenciate https vs azure
Usage:
Options:
Copy data between storages on different clusters.
Consider archiving dataset first for the sake of performance, if the dataset contains a lot (100k+) of small (< 100Kb each) files.
Usage:
Options:
Job container image operations.
Usage:
Options:
Commands:
Build Job container image remotely on cluster using Kaniko.
Usage:
Options:
Build Job container image locally (requires Docker daemon).
Usage:
Options:
Copy images between clusters.
Usage:
Options:
Cluster Kubernetes operations.
Usage:
Options:
Commands:
Usage:
Options:
Usage:
Options:
Seldon deployment operations.
Usage:
Options:
Commands:
Usage:
Options:
Usage:
Options:
Create apolo CLI aliases for apolo-extras functionality.
Usage:
Options:
| Name | Description |
|---|---|
| Usage | Description |
|---|---|
| Name | Description |
|---|---|
| Name | Description |
|---|---|
| Name | Description |
|---|---|
| Usage | Description |
|---|---|
| Name | Description |
|---|---|
| Name | Description |
|---|---|
| Name | Description |
|---|---|
| Usage | Description |
|---|---|
| Name | Description |
|---|---|
| Name | Description |
|---|---|
| Name | Description |
|---|---|
| Name | Description |
|---|---|
| Usage | Description |
|---|---|
| Name | Description |
|---|---|
| Name | Description |
|---|---|
| Name | Description |
|---|---|
| Usage | Description |
|---|---|
| Name | Description |
|---|---|
| Name | Description |
|---|---|
| Name | Description |
|---|---|
-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.
--version
Show the version and exit.
--help
Show this message and exit.
Configuration operations.
Data transfer operations.
Job container image operations.
Cluster Kubernetes operations.
Seldon deployment operations.
Create apolo CLI aliases for apolo-extras functionality.
--help
Show this message and exit.
Generate docker auth for accessing remote registry.
Save docker auth file for accessing platform registry.
--help
Show this message and exit.
--cluster TEXT
Cluster name for which the auth information should be saved. Current cluster by default
--help
Show this message and exit.
--help
Show this message and exit.
Copy data between external object storage and cluster.
Copy data between storages on different clusters.
-x, --extract
Perform extraction of SOURCE into the DESTINATION directory. The archive type is derived from the file name. Supported types: .tar.gz, .tgz, .tar.bz2, .bz2, .tbz, .tar, .gz, .zip.
-c, --compress
Perform compression of SOURCE into the DESTINATION file. The archive type is derived from the file name. Supported types: .tar.gz, .tgz, .tar.bz2, .bz2, .tbz, .tar, .gz, .zip.
-v, --volume MOUNT
Mounts directory from vault into container. Use multiple options to mount more than one volume.
-e, --env VAR=VAL
Set environment variable in container. Use multiple options to define more than one variable.
-t, --use-temp-dir
DEPRECATED - need for temp dir is automatically detected, this flag will be removed in a future release. Download and extract / compress data (if needed) inside the temporary directory. Afterwards move resulted file(s) into the DESTINATION. NOTE: use it if 'storage:' is involved and extraction or compression is performed to speedup the process.
-s, --preset PRESET_NAME
Preset name used for copy.
-l, --life_span SECONDS
Copy job life span in seconds.
--help
Show this message and exit.
--help
Show this message and exit.
--help
Show this message and exit.
Build Job container image remotely on cluster using Kaniko.
Build Job container image locally (requires Docker daemon).
Copy images between clusters.
-f, --file TEXT
Relative (w.r.t. context) path to the dockerfile. The dockerfile should be within the context directory. [default: Dockerfile]
--build-arg VAR=VAL
Build-time variables passed in ARG values, similarly to Docker. Could be used multiple times for multiple arguments.
-v, --volume MOUNT
Mounts directory from storage into container. Use multiple options to mount more than one volume.
-e, --env VAR=VAL
Set environment variable in container. Use multiple options to define more than one variable. Those env vars will be passed as build arguments too.
-s, --preset PRESET
Predefined resource configuration (to see available values, run apolo config show)
-F, --force-overwrite
Overwrite if the destination image already exists.
--cache / --no-cache
Use Kaniko cache while building image. [default: cache]
--verbose BOOLEAN
If specified, run Kaniko with 'debug' verbosity, otherwise 'info' (default).
--build-tag VAR=VAL
Set tag(s) for image builder job. We will add tag 'kaniko-builds:{image-name}' authomatically.
-p, --project PROJECT_NAME
Start image builder job in other than the current project.
--extra-kaniko-args ARGS
Extra arguments for Kaniko builder. Useful for advanced users, e.g. to set custom Kaniko caching behaviour. We set some default arguments for you, so use this option with caution. Please refer to Kaniko documentation for more details at https://github.com/GoogleContainerTools/kaniko?tab=readme-ov-file#additional-flags
--help
Show this message and exit.
-f, --file TEXT
Relative (w.r.t. context) path to the dockerfile. The dockerfile should be within the context directory. [default: Dockerfile]
--build-arg VAR=VAL
Build-time variables passed in ARG values. Could be used multiple times for multiple arguments.
-F, --force-overwrite
Overwrite if the destination image already exists.
--verbose BOOLEAN
If specified, provide verbose output (default False).
-p, --project PROJECT_NAME
Start image builder job in other than the current project.
--help
Show this message and exit.
-F, --force-overwrite
Transfer even if the destination image already exists.
--help
Show this message and exit.
--help
Show this message and exit.
--name TEXT
--help
Show this message and exit.
--name TEXT
--help
Show this message and exit.
--help
Show this message and exit.
--name TEXT
--apolo-secret TEXT
--registry-secret TEXT
--help
Show this message and exit.
--help
Show this message and exit.
--help
Show this message and exit.