Basic operations via CLI

Last updated 29th October, 2020.

Objective

This guide covers the usage of the ovhai CLI.

Requirements

• a working ovhai CLI how to install ovhai CLI

Instructions

Run a job

To submit a job you need a docker image and optionally some data.

First let's submit a simple job, a public ubuntu image which executes a command echo:

ovhai job run ubuntu --gpu 1 -- echo "Hello from my first job"

You can then list your current and old jobs with:

ovhai job list

You should see the job you just ran, you need its Id to get more information about it.

To see its logs in live use the following command:

ovhai job logs <job-id>

You should see the output of the echo command:

Hello from my first job

Use data in your job

You can upload data to the Object Storage and mount that data when you run a job. If you mount that data with read/write access you can save data from a job.

Let's upload some data and use it in a job that will produce more data.

ovhai data upload <region> <container> some-file.txt

Now that you have some data in a container you can mount it when you run a job with the flag --volume.

ovhai job run <image> --volume <container>@<region>:/data:rw

You can list and download data you uploaded or generated by a job with:

ovhai data list <region> <container>
ovhai data download <region> <container> --prefix /some-data

Execute commands inside a running job

You can execute commands (like bash) while a job is running.

ovhai job exec <id> -- bash

This way you can interact with a running job.

Manage registries

You can list available registries with:

ovhai registry list

By default, you have access to public registries, and a shared registry scoped to your project. To add a private registry, use:

ovhai registry add <url>

You will be asked to type your credentials.

Feedback

Please send us your questions, feedback and suggestions to improve the service:

• On the OVHcloud AI community forum

These guides might also interest you...