CLI Reference

neuro-extras
Auxiliary scripts and recipes for automating routine tasks.
Usage:
neuro-extras [OPTIONS] COMMAND [ARGS]...
Options:
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.
Command Groups:
Usage
Description
​neuro-extras config​
Configuration operations.
​neuro-extras data​
Data transfer operations.
​neuro-extras image​
Job container image operations.
​neuro-extras k8s​
Cluster Kubernetes operations.
​neuro-extras seldon​
Seldon deployment operations.
Commands:
Usage
Description
​neuro-extras init-aliases​
Create neuro CLI aliases for neuro-extras functionality.
neuro-extras config
Configuration operations.
Usage:
neuro-extras config [OPTIONS] COMMAND [ARGS]...
Options:
Name
Description
--help
Show this message and exit.
Commands:
Usage
Description
​neuro-extras config build-registy-auth​
Generate docker auth for accessing remote registry.
​neuro-extras config save-registry-auth​
Save docker auth file for accessing platform registry.
neuro-extras config build-registy-auth
Generate docker auth for accessing remote registry.
Usage:
neuro-extras config build-registy-auth [OPTIONS] REGISTRY_URI USERNAME
                                              PASSWORD
Options:
Name
Description
--help
Show this message and exit.
neuro-extras config save-registry-auth
Save docker auth file for accessing platform registry.
Usage:
neuro-extras config save-registry-auth [OPTIONS] PATH
Options:
Name
Description
--cluster TEXT
Cluster name for which the auth information should be saved. Current cluster by default
--help
Show this message and exit.
neuro-extras data
Data transfer operations.
Usage:
neuro-extras data [OPTIONS] COMMAND [ARGS]...
Options:
Name
Description
--help
Show this message and exit.
Commands:
Usage
Description
​neuro-extras data cp​
Copy data between external object storage and cluster.
​neuro-extras data transfer​
Copy data between storages on different clusters.
neuro-extras data cp
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:
neuro-extras data cp [OPTIONS] SOURCE DESTINATION
Options:
Name
Description
-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.
neuro-extras data transfer
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:
neuro-extras data transfer [OPTIONS] SOURCE DESTINATION
Options:
Name
Description
--help
Show this message and exit.
neuro-extras image
Job container image operations.
Usage:
neuro-extras image [OPTIONS] COMMAND [ARGS]...
Options:
Name
Description
--help
Show this message and exit.
Commands:
Usage
Description
​neuro-extras image build​
Build Job container image remotely on cluster using Kaniko.
​neuro-extras image local-build​
Build Job container image locally (requires Docker daemon).
​neuro-extras image transfer​
Copy images between clusters.
neuro-extras image build
Build Job container image remotely on cluster using Kaniko.
Usage:
neuro-extras image build [OPTIONS] CONTEXT_PATH IMAGE_URI
Options:
Name
Description
-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 vault into container. Use multiple options to mount more than one volume. Use --volume=ALL to mount all accessible storage directories.
-e, --env VAR=VAL
Set environment variable in container Use multiple options to define more than one variable
-s, --preset PRESET
Predefined resource configuration (to see available values, run neuro 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.
--help
Show this message and exit.
neuro-extras image local-build
Build Job container image locally (requires Docker daemon).
Usage:
neuro-extras image local-build [OPTIONS] CONTEXT_PATH IMAGE_URI
Options:
Name
Description
-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.
neuro-extras image transfer
Copy images between clusters.
Usage:
neuro-extras image transfer [OPTIONS] SOURCE DESTINATION
Options:
Name
Description
-F, --force-overwrite
Transfer even if the destination image already exists.
--help
Show this message and exit.
neuro-extras k8s
Cluster Kubernetes operations.
Usage:
neuro-extras k8s [OPTIONS] COMMAND [ARGS]...
Options:
Name
Description
--help
Show this message and exit.
Commands:
Usage
Description
​neuro-extras k8s generate-registry-secret​
​
​neuro-extras k8s generate-secret​
​
neuro-extras k8s generate-registry-secret
Usage:
neuro-extras k8s generate-registry-secret [OPTIONS]
Options:
Name
Description
--name TEXT
​
--help
Show this message and exit.
neuro-extras k8s generate-secret
Usage:
neuro-extras k8s generate-secret [OPTIONS]
Options:
Name
Description
--name TEXT
​
--help
Show this message and exit.
neuro-extras seldon
Seldon deployment operations.
Usage:
neuro-extras seldon [OPTIONS] COMMAND [ARGS]...
Options:
Name
Description
--help
Show this message and exit.
Commands:
Usage
Description
​neuro-extras seldon generate-deployment​
​
​neuro-extras seldon init-package​
​
neuro-extras seldon generate-deployment
Usage:
neuro-extras seldon generate-deployment [OPTIONS] MODEL_IMAGE_URI
                                               MODEL_STORAGE_URI
Options:
Name
Description
--name TEXT
​
--neuro-secret TEXT
​
--registry-secret TEXT
​
--help
Show this message and exit.
neuro-extras seldon init-package
Usage:
neuro-extras seldon init-package [OPTIONS] [PATH]
Options:
Name
Description
--help
Show this message and exit.
neuro-extras init-aliases
Create neuro CLI aliases for neuro-extras functionality.
Usage:
neuro-extras init-aliases [OPTIONS]
Options:
Name
Description
--help
Show this message and exit.

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.

Usage	Description
neuro-extras config	Configuration operations.
neuro-extras data	Data transfer operations.
neuro-extras image	Job container image operations.
neuro-extras k8s	Cluster Kubernetes operations.
neuro-extras seldon	Seldon deployment operations.

Usage	Description
neuro-extras init-aliases	Create neuro CLI aliases for neuro-extras functionality.

Name	Description
--help	Show this message and exit.

Usage	Description
neuro-extras config build-registy-auth	Generate docker auth for accessing remote registry.
neuro-extras config save-registry-auth	Save docker auth file for accessing platform registry.

Name	Description
--help	Show this message and exit.

Name	Description
--cluster TEXT	Cluster name for which the auth information should be saved. Current cluster by default
--help	Show this message and exit.

Name	Description
--help	Show this message and exit.

Usage	Description
neuro-extras data cp	Copy data between external object storage and cluster.
neuro-extras data transfer	Copy data between storages on different clusters.

Name	Description
-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.

Name	Description
--help	Show this message and exit.

Name	Description
--help	Show this message and exit.

Usage	Description
neuro-extras image build	Build Job container image remotely on cluster using Kaniko.
neuro-extras image local-build	Build Job container image locally (requires Docker daemon).
neuro-extras image transfer	Copy images between clusters.

Name	Description
-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 vault into container. Use multiple options to mount more than one volume. Use --volume=ALL to mount all accessible storage directories.
-e, --env VAR=VAL	Set environment variable in container Use multiple options to define more than one variable
-s, --preset PRESET	Predefined resource configuration (to see available values, run `neuro 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.
--help	Show this message and exit.

Name	Description
-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.

Name	Description
-F, --force-overwrite	Transfer even if the destination image already exists.
--help	Show this message and exit.

Name	Description
--help	Show this message and exit.

Usage	Description
neuro-extras k8s generate-registry-secret
neuro-extras k8s generate-secret

Name	Description
--name TEXT
--help	Show this message and exit.

Name	Description
--name TEXT
--help	Show this message and exit.

Name	Description
--help	Show this message and exit.

Usage	Description
neuro-extras seldon generate-deployment
neuro-extras seldon init-package

Name	Description
--name TEXT
--neuro-secret TEXT
--registry-secret TEXT
--help	Show this message and exit.

Name	Description
--help	Show this message and exit.

Name	Description
--help	Show this message and exit.

README

Last modified 27d ago