opennebula-cli 6.10.2 → 6.99.85.pre

data/lib/one_helper/onevcenter_helper.rb

@@ -1,523 +0,0 @@
-# -------------------------------------------------------------------------- #
-# Copyright 2002-2024, 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 'one_helper'
-
-##############################################################################
-# Module OneVcenterHelper
-##############################################################################
-class OneVcenterHelper < OpenNebulaHelper::OneHelper
-
-    #
-    # vCenter importer will divide rvmomi resources
-    # in this group, makes parsing easier.
-    module VOBJECT
-
-        DATASTORE = 1
-        TEMPLATE  = 2
-        NETWORK   = 3
-        IMAGE     = 4
-        HOST      = 5
-
-    end
-
-    #
-    # onevcenter helper main constant
-    # This will control everything displayed on STDOUT
-    # Resources (above) uses this table
-    #
-    # struct:   [Array] LIST FORMAT for opennebula cli
-    #           related methods: * cli_format
-    #
-    # columns:  [Hash(column => Integer)] Will be used in the list command,
-    #           Integer represent nbytes
-    #           related methods: * format_list
-    #
-    # cli:      [Array] with mandatory args, for example image
-    #           listing needs a datastore
-    #           related methods: * parse_opts
-    #
-    # dialogue: [Lambda] Used only for Vobject that require a previous
-    #                    dialogue with the user, will be triggered
-    #                    on importation process
-    #           related methods: * network_dialogue
-    #                            * template_dialogue
-    #
-    TABLE = {
-        VOBJECT::DATASTORE => {
-            :struct  => ['DATASTORE_LIST', 'DATASTORE'],
-            :columns =>
-                { :IMID => 5, :REF => 15, :NAME => 50, :CLUSTERS => 10 },
-            :cli     => [:host],
-            :dialogue => ->(arg) {}
-        },
-        VOBJECT::TEMPLATE => {
-            :struct  => ['TEMPLATE_LIST', 'TEMPLATE'],
-            :columns => { :IMID => 5, :REF => 10, :NAME => 50 },
-            :cli     => [:host],
-            :dialogue => ->(arg) { OneVcenterHelper.template_dialogue(arg) }
-        },
-        VOBJECT::NETWORK => {
-            :struct  => ['NETWORK_LIST', 'NETWORK'],
-            :columns => {
-                :IMID => 5,
-                :REF => 15,
-                :NAME => 30,
-                :CLUSTERS => 20
-            },
-            :cli     => [:host],
-            :dialogue => ->(arg) { OneVcenterHelper.network_dialogue(arg) }
-        },
-        VOBJECT::IMAGE => {
-            :struct  => ['IMAGE_LIST', 'IMAGE'],
-            :columns => { :IMID => 5, :REF => 35, :PATH => 60 },
-            :cli     => [:host, :datastore],
-            :dialogue => ->(arg) {}
-        },
-        VOBJECT::HOST => {
-            :struct  => ['HOST_LIST', 'HOST'],
-            :columns => { :DATACENTER => 10, :NAME => 30, :REF => 35 },
-            :cli     => [],
-            :dialogue => ->(arg) {}
-        }
-    }
-
-    ################################################################
-    # CLI ARGS
-    ################################################################
-
-    # these methods will be used by table :cli property
-    # the purpose is to inject code when -d option in this case is used
-    #
-    # @param arg [String] The parameter passed to the option:w
-    #
-
-    def datastore(arg)
-        ds = VCenterDriver::VIHelper.one_item(OpenNebula::Datastore, arg)
-
-        {
-            :ds_ref => ds['TEMPLATE/VCENTER_DS_REF'],
-            :one_item => ds
-        }
-    end
-
-    def host(arg)
-        arg
-    end
-
-    ########################
-
-    # In list command you can use this method to print a header
-    #
-    # @param vcenter_host [String] this text will be displayed
-    #
-    def show_header(vcenter_host)
-        CLIHelper.scr_bold
-        CLIHelper.scr_underline
-        puts "# vCenter: #{vcenter_host}".ljust(50)
-        CLIHelper.scr_restore
-        puts
-    end
-
-    # Using for parse a String into a VOBJECT
-    # We will use VOBJECT instances for handle any operatiion
-    #
-    # @param type [String] String representing the vCenter resource
-    #
-    def object_update(type)
-        raise 'you need to use -o option!' unless type
-
-        type = type.downcase
-        case type
-        when 'datastores'
-            @vobject = VOBJECT::DATASTORE
-        when 'templates'
-            @vobject = VOBJECT::TEMPLATE
-        when 'networks'
-            @vobject = VOBJECT::NETWORK
-        when 'images'
-            @vobject = VOBJECT::IMAGE
-        when 'hosts'
-            @vobject = VOBJECT::HOST
-        else
-            puts "unknown #{type} type option"
-            puts '  -o options:'
-            puts '      datastores'
-            puts '      templates'
-            puts '      networks'
-            puts '      images'
-            puts '      hosts'
-
-            exit 0
-        end
-    end
-
-    # Handles connection to vCenter.
-    #
-    # @param options [Hash] options for the connection
-    #
-    def connection_options(object_name, options)
-        if  options[:vuser].nil? || options[:vcenter].nil?
-            raise 'vCenter connection parameters are mandatory to import'\
-                  " #{object_name}:\n"\
-                  "\t --vcenter vCenter hostname\n"\
-                  "\t --vuser username to login in vcenter"
-        end
-
-        password = options[:vpass] || OpenNebulaHelper::OneHelper.get_password
-        {
-            :user     => options[:vuser],
-            :password => password,
-            :host     => options[:vcenter],
-            :port     => options[:port]
-        }
-    end
-
-    def cli_format(hash)
-        {
-            TABLE[@vobject][:struct].first =>
-                {
-                    TABLE[@vobject][:struct].last =>
-                        hash.values
-                }
-        }
-    end
-
-    # General method to list vCenter objects
-    #
-    # @param options [Hash] User CLI options
-    # @param args    [Hash] Search arguments
-    def list(options, args)
-        if !options[:host]
-            # This case is to list available hosts, instead other object
-            list_hosts(options)
-        else
-            vi_client = VCenterDriver::VIClient.new_from_host(
-                options[:host]
-            )
-            importer = VCenterDriver::VcImporter.new_child(
-                @client,
-                vi_client,
-                options[:object]
-            )
-
-            list_object(options, importer.retrieve_resources(args))
-        end
-    end
-
-    # This method will print a list for a vcenter_resource.
-    #
-    def list_object(options, list)
-        vcenter_host = list.keys[0]
-        list = cli_format(list.values.first)
-        table = format_list
-
-        show_header(vcenter_host)
-
-        table.show(list, options)
-    end
-
-    # List unimported hosts
-    #
-    # @param options [Hash] User CLI options
-    def list_hosts(options)
-        con_ops   = connection_options('hosts', options)
-        vi_client = VCenterDriver::VIClient.new(con_ops)
-        dc_folder = VCenterDriver::DatacenterFolder.new(vi_client)
-        hpool     = VCenterDriver::VIHelper.one_pool(OpenNebula::HostPool,
-                                                     false)
-
-        VCenterDriver::VIHelper.set_client(nil, @client)
-
-        list  = []
-        hosts = dc_folder.get_unimported_hosts(hpool, vi_client.vim.host)
-
-        hosts.each do |key, value|
-            value.each do |v|
-                v[:datacenter] = key
-                list << v
-            end
-        end
-
-        format_list.show(hosts, options)
-    end
-
-    # handles :cli section of TABLE
-    # used for executing the dialogue in some VOBJECTS
-    #
-    # @param object_info [Hash] This is the object
-    #                           with all the info related to the object
-    #                           that will be imported
-    #
-    def cli_dialogue(object_info)
-        TABLE[@vobject][:dialogue].call(object_info)
-    end
-
-    # This method iterates over the possible options for certain resources
-    # and will raise an error in case of missing mandatory param
-    #
-    # @param opts [Hash] options object passed to the onecenter tool
-    #
-    def parse_opts(opts)
-        object_update(opts[:object])
-
-        res = {}
-        TABLE[@vobject][:cli].each do |arg|
-            raise "#{arg} it's mandadory for this op" if opts[arg].nil?
-
-            res[arg] = method(arg).call(opts[arg])
-        end
-
-        res[:config] = parse_file(opts[:configuration]) if opts[:configuration]
-
-        res
-    end
-
-    # This method will parse a yaml
-    # Only used for a feature that adds the posibility
-    # of import resources with custom params (bulk)
-    #
-    # @param path [String] Path of the file
-    #
-    def parse_file(path)
-        begin
-            _config = YAML.safe_load(File.read(path))
-        rescue StandardError => _e
-            str_error="Unable to read '#{path}'. Invalid YAML syntax:\n"
-
-            raise str_error
-        end
-    end
-
-    # Use the attributes provided by TABLE
-    # with the purpose of build a complete CLI list
-    # OpenNebula way
-    #
-    def format_list
-        config = TABLE[@vobject][:columns]
-        CLIHelper::ShowTable.new do
-            column :DATACENTER,
-                   'Object datacenter',
-                   :size => config[:DATACENTER] || 15 do |d|
-                d[:datacenter]
-            end
-
-            column :IMID, 'identifier for ...', :size=>config[:IMID] || 4 do |d|
-                d[:import_id]
-            end
-
-            column :REF, 'ref', :left, :adjust, :size=>config[:REF] || 15 do |d|
-                d[:ref] || d[:cluster_ref]
-            end
-
-            column :NAME, 'Name', :left, :expand,
-                   :size=>config[:NAME] || 20 do |d|
-                d[:name] || d[:simple_name]
-            end
-
-            column :CLUSTERS, 'CLUSTERS', :left,
-                   :size=>config[:CLUSTERS] || 10 do |d|
-                d = d[:clusters] if d[:clusters]
-                d[:one_ids] || d[:cluster].to_s
-            end
-
-            column :PATH, 'PATH', :left, :expand,
-                   :size=>config[:PATH] || 10 do |d|
-                d[:path]
-            end
-
-            default(*config.keys)
-        end
-    end
-
-    ################################################################
-    # CLI DIALOGUES
-    ################################################################
-    def self.template_dialogue(t)
-        rps_list = lambda {
-            return '' if t[:rp_list].empty?
-
-            puts
-            t[:rp_list].each do |rp|
-                puts "      #{rp[:name]}"
-            end
-            puts
-
-            return STDIN.gets.strip.downcase
-        }
-
-        # default opts
-        opts = {
-            :linked_clone => '0',
-            :copy => '0',
-            :name => '',
-            :folder => '',
-            :resourcepool => [],
-            :type => ''
-        }
-
-        STDOUT.print "\n- Template: \e[92m#{t[:template_name]}\e[39m\n\n"\
-
-        # LINKED CLONE OPTION
-        STDOUT.print "\n    For faster deployment operations"\
-                     ' and lower disk usage, OpenNebula'\
-                     ' can create new VMs as linked clones.'\
-                     "\n    Would you like to use Linked Clones"\
-                     ' with VMs based on this template (y/[n])? '
-
-        if STDIN.gets.strip.downcase == 'y'
-            opts[:linked_clone] = '1'
-
-            # CREATE COPY OPTION
-            STDOUT.print "\n    Linked clones requires that delta"\
-                         ' disks must be created for '\
-                         'each disk in the template.'\
-                         ' This operation may change the template contents.'\
-                         " \n    Do you want OpenNebula to "\
-                         'create a copy of the template,'\
-                         ' so the original template remains untouched ([y]/n)? '
-
-            if STDIN.gets.strip.downcase != 'n'
-                opts[:copy] = '1'
-
-                # NAME OPTION
-                STDOUT.print "\n    The new template will be named"\
-                             ' adding a one- prefix to the name'\
-                             " of the original template. \n"\
-                             '    If you prefer a different name'\
-                             ' please specify or press Enter'\
-                             ' to use defaults: '
-
-                template_name = STDIN.gets.strip.downcase
-                opts[:name] = template_name
-
-                STDOUT.print "\n    WARNING!!! The cloning "\
-                             'operation can take some time'\
-                             " depending on the size of disks.\n"
-            end
-        end
-
-        sdtout_print = "\n\n    Do you want to specify a folder where"\
-        ' the deployed VMs based on this template will appear'\
-        " in vSphere's VM and Templates section?"\
-        "\n    If no path is set, VMs will be placed in the same"\
-        ' location where the template lives.'\
-        "\n    Please specify a path using slashes to separate folders"\
-        ' e.g /Management/VMs or press Enter to use defaults: '\
-
-        STDOUT.print sdtout_print
-
-        vcenter_vm_folder = STDIN.gets.strip
-        opts[:folder] = vcenter_vm_folder
-
-        STDOUT.print "\n\n    This template is currently set to "\
-            'launch VMs in the default resource pool.'\
-            "\n    Press y to keep this behaviour, n to select"\
-            ' a new resource pool or d to delegate the choice'\
-            ' to the user ([y]/n/d)? '
-
-        answer = STDIN.gets.strip.downcase
-
-        case answer.downcase
-        when 'd' || 'delegate'
-            opts[:type]='list'
-            puts "separate with commas ',' the list that you want to deleate:"
-
-            opts[:resourcepool] = rps_list.call.gsub(/\s+/, '').split(',')
-
-        when 'n' || 'no'
-            opts[:type]='fixed'
-            puts 'choose the proper name'
-            opts[:resourcepool] = rps_list.call
-        else
-            opts[:type]='default'
-        end
-
-        opts
-    end
-
-    def self.network_dialogue(n)
-        ask = lambda {|question, default = ''|
-            STDOUT.print question
-            answer = STDIN.gets.strip
-
-            answer = default if answer.empty?
-
-            return answer
-        }
-
-        STDOUT.print "\n- Network: \e[92m#{n[:name]}\e[39m\n\n"\
-
-        opts = { :size => '255', :type => 'ether' }
-
-        question =  '    How many VMs are you planning'\
-                    ' to fit into this network [255]? '
-        opts[:size] = ask.call(question, '255')
-
-        question = '    What type of Virtual Network'\
-                   ' do you want to create (IPv[4],IPv[6], [E]thernet)? '
-        type_answer = ask.call(question, 'ether')
-
-        supported_types = ['4', '6', 'ether', 'e', 'ip4', 'ip6']
-        if !supported_types.include?(type_answer)
-            type_answer = 'e'
-            STDOUT.puts "    Type [#{type_answer}] not supported,"\
-                        ' defaulting to Ethernet.'
-        end
-        question_ip =
-            '    Please input the first IP in the range: '
-        question_mac =
-            '    Please input the first MAC in the range [Enter for default]: '
-
-        case type_answer.downcase
-        when '4', 'ip4'
-            opts[:ip]  = ask.call(question_ip)
-            opts[:mac] = ask.call(question_mac)
-            opts[:type] = 'ip'
-        when '6', 'ip6'
-            opts[:mac] = ask.call(question_mac)
-
-            question =   '    Do you want to use SLAAC '\
-                         'Stateless Address Autoconfiguration? ([y]/n): '
-            slaac_answer = ask.call(question, 'y').downcase
-
-            if slaac_answer == 'n'
-                question =
-                    '    Please input the IPv6 address (cannot be empty): '
-                opts[:ip6] = ask.call(question)
-
-                question =
-                    '    Please input the Prefix length (cannot be empty): '
-                opts[:prefix_length] = ask.call(question)
-                opts[:type] = 'ip6_static'
-            else
-                question = '    Please input the GLOBAL PREFIX '\
-                            '[Enter for default]: '
-                opts[:global_prefix] = ask.call(question)
-
-                question= '    Please input the ULA PREFIX '\
-                           '[Enter for default]: '
-                opts[:ula_prefix] = ask.call(question)
-                opts[:type] = 'ip6'
-            end
-        when 'e', 'ether'
-            opts[:mac] = ask.call(question_mac)
-        end
-
-        opts
-    end
-
-end