Class: OpenNebula::Group

Inherits:
PoolElement show all
Defined in:
lib/opennebula/group.rb

Constant Summary collapse

GROUP_METHODS =

Constants and Class Methods

{
    :info           => "group.info",
    :allocate       => "group.allocate",
    :update         => "group.update",
    :delete         => "group.delete",
    :quota          => "group.quota",
    :add_admin      => "group.addadmin",
    :del_admin      => "group.deladmin",
}
SELF =

Flag for requesting connected user’s group info

-1
GROUP_DEFAULT_ACLS =

Default resource ACL’s for group users (create)

"VM+IMAGE+TEMPLATE+DOCUMENT+SECGROUP"
GROUP_ADMIN_SUNSTONE_VIEWS =

The default view for group and group admins, must be defined in sunstone_views.yaml

"groupadmin"

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from PoolElement

#id, #name, new_with_id, #to_str

Methods inherited from XMLElement

#[], #add_element, #attr, #delete_element, #each, #each_xpath, #element_xml, #has_elements?, #initialize_xml, #name, #retrieve_elements, #template_like_str, #template_str, #template_xml, #text, #to_hash, #to_xml

Constructor Details

#initialize(xml, client) ⇒ Group

Class constructor



64
65
66
 
# File 'lib/opennebula/group.rb', line 64

def initialize(xml, client)
    super(xml,client)
end

Class Method Details

.build_xml(pe_id = nil) ⇒ Object

Creates a Group description with just its identifier this method should be used to create plain Group objects. id the id of the user

Example:

group = Group.new(Group.build_xml(3),rpc_client)



53
54
55
56
57
58
59
60
61
 
# File 'lib/opennebula/group.rb', line 53

def Group.build_xml(pe_id=nil)
    if pe_id
        group_xml = "<GROUP><ID>#{pe_id}</ID></GROUP>"
    else
        group_xml = "<GROUP></GROUP>"
    end

    XMLElement.build_xml(group_xml,'GROUP')
end

Instance Method Details

#add_admin(user_id) ⇒ nil, OpenNebula::Error

Adds a User to the Group administrators set

Parameters:

  • user_id (Integer) —

    User ID

Returns:



214
215
216
 
# File 'lib/opennebula/group.rb', line 214

def add_admin(user_id)
    return call(GROUP_METHODS[:add_admin], @pe_id, user_id.to_i)
end

#admin_ids ⇒ Object

Returns an array with the numeric admin user ids



259
260
261
262
263
264
265
 
# File 'lib/opennebula/group.rb', line 259

def admin_ids
    ids = self.retrieve_elements("ADMINS/ID")

    return [] if ids.nil?

    return ids.collect! {|x| x.to_i}
end

#allocate(groupname) ⇒ Object

Allocates a new Group in OpenNebula

groupname A string containing the name of the Group.



174
175
176
 
# File 'lib/opennebula/group.rb', line 174

def allocate(groupname)
    super(GROUP_METHODS[:allocate], groupname)
end

#contains(uid) ⇒ Object

Returns whether or not the user with id ‘uid’ is part of this group



232
233
234
235
236
237
238
 
# File 'lib/opennebula/group.rb', line 232

def contains(uid)
    #This doesn't work in ruby 1.8.5
    #return self["USERS/ID[.=#{uid}]"] != nil

    id_array = retrieve_elements('USERS/ID')
    return id_array != nil && id_array.include?(uid.to_s)
end

#contains_admin(uid) ⇒ Object

Returns whether or not the user with id ‘uid’ is an admin of this group



241
242
243
244
245
246
247
 
# File 'lib/opennebula/group.rb', line 241

def contains_admin(uid)
    #This doesn't work in ruby 1.8.5
    #return self["ADMINS/ID[.=#{uid}]"] != nil

    id_array = retrieve_elements('ADMINS/ID')
    return id_array != nil && id_array.include?(uid.to_s)
end

#create(group_hash) ⇒ Object

Creates a group based in a group definition hash

group_hash[:name] the group name
group_hash[:group_admin] the admin user definition hash, see def
create_admin_user function description for details.
group_hash[:views] Array of sunstone view names, to be stored
    in SUNSTONE_VIEWS
group_hash[:default_view] Default sunstone view name, to be stored
    in DEFAULT_VIEW
group_hash[:admin_views] Array of sunstone view names, to be stored
    in GROUP_ADMIN_VIEWS
group_hash[:default_admin_view] Default sunstone view name, to be stored
    in DEFAULT_ADMIN_DEFAULT_VIEW



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/opennebula/group.rb', line 93

def create(group_hash)
    # Check arguments
    if !group_hash[:name]
        return OpenNebula::Error.new("Group name not defined")
    end

    if group_hash[:group_admin]
        if group_hash[:group_admin][:name] && !group_hash[:group_admin][:password]
            error_msg = "Admin user password not defined"
            return OpenNebula::Error.new(error_msg)
        end
    end

    # Allocate group
    rc = self.allocate(group_hash[:name])
    return rc if OpenNebula.is_error?(rc)

    # Set group ACLs to create resources
    rc, msg = create_default_acls(group_hash[:resources])

    if OpenNebula.is_error?(rc)
        self.delete
        error_msg =  "Error creating group ACL's: #{rc.message}"
        return OpenNebula::Error.new(error_msg)
    end

    # Set group ACLs to share resources
    if group_hash[:shared_resources]
        acls = Array.new
        acls << "@#{self.id} #{group_hash[:shared_resources]}/@#{self.id} USE"

        rc, msg = create_group_acls(acls)

        if OpenNebula.is_error?(rc)
            self.delete
            error_msg =  "Error creating group ACL's: #{rc.message}"
            return OpenNebula::Error.new(error_msg)
        end
    end

    # Create associated group admin if needed
    rc = create_admin_user(group_hash)

    if OpenNebula.is_error?(rc)
        self.delete
        error_msg =  "Error creating admin user: #{rc.message}"
        return OpenNebula::Error.new(error_msg)
    end

    str = ""

    # Add Sunstone views for the group
    if group_hash[:views]
        str += "SUNSTONE_VIEWS=\"#{group_hash[:views].join(",")}\"\n"
    end

    if group_hash[:default_view]
        str += "DEFAULT_VIEW=\"#{group_hash[:default_view]}\"\n"
    end

    # And the admin views
    if group_hash[:admin_views]
        str += "GROUP_ADMIN_VIEWS=\"#{group_hash[:admin_views].join(",")}\"\n"
    else
        str += "GROUP_ADMIN_VIEWS=#{GROUP_ADMIN_SUNSTONE_VIEWS}\n"
    end

    if group_hash[:default_admin_view]
        str += "GROUP_ADMIN_DEFAULT_VIEW=\"#{group_hash[:default_admin_view]}\"\n"
    else
        str += "GROUP_ADMIN_DEFAULT_VIEW=#{GROUP_ADMIN_SUNSTONE_VIEWS}"
    end

    self.update(str, true)

    return 0
end

#del_admin(user_id) ⇒ nil, OpenNebula::Error

Removes a User from the Group administrators set

Parameters:

  • user_id (Integer) —

    User ID

Returns:



223
224
225
 
# File 'lib/opennebula/group.rb', line 223

def del_admin(user_id)
    return call(GROUP_METHODS[:del_admin], @pe_id, user_id.to_i)
end

#delete ⇒ Object

Deletes the Group



191
192
193
 
# File 'lib/opennebula/group.rb', line 191

def delete()
    super(GROUP_METHODS[:delete])
end

#info ⇒ Object Also known as: info!

Retrieves the information of the given Group.



74
75
76
 
# File 'lib/opennebula/group.rb', line 74

def info()
    super(GROUP_METHODS[:info], 'GROUP')
end

#set_quota(quota) ⇒ nil, OpenNebula::Error

Sets the group quota limits

Parameters:

  • quota (String) —

    a template (XML or txt) with the new quota limits

Returns:



200
201
202
203
204
205
206
207
 
# File 'lib/opennebula/group.rb', line 200

def set_quota(quota)
    return Error.new('ID not defined') if !@pe_id

    rc = @client.call(GROUP_METHODS[:quota],@pe_id, quota)
    rc = nil if !OpenNebula.is_error?(rc)

    return rc
end

#update(new_template = nil, append = false) ⇒ nil, OpenNebula::Error

Replaces the template contents

Parameters:

  • new_template (String) (defaults to: nil) —

    New template contents

  • append (true, false) (defaults to: false) —

    True to append new attributes instead of replace the whole template

Returns:



186
187
188
 
# File 'lib/opennebula/group.rb', line 186

def update(new_template=nil, append=false)
    super(GROUP_METHODS[:update], new_template, append ? 1 : 0)
end

#user_ids ⇒ Object

Returns an array with the numeric user ids



250
251
252
253
254
255
256
 
# File 'lib/opennebula/group.rb', line 250

def user_ids
    ids = self.retrieve_elements("USERS/ID")

    return [] if ids.nil?

    return ids.collect! {|x| x.to_i}
end