Jump To …

JSTACK.Nova.Volume.js 

/*
The MIT License

Copyright (c) 2012 Universidad Politecnica de Madrid

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
*/

JStack Nova Volume Module

Allows you to manage volumes and snapshots that can be used with the Compute API.

 
JSTACK.Nova.Volume = (function (JS, undefined) {
    "use strict";
    var params, check, configure, getvolumelist, createvolume, deletevolume, getvolume,
        getsnapshotlist, createsnapshot, deletesnapshot, getsnapshot;

This modules stores the url to which it will send every request.

 
    params = {
        url : undefined,
        state : undefined,
        endpointType : "publicURL"
    };

Private functions

Function check internally confirms that Keystone module is authenticated and it has the URL of the Volume service.

 
    check = function () {
        if (JS.Keystone !== undefined && JS.Keystone.params.currentstate === JS.Keystone.STATES.AUTHENTICATED) {
            var service = JS.Keystone.getservice("volume");
            params.url = service.endpoints[0][params.endpointType];
            return true;
        }
        return false;
    };

Public functions

This function sets the endpoint type for making requests to Glance. It could take one of the following values: * "adminURL" * "internalURL" * "publicURL" You can use this function to change the default endpointURL, which is publicURL.

 
    configure = function (endpointType) {
        if (endpointType === "adminURL" || endpointType === "internalURL" || endpointType === "publicURL") {
            params.endpointType = endpointType;
        }
    };

Volume Operations

View a list of simple Volume entities. In Requesting a List of Volumes there is more information about the JSON object that is returned.

 
    getvolumelist = function (detailed, callback) {
        var url, onOk, onError;
        if (!check()) {
            return;
        }
        url = params.url + '/volumes';
        if (detailed !== undefined && detailed) {
            url += '/detail';
        }

        onOk = function (result) {
            if (callback !== undefined) {
                callback(result);
            }
        };
        onError = function (message) {
            throw new Error(message);
        };

        JS.Comm.get(url, JS.Keystone.params.token, onOk, onError);
    };

Create a Volume. Arguments in this function are:

a. Mandatory

  • The size of volume in GB

b. Optional

  • The name of the volume

  • The description of the volume

 
    createvolume = function (size, name, description, callback) {
        var onOk, onError, data;
        if (!check()) {
            return;
        }

        data = {
            "volume" : {
                "size" : size
            }
        };

        if (name !== undefined) {
            data.volume.display_name = name;
        }

        if (description !== undefined) {
            data.volume.display_description = description;
        }

        onOk = function (result) {
            if (callback !== undefined) {
                callback(result);
            }
        };
        onError = function (message) {
            throw new Error(message);
        };

        JS.Comm.post(params.url + '/volumes', data, JS.Keystone.params.token, onOk, onError);
    };

Delete a Volume entitiy. In Deleting a Volume there is more information about the JSON object that is returned.

 
    deletevolume = function (id, callback) {
        var url, onOk, onError;
        if (!check()) {
            return;
        }
        url = params.url + '/volumes/' + id;

        onOk = function (result) {
            if (callback !== undefined) {
                callback(result);
            }
        };
        onError = function (message) {
            throw new Error(message);
        };

        JS.Comm.del(url, JS.Keystone.params.token, onOk, onError);
    };

Get a Volume entitiy. In Retrieving a Volume there is more information about the JSON object that is returned.

 
    getvolume = function (id, callback) {
        var url, onOk, onError;
        if (!check()) {
            return;
        }
        url = params.url + '/volumes/' + id;

        onOk = function (result) {
            if (callback !== undefined) {
                callback(result);
            }
        };
        onError = function (message) {
            throw new Error(message);
        };

        JS.Comm.get(url, JS.Keystone.params.token, onOk, onError);
    };

Snapshot Operations

View a list of simple Snapshot entities. In Requesting a List of Snapshots there is more information about the JSON object that is returned.

 
    getsnapshotlist = function (detailed, callback) {
        var url, onOk, onError;
        if (!check()) {
            return;
        }
        url = params.url + '/snapshots';
        if (detailed !== undefined && detailed) {
            url += '/detail';
        }

        onOk = function (result) {
            if (callback !== undefined) {
                callback(result);
            }
        };
        onError = function (message) {
            throw new Error(message);
        };

        JS.Comm.get(url, JS.Keystone.params.token, onOk, onError);
    };

Create a Volume Snapshot. Arguments in this function are:

a. Mandatory

  • The volume_id of the volume

b. Optional

  • The name of the snapshot

  • The description of the snapshot

 
    createsnapshot = function (volume_id, name, description, callback) {
        var url, onOk, onError, data;
        if (!check()) {
            return;
        }

        data = {
            "snapshot" : {
                "volume_id" : volume_id,
                "force" : true
            }
        };

        if (name !== undefined) {
            data.snapshot.display_name = name;
        }

        if (description !== undefined) {
            data.snapshot.display_description = description;
        }

        onOk = function (result) {
            if (callback !== undefined) {
                callback(result);
            }
        };
        onError = function (message) {
            throw new Error(message);
        };

        JS.Comm.post(params.url + '/snapshots', data, JS.Keystone.params.token, onOk, onError);
    };

Delete a Snapshot entitiy. In Retrieving a Snapshot there is more information about the JSON object that is returned.

 
    deletesnapshot = function (id, callback) {
        var url, onOk, onError;
        if (!check()) {
            return;
        }
        url = params.url + '/snapshots/' + id;

        onOk = function (result) {
            if (callback !== undefined) {
                callback(result);
            }
        };
        onError = function (message) {
            throw new Error(message);
        };

        JS.Comm.del(url, JS.Keystone.params.token, onOk, onError);
    };

Get a Snapshot entitiy. In Retrieving a Snapshot there is more information about the JSON object that is returned.

 
    getsnapshot = function (id, callback) {
        var url, onOk, onError;
        if (!check()) {
            return;
        }
        url = params.url + '/snapshots/' + id;

        onOk = function (result) {
            if (callback !== undefined) {
                callback(result);
            }
        };
        onError = function (message) {
            throw new Error(message);
        };

        JS.Comm.get(url, JS.Keystone.params.token, onOk, onError);
    };

Public Functions and Variables

This is the list of available public functions and variables

 
    return {

Functions:

 
        configure : configure,
        getvolumelist : getvolumelist,
        createvolume : createvolume,
        deletevolume : deletevolume,
        getvolume : getvolume,
        getsnapshotlist : getsnapshotlist,
        createsnapshot : createsnapshot,
        deletesnapshot : deletesnapshot,
        getsnapshot : getsnapshot
    };

}(JSTACK));