Storage Manager
The Storage API is used to allow NFS access across machines on Grid'5000. This page focus on accessing user home directories.
How it works
The storage API works with access object. An access specify a list of addresses and a termination condition for a specific location on a NFS Server. In this page, we will focus on sharing the user home. Each user home directory is located on /export/home/
username
on the NFS server of each site : nfs.
site
.grid5000.fr
Each time you start a job, an access to your home of the local NFS server is automatically created for all the assigned nodes. You may want to use this page if you want to allow additional addresses to access your home or if you want to access your home over-site. You will need to use the Grid'5000 API, the entry-point for the home of a user on a specific site is :
https://api.grid5000.fr/stable/sites/site
/storage/home/username
/access
Usage
We will assume we want to work with the home of user jpicard
on nancy
, so the storage API entry-point will be:
https://api.grid5000.fr/stable/sites/nancy
/storage/home/jpicard
/access
Create access
Accesses creation is done by sending POST to the API with a JSON payload.
Let's assume we want to give access to the nodes dahu-1.grenoble.grid5000.fr
and dahu-2.grenoble.grid5000.fr
. We also need a termination condition, it can be a specific date or a job termination.
Until termination
If we want to use a specific time (for example 2018-12-25 19:38
), we send the following request to the Storage API:
curl -X POST 'https://api.grid5000.fr/stable/sites/nancy
/storage/home/jpicard
/access' -H "Content-Type: application/json" -d '{"hosts": ["dahu-1.grenoble.grid5000.fr", "dahu-2.grenoble.grid5000.fr"
], "termination" : {"until":"2018-12-25 19:38"
}}'
Job termination
If we want our access to be valid until the end of a Grid'5000 job, for example the job 4548
of grenoble
, we do:
curl -X POST 'https://api.grid5000.fr/stable/sites/nancy
/storage/home/jpicard
/access' -H "Content-Type: application/json" -d '{"hosts": ["dahu-1.grenoble.grid5000.fr", "dahu-2.grenoble.grid5000.fr"
], "termination" : {"job":4548
, "site":"grenoble"
}}
If we want to give access to all the assigned nodes of a job, we don't need to give any hosts, the API will complete theme for us:
curl -X POST 'https://api.grid5000.fr/stable/sites/nancy
/storage/home/jpicard
/access' -H "Content-Type: application/json" -d '{"termination" : {"job":4548
, "site":"grenoble"
}}
Warning | |
---|---|
The access is create immediately and until the termination of the job, even if the job has not yet started. |
After that, you should be able to mount the home where you want:
Note | |
---|---|
|
List access
To list all access, you should do:
curl https://api.grid5000.fr/stable/sites/nancy
/storage/home/jpicard
/access
You get a list of accesses:
{ "G5k-home_jpicard_j_1666466-nancy_1": { "ipv4": [ "172.16.64.97" ], "termination": { "job": 1666466, "site": "nancy" } }, "G5k-home_jpicard_u_1535456240_1": { "ipv4": [ "172.16.64.16" ], "termination": { "until": 1535456240, } } }
You can also ask for a specific access by providing its identifier, for instance :
curl https://api.grid5000.fr/stable/sites/nancy
/storage/home/jpicard
/access/G5k-home_jpicard_u_1535456240_1
Delete an access
Accesses deletion is done by sending DELETE to the API. To delete an access you specify it's identifier, for instance:
curl -X DELETE https://api.grid5000.fr/stable/sites/nancy
/storage/home/jpicard
/access/G5k-home_jpicard_u_1535456240_1
API Specification:
The Storage API uses the same status codes as the rest of the Grid'5000 API.
GET /stable/sites/site
/storage/home/username
/access
fetch a list of access.
GET /stable/sites/site
/storage/home/username
/access/access_id
fetch information of a specific access
DELETE /stable/sites/site
/storage/home/username
/access/access_id
delete a specific access
DELETE /stable/sites/site
/storage/home/username
/access/?job=job_id
&site=job_site
delete all access with a job termination job_id of site job_site
POST /stable/sites/site
/storage/home/username
/access
Create new access. The payload must be in JSON format, and contains the following properties:
Parameter | Type | Description & Examples |
---|---|---|
ipv4 | Optional | Array of ipv4 allowed to access NFS. eg:
["172.16.72.1", "172.16.72.25"] |
hosts | Optional | Array of hosts allowed to access NFS. eg:
["grisou-1.nancy.grid5000.fr", "grisou-2.nancy.grid5000.fr"] |
termination | Mandatory | Termination condition can be of two types "Until" or "Job". The form is a structure/hash.
Until termination takes a date as an until parameter. The access will be deleted after the specify date. eg: {"until" : "2018-12-25 19:38"} Job terminations takes two parameters, job and site, which are respectively the id and the site of a Grid'5000 job. When the job end, the export is deleted. eg: {"job": "4548, "site":"nancy"} |