opennebula 6.6.2 → 6.7.80.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d0911e0ad571781c4b94ee39d8459948d92ef8eb0d95aa9e06387bf402d2abd9
-  data.tar.gz: 98c66b223bdf54a82a8d4524288067b9b41045781ff90d4828328db18066d67f
+  metadata.gz: 1c791a9b245b95bd0627930d9f17845003130bec8aba4e363997e583725399b0
+  data.tar.gz: bef534bfd10f3b9453101a4d639d6ad2a79a2c70b2b34e44c8502d51b83b25c4
 SHA512:
-  metadata.gz: 9fc7ce19570b9ee1c5b3047e4d0503bd7028b4cee025fd37b8c42526fbe440fb0398ca2c9ba7a803e524e4fd9415f54c971e6be8aaa16a3513df91677cb1f557
-  data.tar.gz: 6e39b6567ce933244ddcedb2700abb82e002ccf3ed6199b78cccd064330fd93e7774d44defa7d6901b6a9d08ffd0abc798cd17f1706088f24897d7efcaaaeef5
+  metadata.gz: 7c5b274de24813610fe09de2db614024f719d67b4987e6020b6cf403998f0386c866534f4db702287bb5f9e6ae8943e4ad489f3efad2334b57a4cf73362638ef
+  data.tar.gz: 0420c6b94f5ad7df4270cd76ff3525d529fa69f82dbaf6aa408bd8bf2d06002832acf5e9e9ed06ee07e7bd4d2b8ca4cd37c5bb557c9898252588c9434c923b4e

data/lib/DriverExecHelper.rb

@@ -189,7 +189,7 @@ module DriverExecHelper
                 cfg=file.read
             end
 
-            cfg.split(/\n/).each do |line|
+            cfg.split("\n").each do |line|
                 m=line.match(/^([^=]+)=(.*)$/)
 
                 next unless m

data/lib/HostSyncManager.rb

@@ -0,0 +1,111 @@
+# -------------------------------------------------------------------------- #
+# Copyright 2002-2023, OpenNebula Project, OpenNebula Systems                #
+#                                                                            #
+# 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.                                             #
+# -------------------------------------------------------------------------- #
+
+# rubocop:disable Lint/MissingCopEnableDirective
+# rubocop:disable Layout/FirstArgumentIndentation
+# rubocop:disable Layout/FirstHashElementIndentation
+# rubocop:disable Layout/HashAlignment
+# rubocop:disable Layout/HeredocIndentation
+# rubocop:disable Layout/IndentationWidth
+# rubocop:disable Style/HashSyntax
+# rubocop:disable Style/ParallelAssignment
+
+require 'CommandManager'
+
+# This helper module introduces a common routine that synchronizes
+# the "remotes".
+class HostSyncManager
+
+    def initialize(one_config = nil)
+        one_location = ENV['ONE_LOCATION']&.delete("'")
+        if one_location.nil?
+            @one_config_path         = '/var/lib/one/config'
+            @local_scripts_base_path = '/var/lib/one/remotes'
+        else
+            @one_config_path         = one_location + '/var/config'
+            @local_scripts_base_path = one_location + '/var/remotes'
+        end
+
+        # Do a simple parsing of the config file unless the values
+        # are already provided. NOTE: We don't care about "arrays" here..
+        one_config ||= File.read(@one_config_path).lines.each_with_object({}) \
+        do |line, object|
+            key, value = line.split('=').map(&:strip)
+            object[key.upcase] = value
+        end
+
+        @remote_scripts_base_path = one_config['SCRIPTS_REMOTE_DIR']
+        @remote_scripts_base_path&.delete!("'")
+    end
+
+    def update_remotes(hostname, logger = nil, copy_method = :rsync, subset = nil)
+        sources = '.'
+
+        if subset && copy_method == :rsync
+            # Make sure all files in the subset exist (and are relative).
+            subset.each do |path|
+                File.realpath path, @local_scripts_base_path
+            end
+
+            sources = subset.join(' ')
+        end
+
+        assemble_cmd = lambda do |steps|
+            "exec 2>/dev/null; #{steps.join(' && ')}"
+        end
+
+        case copy_method
+        when :ssh
+            mkdir_cmd = assemble_cmd.call [
+                "rm -rf '#{@remote_scripts_base_path}'/",
+                "mkdir -p '#{@remote_scripts_base_path}'/"
+            ]
+
+            sync_cmd = assemble_cmd.call [
+                "cd '#{@local_scripts_base_path}'/",
+                "scp -rp #{sources} " \
+                    "'#{hostname}':'#{@remote_scripts_base_path}'/"
+            ]
+        when :rsync
+            mkdir_cmd = assemble_cmd.call [
+                "mkdir -p '#{@remote_scripts_base_path}'/"
+            ]
+
+            sync_cmd = assemble_cmd.call [
+                "cd '#{@local_scripts_base_path}'/",
+                "rsync -LRaz --delete #{sources} " \
+                    "'#{hostname}':'#{@remote_scripts_base_path}'/"
+            ]
+        end
+
+        cmd = SSHCommand.run(mkdir_cmd, hostname, logger)
+        return cmd.code if error?(cmd)
+
+        cmd = LocalCommand.run(sync_cmd, logger)
+        return cmd.code if error?(cmd)
+
+        0
+    end
+
+    def error?(cmd)
+        return false if cmd.code == 0
+
+        STDERR.puts cmd.stderr
+        STDOUT.puts cmd.stdout
+        true
+    end
+
+end

data/lib/cloud/CloudClient.rb

@@ -51,7 +51,7 @@ end
 module CloudClient
 
     # OpenNebula version
-    VERSION = '6.6.2'
+    VERSION = '6.7.80'
 
     # #########################################################################
     # Default location for the authentication file

data/lib/host.rb

@@ -352,7 +352,7 @@ module VCenterDriver
             str_info << 'USEDMEMORY='  << (total_mem - free_mem).to_s << "\n"
 
             # DRS enabled
-            str_info << 'VCENTER_DRS='  << drs_enabled.to_s << "\n"
+            str_info << 'VCENTER_DRS=' << drs_enabled.to_s << "\n"
 
             # HA enabled
             str_info << 'VCENTER_HA=' << ha_enabled.to_s << "\n"

data/lib/opennebula/acl.rb

@@ -73,7 +73,8 @@ module OpenNebula
             "MARKETPLACE"   =>  0x8000000000000,
             "MARKETPLACEAPP"=> 0x10000000000000,
             "VMGROUP"       => 0x20000000000000,
-            "VNTEMPLATE"    => 0x40000000000000
+            "VNTEMPLATE"    => 0x40000000000000,
+            "BACKUPJOB"     =>0x100000000000000
         }
 
         RIGHTS =

data/lib/opennebula/backupjob.rb

@@ -0,0 +1,250 @@
+# -------------------------------------------------------------------------- #
+# Copyright 2002-2023, OpenNebula Project, OpenNebula Systems                #
+#                                                                            #
+# 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/lockable_ext'
+require 'opennebula/pool_element'
+
+module OpenNebula
+
+    # Class for representing a Backup Job object
+    class BackupJob < PoolElement
+
+        #######################################################################
+        # Constants and Class Methods
+        #######################################################################
+
+        BACKUPJOB_METHODS = {
+            :allocate    => 'backupjob.allocate',
+            :info        => 'backupjob.info',
+            :update      => 'backupjob.update',
+            :delete      => 'backupjob.delete',
+            :chown       => 'backupjob.chown',
+            :chmod       => 'backupjob.chmod',
+            :clone       => 'backupjob.clone',
+            :rename      => 'backupjob.rename',
+            :lock        => 'backupjob.lock',
+            :unlock      => 'backupjob.unlock',
+            :backup      => 'backupjob.backup',
+            :cancel      => 'backupjob.cancel',
+            :retry       => 'backupjob.retry',
+            :priority    => 'backupjob.priority',
+            :schedadd    => 'backupjob.schedadd',
+            :scheddelete => 'backupjob.scheddelete',
+            :schedupdate => 'backupjob.schedupdate'
+        }
+
+        # Creates a BackupJob description with just its identifier
+        # this method should be used to create plain BackupJob objects.
+        # +id+ the id of the user
+        #
+        # Example:
+        #   bj = BackupJob.new(BackupJob.build_xml(3),rpc_client)
+        #
+        def self.build_xml(pe_id = nil)
+            if pe_id
+                obj_xml = "<BACKUPJOB><ID>#{pe_id}</ID></BACKUPJOB>"
+            else
+                obj_xml = '<BACKUPJOB></BACKUPJOB>'
+            end
+
+            XMLElement.build_xml(obj_xml, 'BACKUPJOB')
+        end
+
+        # Class constructor
+        def initialize(xml, client)
+            LockableExt.make_lockable(self, BACKUPJOB_METHODS)
+
+            super(xml, client)
+
+            @client = client
+        end
+
+        #######################################################################
+        # XML-RPC Methods for the Backup Job Object
+        #######################################################################
+
+        # Retrieves the information of the given Backup Job.
+        def info
+            return Error.new('ID not defined') unless @pe_id
+
+            rc = @client.call(BACKUPJOB_METHODS[:info], @pe_id)
+
+            if !OpenNebula.is_error?(rc)
+                initialize_xml(rc, 'BACKUPJOB')
+                rc = nil
+
+                @pe_id = self['ID'].to_i if self['ID']
+                @name  = self['NAME'] if self['NAME']
+            end
+
+            rc
+        end
+
+        alias info! info
+
+        # Allocates a new Backup Job in OpenNebula
+        #
+        # @param description [String] The contents of the BackupJob.
+        #
+        # @return [nil, OpenNebula::Error] nil in case of success, Error
+        #   otherwise
+        def allocate(description)
+            super(BACKUPJOB_METHODS[:allocate], description)
+        end
+
+        # Deletes the BackupJob
+        #
+        # @return [nil, OpenNebula::Error] nil in case of success, Error
+        #   otherwise
+        def delete
+            call(BACKUPJOB_METHODS[:delete], @pe_id)
+        end
+
+        # Replaces the Backup Job contents
+        #
+        # @param new_template [String] New template contents
+        # @param append [true, false] True to append new attributes instead of
+        #   replace the whole template
+        #
+        # @return [nil, OpenNebula::Error] nil in case of success, Error
+        #   otherwise
+        def update(new_template, append = false)
+            super(BACKUPJOB_METHODS[:update], new_template, append ? 1 : 0)
+        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(BACKUPJOB_METHODS[:chown], uid, gid)
+        end
+
+        # Changes the Backup Job 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(BACKUPJOB_METHODS[:chmod], octet)
+        end
+
+        # Changes the Backup Job 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
+        # rubocop:disable Metrics/ParameterLists
+        def chmod(owner_u, owner_m, owner_a, group_u, group_m, group_a, other_u,
+                  other_m, other_a)
+            call(BACKUPJOB_METHODS[:chmod], @pe_id, owner_u, owner_m, owner_a, group_u,
+                 group_m, group_a, other_u, other_m, other_a)
+        end
+        # rubocop:enable Metrics/ParameterLists
+
+        # Renames this Backup Job
+        #
+        # @param name [String] New name for the Backup Job.
+        #
+        # @return [nil, OpenNebula::Error] nil in case of success, Error
+        #   otherwise
+        def rename(name)
+            call(BACKUPJOB_METHODS[:rename], @pe_id, name)
+        end
+
+        # Starts the Backup Job
+        #
+        # @return [nil, OpenNebula::Error] nil in case of success, Error
+        #   otherwise
+        def backup
+            call(BACKUPJOB_METHODS[:backup], @pe_id)
+        end
+
+        # Cancel pending Backup Job, removing VMs from waiting list
+        #
+        # @return [nil, OpenNebula::Error] nil in case of success, Error
+        #   otherwise
+        def cancel
+            call(BACKUPJOB_METHODS[:cancel], @pe_id)
+        end
+
+        # Retry backup for VMs in error list
+        #
+        # @return [nil, OpenNebula::Error] nil in case of success, Error
+        #   otherwise
+        def retry
+            call(BACKUPJOB_METHODS[:retry], @pe_id)
+        end
+
+        # Change priority of Backup Job
+        #
+        # @return [nil, OpenNebula::Error] nil in case of success, Error
+        #   otherwise
+        def priority(pr)
+            call(BACKUPJOB_METHODS[:priority], @pe_id, pr)
+        end
+
+        # Add Scheduled action
+        #
+        # @param sched_template [String] Template with SCHED_ACTIONs
+        # @return [nil, OpenNebula::Error] nil in case of success, Error
+        #   otherwise
+        def sched_action_add(sched_template)
+            call(BACKUPJOB_METHODS[:schedadd], @pe_id, sched_template)
+        end
+
+        # Delete Scheduled Action
+        #
+        # @param sched_id [Int] id of the SCHED_ACTION
+        # @return [nil, OpenNebula::Error] nil in case of success, Error
+        #   otherwise
+        def sched_action_delete(sched_id)
+            call(BACKUPJOB_METHODS[:scheddelete], @pe_id, sched_id.to_i)
+        end
+
+        # Update Scheduled Action
+        #
+        # @param sched_id [Int] id of the SCHED_ACTION
+        # @param sched_template [String] Template containing a SCHED_ACTION
+        # @return [nil, OpenNebula::Error] nil in case of success, Error
+        #   otherwise
+        def sched_action_update(sched_id, sched_template)
+            call(BACKUPJOB_METHODS[:schedupdate], @pe_id,
+                 sched_id.to_i, sched_template)
+        end
+
+        #######################################################################
+        # Helpers to get Template information
+        #######################################################################
+
+        # Returns the group identifier
+        # [return] _Integer_ the element's group ID
+        def gid
+            self['GID'].to_i
+        end
+
+        def owner_id
+            self['UID'].to_i
+        end
+
+        def public?
+            self['PERMISSIONS/GROUP_U'] == '1' || self['PERMISSIONS/OTHER_U'] == '1'
+        end
+
+    end
+
+end

data/lib/opennebula/backupjob_pool.rb

@@ -0,0 +1,82 @@
+# -------------------------------------------------------------------------- #
+# Copyright 2002-2023, OpenNebula Project, OpenNebula Systems                #
+#                                                                            #
+# 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'
+
+module OpenNebula
+
+    # Class representing a Backup Job pool
+    class BackupJobPool < Pool
+
+        #######################################################################
+        # Constants and Class attribute accessors
+        #######################################################################
+
+        BACKUPJOB_POOL_METHODS = {
+            :info => 'backupjobpool.info'
+        }
+
+        #######################################################################
+        # Class constructor & Pool Methods
+        #######################################################################
+
+        # +client+ a Client object that represents an XML-RPC connection
+        # +user_id+ used to refer to a Pool with Templates from that user
+        def initialize(client, user_id = -1)
+            super('BACKUPJOB_POOL', 'BACKUPJOB', client)
+
+            @user_id = user_id
+        end
+
+        # Factory method to create Backup Job objects
+        def factory(element_xml)
+            OpenNebula::BackupJob.new(element_xml, @client)
+        end
+
+        #######################################################################
+        # XML-RPC Methods for the Template Object
+        #######################################################################
+
+        # Retrieves all or part of the Templates in the pool.
+        def info(*args)
+            case args.size
+            when 0
+                info_filter(BACKUPJOB_POOL_METHODS[:info], @user_id, -1, -1)
+            when 3
+                info_filter(BACKUPJOB_POOL_METHODS[:info], args[0], args[1], args[2])
+            end
+        end
+
+        def info_all
+            super(BACKUPJOB_POOL_METHODS[:info])
+        end
+
+        def info_mine
+            super(BACKUPJOB_POOL_METHODS[:info])
+        end
+
+        def info_group
+            super(BACKUPJOB_POOL_METHODS[:info])
+        end
+
+        alias info! info
+        alias info_all! info_all
+        alias info_mine! info_mine
+        alias info_group! info_group
+
+    end
+
+end

data/lib/opennebula/client.rb

@@ -140,9 +140,9 @@ module OpenNebula
                 @one_endpoint = endpoint
             elsif ENV["ONE_XMLRPC"]
                 @one_endpoint = ENV["ONE_XMLRPC"]
-            elsif ENV['HOME'] and File.exists?(ENV['HOME']+"/.one/one_endpoint")
+            elsif ENV['HOME'] and File.exist?(ENV['HOME']+"/.one/one_endpoint")
                 @one_endpoint = File.read(ENV['HOME']+"/.one/one_endpoint")
-            elsif File.exists?("/var/lib/one/.one/one_endpoint")
+            elsif File.exist?("/var/lib/one/.one/one_endpoint")
                 @one_endpoint = File.read("/var/lib/one/.one/one_endpoint")
             else
                 @one_endpoint = "http://localhost:2633/RPC2"

data/lib/opennebula/group.rb

@@ -37,7 +37,7 @@ module OpenNebula
         SELF = -1
 
         # Default resource ACL's for group users (create)
-        GROUP_DEFAULT_ACLS = "VM+IMAGE+TEMPLATE+DOCUMENT+SECGROUP+VROUTER+VMGROUP"
+        GROUP_DEFAULT_ACLS = "VM+IMAGE+TEMPLATE+DOCUMENT+SECGROUP+VROUTER+VMGROUP+BACKUPJOB"
 
         # The default view for group and group admins, must be defined in
         # sunstone_views.yaml

data/lib/opennebula/ldap_auth.rb

@@ -89,7 +89,7 @@ class OpenNebula::LdapAuth
         file=@options[:mapping_file_path]
         generate = false
 
-        if File.exists?(file)
+        if File.exist?(file)
             stat = File.stat(file)
             age = Time.now.to_i - stat.mtime.to_i
             generate = true if age > @options[:mapping_timeout]
@@ -124,7 +124,7 @@ class OpenNebula::LdapAuth
 
         @mapping = {}
 
-        if File.exists?(file)
+        if File.exist?(file)
             @mapping = YAML.load(File.read(file))
         end
 

data/lib/opennebula/lockable_ext.rb

@@ -125,6 +125,7 @@ module OpenNebula::LockableExt
     def self.lockable?(obj)
         # Lockable classes
         lockable = [
+            OpenNebula::BackupJob,
             OpenNebula::Document,
             OpenNebula::Hook,
             OpenNebula::Image,