Difference between revisions of "Storage Manager"

From Grid5000
Jump to: navigation, search
(POST /stable/sites/site/storage/home/username/access)
(POST /stable/sites/site/storage/home/username/access)
Line 106: Line 106:
   {"job": "4548, "site": "nancy"}
   {"job": "4548, "site": "nancy"}
For Until termination, at least hosts or ipv4 must be specified.
For Job termination, if no hosts and no ipv4 are provided, the API will get the hosts link to the job.

Revision as of 14:53, 3 September 2018

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. 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 :

Note.png Note

Only the home owner can interact with his or her accesses, so you need to be authenticated. It's done automatically on the frontend. With curl, you can also use the -u username option and you will be prompt for your password before the request is sent.


We assume that we want to manage the home of user jpicard on nancy, so the storage API entry-point will be:


Create access

Accesses creation is done by sending POST to the API with a JSON payload. We must provide a list of hosts to whom we want to give access to, for instance 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 fill them 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.png Warning

The access is create immediately and and valid until the termination of the job, even if the job has not started yet.

After that, you should be able to mount the home where you want:

Terminal.png node:
mount nfs.nancy.grid5000.fr:/home/jpicard /mnt/

Note.png Note

debian9-x64-std,debian9-x64-big and debian9-x64-nfs use autofs for the home directories of the local NFS server. So doing cd /home/jpicard/ will automount the home of jpicard if you have the rights.

List access

To list all accesses, 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": [
     "termination": {
       "job": 1666466,
       "site": "nancy"
   "G5k-home_jpicard_u_1535456240_1": {
     "ipv4": [
     "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

Access deletion is done by sending DELETE to the API with it's identifier.

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:
hosts Optional Array of hosts allowed to access NFS. eg:
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"}