Quick Start!
Qarnot Documentation : Documentation
Qarnot API : Api Console
Install
from the binary
- Go to the CLI releases
- download your OS release binary
- you can rename your release binary to
qarnoton mac and linux, and move it in your binary file to use it as in the examples below
Rebuild from the source code
git clone https://github.com/qarnot/qarnot-cli.git qarnot-cli
cd qarnot-cli
dotnet publish -c Release -r ubuntu-x64 /p:PublishSingleFile=true -o ./your/dest/folder/bin
use the correct runtime identifier depending on your platform runtime identifiers
Set your connection information
Your connection information are in : https://tasq.qarnot.com/settings/access-token Launch (with your token):
qarnot config set -t 0123456789__myAPIToken__9876543210
If you need to set a specific custom storage or compute uri :
qarnot config set -t 0123456789__myAPIToken__9876543210 -u https://api.qarnot.com -s https://storage.qarnot.com -f true
Environment variable used to change the configuration
| Name | usage |
|---|---|
| QARNOT_LOCAL_PATH | Specify a custom configuration file path |
| QARNOT_DEFAULT_PATH | Specify a global configuration file path check if the QARNOT_LOCAL_PATH is not found |
| QARNOT_CLIENT_TOKEN | Use your api connection token without storing it |
| QARNOT_CLUSTER_URL | Use a custom qarnot api url |
| QARNOT_STORAGE_URL | Use a custom qarnot storage url |
| QARNOT_ACCOUNT_EMAIL | Specify your qarnot email account |
| QARNOT_USE_STORAGE_PATH_STYLE | force the storage path style, it must be "true" or "false" |
Create a Qarnot Resource
Directly on the command line
Create an "hello world" Task
qarnot task create --name "Task name" --profile docker-batch --instance 4 --constants "DOCKER_CMD=echo hello world"
Uuid : fb6e883c-f136-49cf-84b2-bd2f73bfdb60
Message : New task create, state : Submitted
Create a bucket
qarnot bucket create -n Bucket_name --files test_file.txt test_file2.txt
Uuid : Bucket_name
Message : New bucket create,
With the help of a configuration file
(not available for Buckets)
qarnot task create -f CreateTask.json --shortname use_a_shortname_different_to_the_file_shortname
create task
Uuid : fb6e883c-f136-49cf-84b2-bd2f73bfdb60
Message : New task create, state : Submitted
Manage the Qarnot Resources
List resources
List all the pool
qarnot pool list --tags PoolList
------------------------------------------------------------------------------------------------------------
| Name | State | Uuid | Shortname | Profile | NodeCount |
------------------------------------------------------------------------------------------------------------
| poolN°1 | Closed | 6de206a7-5170-4c3e-8e77-da15c7ad81b4 | id-1 | docker-batch | 2 |
------------------------------------------------------------------------------------------------------------
| poolN°2 | FullyDispatched | abeec2bc-4137-43ba-b1fb-8ec2fe850b95 | id-2 | docker-batch | 10 |
------------------------------------------------------------------------------------------------------------
Get resources details
Get all the information of a job
qarnot job info --id 77951c5b-7c63-4525-a270-c62bbe0ca476
[
{
"Connection": {
...
},
"Uuid": "77951c5b-7c63-4525-a270-c62bbe0ca476",
"Name": "name",
"Shortname": "77951c5b-7c63-4525-a270-c62bbe0ca476",
"PoolUuid": "00000000-0000-0000-0000-000000000000",
"State": "Active",
"CreationDate": "2020-02-28T08:55:45Z",
"LastModified": "2020-02-28T08:55:45Z",
"UseDependencies": false,
"MaximumWallTime": "00:00:00",
"Pool": null
}
]
Get all the information of a job in JSON Format
qarnot job info --id 77951c5b-7c63-4525-a270-c62bbe0ca476 --format JSON
[
{
"Uuid": "77951c5b-7c63-4525-a270-c62bbe0ca476",
"Name": "name",
"Shortname": "77951c5b-7c63-4525-a270-c62bbe0ca476",
"PoolUuid": "00000000-0000-0000-0000-000000000000",
"State": "Active",
"CreationDate": "2020-02-28T08:55:45Z",
"LastModified": "2020-02-28T08:55:45Z",
"UseDependencies": false,
"MaximumWallTime": "00:00:00",
"Pool" : null
}
]
Abort a resource
qarnot job abort --name "name"
----------------------------------------------------------
| Uuid | Message |
----------------------------------------------------------
| 77951c5b-7c63-4525-a270-c62bbe0ca476 | Job terminate |
----------------------------------------------------------
Count: 1
Delete a resource
delete all the jobs
qarnot job delete --all
-------------------------------------------------------
| Uuid | Message |
-------------------------------------------------------
| 6e40bac4-c2dc-4812-be48-171e36b5e271 | Job delete |
-------------------------------------------------------
| 20f22eea-de5a-496f-a0f8-952cab173375 | Job delete |
-------------------------------------------------------
| 543c72ce-3e32-415f-8cf0-0567fd5638fb | Job delete |
-------------------------------------------------------
| 77951c5b-7c63-4525-a270-c62bbe0ca476 | Job delete |
-------------------------------------------------------
Count: 4
Get resources carbon facts
Get all the information of a task
qarnot task carbon-facts --id 77951c5b-7c63-4525-a270-c62bbe0ca476 --datacenter european_dc
[
{
"Connection": {
...
},
"total_consumed_energy_Wh": 0.163,
"qarnot_carbon_footprint": 10, // in gC02e
"total_reused_energy_Wh": 0.147,
"equivalent_datacenter_name": "european_dc",
"equivalent_DC_carbon_footprint": 45, // in gC02e
"saved_carbon_footprint_compute": 35, // in gC02e
"saved_carbon_footprint_heat": 9, // in gC02e
"saved_carbon_footprint_compute_heat": 44, // in gC02e
"saved_carbon_footprint_percent": 81.82,
"PUE": 1.004,
"ERF": 90.5,
"ERE": 0.096,
"WUE": 0,
}
]
Manage your account
qarnot account
AccountInformation :
Email : my.mail@adress.com
MaxInstances : 50
Quota Bucket Number : 5/10
Quota Bytes Bucket : 10443/107342
Quota Task Count : 1/50
Quota Running Task : 0/50
Quota Total Pool : 6/50
Quota Running Pool : 4/50