mirror of
https://github.com/OpenNebula/one.git
synced 2026-11-21 04:12:37 +09:00
280 lines
8.8 KiB
Ruby
280 lines
8.8 KiB
Ruby
# -------------------------------------------------------------------------- #
|
|
# Copyright 2002-2012, OpenNebula Project Leads (OpenNebula.org) #
|
|
# #
|
|
# 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. #
|
|
#--------------------------------------------------------------------------- #
|
|
|
|
|
|
require 'OpenNebula/Pool'
|
|
require 'fileutils'
|
|
|
|
module OpenNebula
|
|
class Image < PoolElement
|
|
#######################################################################
|
|
# Constants and Class Methods
|
|
#######################################################################
|
|
|
|
|
|
IMAGE_METHODS = {
|
|
:info => "image.info",
|
|
:allocate => "image.allocate",
|
|
:update => "image.update",
|
|
:enable => "image.enable",
|
|
:persistent => "image.persistent",
|
|
:delete => "image.delete",
|
|
:chown => "image.chown",
|
|
:chmod => "image.chmod",
|
|
:chtype => "image.chtype",
|
|
:clone => "image.clone"
|
|
}
|
|
|
|
IMAGE_STATES=%w{INIT READY USED DISABLED LOCKED ERROR CLONE DELETE USED_PERS}
|
|
|
|
SHORT_IMAGE_STATES={
|
|
"INIT" => "init",
|
|
"READY" => "rdy",
|
|
"USED" => "used",
|
|
"DISABLED" => "disa",
|
|
"LOCKED" => "lock",
|
|
"ERROR" => "err",
|
|
"CLONE" => "clon",
|
|
"DELETE" => "dele",
|
|
"USED_PERS" => "used"
|
|
}
|
|
|
|
IMAGE_TYPES=%w{OS CDROM DATABLOCK}
|
|
|
|
SHORT_IMAGE_TYPES={
|
|
"OS" => "OS",
|
|
"CDROM" => "CD",
|
|
"DATABLOCK" => "DB"
|
|
}
|
|
|
|
# Creates an Image description with just its identifier
|
|
# this method should be used to create plain Image objects.
|
|
# +id+ the id of the image
|
|
#
|
|
# Example:
|
|
# image = Image.new(Image.build_xml(3),rpc_client)
|
|
#
|
|
def Image.build_xml(pe_id=nil)
|
|
if pe_id
|
|
image_xml = "<IMAGE><ID>#{pe_id}</ID></IMAGE>"
|
|
else
|
|
image_xml = "<IMAGE></IMAGE>"
|
|
end
|
|
|
|
XMLElement.build_xml(image_xml,'IMAGE')
|
|
end
|
|
|
|
# Class constructor
|
|
def initialize(xml, client)
|
|
super(xml,client)
|
|
|
|
@client = client
|
|
end
|
|
|
|
#######################################################################
|
|
# XML-RPC Methods for the Image Object
|
|
#######################################################################
|
|
|
|
# Retrieves the information of the given Image.
|
|
def info()
|
|
super(IMAGE_METHODS[:info], 'IMAGE')
|
|
end
|
|
|
|
# Allocates a new Image in OpenNebula
|
|
#
|
|
# @param description [String] A string containing the template of the Image.
|
|
# @param ds_id [Integer] the target datastore ID
|
|
#
|
|
# @return [nil, OpenNebula::Error] nil in case of success, Error
|
|
# otherwise
|
|
def allocate(description, ds_id)
|
|
super(IMAGE_METHODS[:allocate],description, ds_id)
|
|
end
|
|
|
|
# Replaces the template contents
|
|
#
|
|
# +new_template+ New template contents. If no argument is provided
|
|
# the object will be updated using the @xml variable
|
|
def update(new_template=nil)
|
|
super(IMAGE_METHODS[:update], new_template)
|
|
end
|
|
|
|
# Enables an Image
|
|
def enable
|
|
set_enabled(true)
|
|
end
|
|
|
|
# Disables an Image
|
|
def disable
|
|
set_enabled(false)
|
|
end
|
|
|
|
# Publishes the Image, to be used by other users
|
|
def publish
|
|
set_publish(true)
|
|
end
|
|
|
|
# Unplubishes the Image
|
|
def unpublish
|
|
set_publish(false)
|
|
end
|
|
|
|
# Makes the Image persistent
|
|
def persistent
|
|
set_persistent(true)
|
|
end
|
|
|
|
# Makes the Image non persistent
|
|
def nonpersistent
|
|
set_persistent(false)
|
|
end
|
|
|
|
# Deletes the Image
|
|
def delete()
|
|
super(IMAGE_METHODS[:delete])
|
|
end
|
|
|
|
# Changes the owner/group
|
|
# uid:: _Integer_ the new owner id. Set to -1 to leave the current one
|
|
# gid:: _Integer_ the new group id. Set to -1 to leave the current one
|
|
# [return] nil in case of success or an Error object
|
|
def chown(uid, gid)
|
|
super(IMAGE_METHODS[:chown], uid, gid)
|
|
end
|
|
|
|
# Changes the Image permissions.
|
|
#
|
|
# @param octet [String] Permissions octed , e.g. 640
|
|
# @return [nil, OpenNebula::Error] nil in case of success, Error
|
|
# otherwise
|
|
def chmod_octet(octet)
|
|
super(IMAGE_METHODS[:chmod], octet)
|
|
end
|
|
|
|
# Changes the Image permissions.
|
|
# Each [Integer] argument must be 1 to allow, 0 deny, -1 do not change
|
|
#
|
|
# @return [nil, OpenNebula::Error] nil in case of success, Error
|
|
# otherwise
|
|
def chmod(owner_u, owner_m, owner_a, group_u, group_m, group_a, other_u,
|
|
other_m, other_a)
|
|
super(IMAGE_METHODS[:chmod], owner_u, owner_m, owner_a, group_u,
|
|
group_m, group_a, other_u, other_m, other_a)
|
|
end
|
|
|
|
# Changes the Image type
|
|
# @param type [String] new Image type
|
|
# @return [nil, OpenNebula::Error] nil in case of success, Error
|
|
# otherwise
|
|
def chtype(type)
|
|
return Error.new('ID not defined') if !@pe_id
|
|
|
|
rc = @client.call(IMAGE_METHODS[:chtype], @pe_id, type)
|
|
rc = nil if !OpenNebula.is_error?(rc)
|
|
|
|
return rc
|
|
end
|
|
|
|
# Clones this Image into a new one
|
|
#
|
|
# @param [String] name for the new Image.
|
|
#
|
|
# @return [Integer, OpenNebula::Error] The new Image ID in case
|
|
# of success, Error otherwise
|
|
def clone(name)
|
|
return Error.new('ID not defined') if !@pe_id
|
|
|
|
rc = @client.call(IMAGE_METHODS[:clone], @pe_id, name)
|
|
|
|
return rc
|
|
end
|
|
|
|
#######################################################################
|
|
# Helpers to get Image information
|
|
#######################################################################
|
|
|
|
# Returns the state of the Image (numeric value)
|
|
def state
|
|
self['STATE'].to_i
|
|
end
|
|
|
|
# Returns the state of the Image (string value)
|
|
def state_str
|
|
IMAGE_STATES[state]
|
|
end
|
|
|
|
# Returns the state of the Image (string value)
|
|
def short_state_str
|
|
SHORT_IMAGE_STATES[state_str]
|
|
end
|
|
|
|
# Returns the type of the Image (numeric value)
|
|
def type
|
|
self['TYPE'].to_i
|
|
end
|
|
|
|
# Returns the type of the Image (string value)
|
|
def type_str
|
|
IMAGE_TYPES[type]
|
|
end
|
|
|
|
# Returns the state of the Image (string value)
|
|
def short_type_str
|
|
SHORT_IMAGE_TYPES[type_str]
|
|
end
|
|
|
|
# Returns the group identifier
|
|
# [return] _Integer_ the element's group ID
|
|
def gid
|
|
self['GID'].to_i
|
|
end
|
|
|
|
def public?
|
|
if self['PERMISSIONS/GROUP_U'] == "1" || self['PERMISSIONS/OTHER_U'] == "1"
|
|
true
|
|
else
|
|
false
|
|
end
|
|
end
|
|
|
|
private
|
|
|
|
def set_enabled(enabled)
|
|
return Error.new('ID not defined') if !@pe_id
|
|
|
|
rc = @client.call(IMAGE_METHODS[:enable], @pe_id, enabled)
|
|
rc = nil if !OpenNebula.is_error?(rc)
|
|
|
|
return rc
|
|
end
|
|
|
|
def set_publish(published)
|
|
group_u = published ? 1 : 0
|
|
|
|
chmod(-1, -1, -1, group_u, -1, -1, -1, -1, -1)
|
|
end
|
|
|
|
def set_persistent(persistence)
|
|
return Error.new('ID not defined') if !@pe_id
|
|
|
|
rc = @client.call(IMAGE_METHODS[:persistent], @pe_id, persistence)
|
|
rc = nil if !OpenNebula.is_error?(rc)
|
|
|
|
return rc
|
|
end
|
|
end
|
|
end
|