deb-ironic-ui/ironic_ui/static/dashboard/admin/ironic/ironic.service.js

409 lines
13 KiB
JavaScript
Executable File
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

/*
* © Copyright 2015,2016 Hewlett Packard Enterprise Development Company LP
* © Copyright 2016 Cray Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
(function () {
'use strict';
var provisionStateTransitionMatrix = {
enroll: {
manageable: 'manage'
},
manageable: {
active: 'adopt',
available: 'provide'
},
active: {
manageable: 'deleted'
},
available: {
active: 'active',
manageable: 'manage'
},
adopt_failed: {
manageable: 'manage',
active: 'adopt'
},
inspect_failed: {
manageable: 'manage'
},
clean_failed: {
manageable: 'manage'
},
deploy_failed: {
active: 'active',
manageable: 'deleted'
},
error: {
active: 'rebuild',
manageable: 'deleted'
}
};
angular
.module('horizon.app.core.openstack-service-api')
.factory('horizon.app.core.openstack-service-api.ironic', ironicAPI);
ironicAPI.$inject = [
'horizon.framework.util.http.service',
'horizon.framework.widgets.toast.service'
];
/**
* @description Service that provides access to the Ironic client API
*
* @param {object} apiService - HTTP service
* @param {object} toastService - User message service
* @return {object} Ironic API service
*/
function ironicAPI(apiService, toastService) {
var service = {
createNode: createNode,
createPort: createPort,
deleteNode: deleteNode,
deletePort: deletePort,
getDrivers: getDrivers,
getDriverProperties: getDriverProperties,
getNode: getNode,
getNodes: getNodes,
getPortsWithNode: getPortsWithNode,
getProvisionStateTransitionVerb: getProvisionStateTransitionVerb,
powerOffNode: powerOffNode,
powerOnNode: powerOnNode,
putNodeInMaintenanceMode: putNodeInMaintenanceMode,
removeNodeFromMaintenanceMode: removeNodeFromMaintenanceMode,
setNodeProvisionState: setNodeProvisionState
};
return service;
/**
* @description Retrieve a list of nodes
* http://docs.openstack.org/developer/ironic/webapi/v1.html#get--v1-nodes
*
* @return {promise} Node collection in JSON
* http://docs.openstack.org/developer/ironic/webapi/v1.html#NodeCollection
*/
function getNodes() {
return apiService.get('/api/ironic/nodes/')
.error(function() {
toastService.add('error',
gettext('Unable to retrieve Ironic nodes.'));
});
}
/**
* @description Retrieve information about the given node.
*
* http://docs.openstack.org/developer/ironic/webapi/v1.html#get--v1-
* nodes-(node_ident)
*
* @param {string} uuid UUID or logical name of a node.
* @return {promise} Node
*/
function getNode(uuid) {
return apiService.get('/api/ironic/nodes/' + uuid)
.error(function(reason) {
var msg = gettext('Unable to retrieve the Ironic node: %s');
toastService.add('error', interpolate(msg, [reason], false));
});
}
/**
* @description Retrieve a list of ports associated with a node.
*
* http://docs.openstack.org/developer/ironic/webapi/v1.html#get--v1-ports
*
* @param {string} uuid UUID or logical name of a node.
* @return {promise} List of ports
*/
function getPortsWithNode(uuid) {
var config = {
params : {
node_id: uuid
}
};
return apiService.get('/api/ironic/ports/', config)
.error(function(reason) {
var msg = gettext(
'Unable to retrieve the Ironic node ports: %s');
toastService.add('error', interpolate(msg, [reason], false));
});
}
/**
* @description Put the node in maintenance mode.
*
* http://docs.openstack.org/developer/ironic/webapi/v1.html#
* put--v1-nodes-(node_ident)-maintenance
*
* @param {string} uuid UUID or logical name of a node.
* @param {string} reason Reason for why node is being put into
* maintenance mode
* @return {promise} Promise
*/
function putNodeInMaintenanceMode(uuid, reason) {
var data = {
maint_reason: reason ? reason : gettext("No maintenance reason given.")
};
return apiService.patch('/api/ironic/nodes/' + uuid + '/maintenance',
data)
.error(function(reason) {
var msg = gettext(
'Unable to put the Ironic node in maintenance mode: %s');
toastService.add('error', interpolate(msg, [reason], false));
});
}
/**
* @description Remove the node from maintenance mode.
*
* http://docs.openstack.org/developer/ironic/webapi/v1.html#
* delete--v1-nodes-(node_ident)-maintenance
*
* @param {string} uuid UUID or logical name of a node.
* @return {promise} Promise
*/
function removeNodeFromMaintenanceMode(uuid) {
return apiService.delete('/api/ironic/nodes/' + uuid + '/maintenance')
.error(function(reason) {
var msg = gettext('Unable to remove the Ironic node ' +
'from maintenance mode: %s');
toastService.add('error', interpolate(msg, [reason], false));
});
}
/**
* @description Set the power state of the node.
*
* http://docs.openstack.org/developer/ironic/webapi/v1.html#
* put--v1-nodes-(node_ident)-states-power
*
* @param {string} uuid UUID or logical name of a node.
* @return {promise} Promise
*/
function powerOnNode(uuid) {
var data = {
state: 'on'
};
return apiService.patch('/api/ironic/nodes/' + uuid + '/states/power',
data)
.success(function() {
toastService.add('success',
gettext('Refresh page to see updated power status'));
})
.error(function(reason) {
var msg = gettext('Unable to power on the node: %s');
toastService.add('error', interpolate(msg, [reason], false));
});
}
/**
* @description Set the power state of the node.
*
* http://docs.openstack.org/developer/ironic/webapi/v1.html#
* put--v1-nodes-(node_ident)-states-power
*
* @param {string} uuid UUID or logical name of a node.
* @return {promise} Promise
*/
function powerOffNode(uuid) {
var data = {
state: 'off'
};
return apiService.patch('/api/ironic/nodes/' + uuid + '/states/power',
data)
.success(function() {
toastService.add('success',
gettext('Refresh page to see updated power status'));
})
.error(function(reason) {
var msg = gettext('Unable to power off the node: %s');
toastService.add('error', interpolate(msg, [reason], false));
});
}
/**
* @description Set the target provision state of the node.
*
* http://docs.openstack.org/developer/ironic/webapi/v1.html#
* put--v1-nodes-(node_ident)-states-provision
*
* @param {string} uuid UUID of a node.
* @param {string} verb Provisioning verb used to move node to desired
* target state
* @return {promise} Promise
*/
function setNodeProvisionState(uuid, verb) {
var data = {
verb: verb
};
return apiService.put('/api/ironic/nodes/' + uuid + '/states/provision',
data)
.success(function() {
var msg = gettext(
'A request has been made to change the provisioning state of node %s');
toastService.add('success', interpolate(msg, [uuid], false));
})
.error(function(reason) {
var msg = gettext('Unable to set node provision state: %s');
toastService.add('error', interpolate(msg, [reason], false));
});
}
/**
* @description Create an Ironic node
*
* http://docs.openstack.org/developer/ironic/webapi/v1.html#post--v1-nodes
*
* @param {object} params Object containing parameters that define
* the node to be created
* @return {promise} Promise
*/
function createNode(params) {
var data = {
node: params
};
return apiService.post('/api/ironic/nodes/', data)
.success(function() {
})
.error(function(reason) {
var msg = gettext('Unable to create node: %s');
toastService.add('error', interpolate(msg, [reason], false));
});
}
/**
* @description Delete the specified node from inventory
*
* http://docs.openstack.org/developer/ironic/webapi/v1.html#
* delete--v1-nodes
*
* @param {string} nodeIdent UUID or logical name of a node.
* @return {promise} Promise
*/
function deleteNode(nodeIdent) {
var data = {
node: nodeIdent
};
return apiService.delete('/api/ironic/nodes/', data)
.success(function() {
})
.error(function(reason) {
var msg = gettext('Unable to delete node %s: %s');
toastService.add(
'error',
interpolate(msg, [nodeIdent, reason], false));
});
}
/**
* @description Retrieve the list of Ironic drivers
*
* http://docs.openstack.org/developer/ironic/webapi/v1.html#get--v1-drivers
*
* @return {promise} Driver collection in JSON
* http://docs.openstack.org/developer/ironic/webapi/v1.html#DriverList
*/
function getDrivers() {
return apiService.get('/api/ironic/drivers/').error(function(reason) {
var msg = gettext('Unable to retrieve Ironic drivers: %s');
toastService.add('error', interpolate(msg, [reason], false));
});
}
/**
* @description Retrieve properities of a specified driver
*
* http://docs.openstack.org/developer/ironic/webapi/v1.html#
* get--v1-drivers-properties
*
* @param {string} driverName - Driver name
* @returns {promise} Property list
*/
function getDriverProperties(driverName) {
return apiService.get(
'/api/ironic/drivers/' + driverName + '/properties').error(
function(reason) {
var msg = gettext(
'Unable to retrieve driver properties: %s');
toastService.add('error', interpolate(msg, [reason], false));
});
}
/**
* @description Create a network port
*
* @param {object} port Object containing parameters that define
* the port to be created
* @return {promise} Promise
*/
function createPort(port) {
var data = {
port: port
};
return apiService.post('/api/ironic/ports/', data)
.success(function() {
toastService.add('success',
gettext('Port successfully created'));
})
.error(function(reason) {
var msg = gettext('Unable to create port: %s');
toastService.add('error', interpolate(msg, [reason], false));
});
}
/**
* @description Delete a network port
*
* @param {string} portUuid UUID of the port to be deleted
* @return {promise} Promise
*/
function deletePort(portUuid) {
var data = {
port_uuid: portUuid
};
return apiService.delete('/api/ironic/ports/', data)
.success(function() {
})
.error(function(reason) {
var msg = gettext('Unable to delete port: %s');
toastService.add('error', interpolate(msg, [reason], false));
});
}
/**
* @description Get the verb used to transition a node from a source
* provision-state to a target provision-state
*
* @param {string} sourceState source state
* @param {string} targetState target state
* @return {string} Verb used to transition from source to target state.
* null if the requested transition is not allowed.
*/
function getProvisionStateTransitionVerb(sourceState, targetState) {
var verb = null;
if (angular.isDefined(provisionStateTransitionMatrix[sourceState]) &&
angular.isDefined(
provisionStateTransitionMatrix[sourceState][targetState])) {
verb = provisionStateTransitionMatrix[sourceState][targetState];
}
return verb;
}
}
}());