lorj 0.2.0 → 1.0.0

data/lib/core_process/cloud/process/common.rb

@@ -0,0 +1,63 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+
+# (c) Copyright 2014 Hewlett-Packard Development Company, L.P.
+#
+#    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.
+
+# It requires Core objects to be defined + default ForjProcess functions.
+
+# Define framework object on BaseDefinition
+module Lorj
+  # Common definition
+  class BaseDefinition
+    # All objects used by this process are built from a Controller
+    process_default :use_controller => true
+  end
+end
+
+# Class to manage retry on errors before failing
+class SSLErrorMgt
+  def initialize(iMaxRetry = 5)
+    @retry = 0
+    @max_retry = iMaxRetry
+  end
+
+  def wait(message, issue = nil)
+    if @retry < @max_retry
+      sleep(2)
+      @retry += 1
+      if PrcLib.level == 0
+        msg = format('%s/%s try... ', @retry, @max_retry)
+        msg += issue unless issue.nil?
+        print msg
+      end
+      return false
+    else
+      PrcLib.error('Too many retry. %s', message)
+      return true
+    end
+  end
+
+  def error_detected(message, backtrace, e)
+    if message.match('SSLv2/v3 read server hello A: unknown protocol')
+      return wait(message, "'unknown protocol' SSL Error")
+    elsif e.is_a?(Excon::Errors::InternalServerError)
+      return wait(message, ANSI.red(e.class))
+    else
+      PrcLib.error("Exception %s: %s\n%s", e.class, message,
+                   backtrace.join("\n"))
+      return true
+    end
+  end
+end

data/lib/core_process/cloud/process/connection.rb

@@ -0,0 +1,93 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+
+# (c) Copyright 2014 Hewlett-Packard Development Company, L.P.
+#
+#    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.
+
+# It requires Core objects to be defined + default ForjProcess functions.
+
+# Connection process code
+class CloudProcess
+  def connect(sCloudObj, hParams)
+    ssl_error_obj = SSLErrorMgt.new # Retry object
+    PrcLib.debug("%s:%s Connecting to '%s' "\
+                 "- Project '%s'",
+                 self.class, sCloudObj, config[:provider], hParams[:tenant])
+    begin
+      controller_connect(sCloudObj)
+   rescue => e
+     retry unless ssl_error_obj.error_detected(e.message, e.backtrace, e)
+
+     PrcLib.error('%s:%s: Unable to connect.\n%s',
+                  self.class, sCloudObj, e.message)
+     nil
+    end
+  end
+end
+
+# Define framework object on BaseDefinition
+module Lorj
+  # Define services model
+  class BaseDefinition
+    # predefined list of objects.
+    # Links between objects is not predefined. To do it, use needs declaration
+    # in your provider class.
+
+    # object to get list of services
+    # Defines Process handler to call
+    define_obj(:services,
+
+               :create_e => :connect
+               )
+    obj_needs :data, :auth_uri
+    obj_needs :data, :account_id
+    obj_needs :data, :account_key
+    obj_needs :data, :tenant
+
+    undefine_attribute :id    # Do not return any predefined ID
+    undefine_attribute :name  # Do not return any predefined NAME
+  end
+
+  # compute_connection
+  class BaseDefinition
+    define_obj(:compute_connection,
+
+               :create_e => :connect # Will call ForjProcess connect
+               )
+    obj_needs :data, :account_id
+    obj_needs :data, :account_key
+    obj_needs :data, :auth_uri
+    obj_needs :data, :tenant
+    obj_needs :data, :compute
+
+    undefine_attribute :id    # Do not return any predefined ID
+    undefine_attribute :name  # Do not return any predefined NAME
+  end
+
+  # network_connection
+  class BaseDefinition
+    define_obj(:network_connection,
+
+               :create_e => :connect
+               )
+    obj_needs :data, :account_id
+    obj_needs :data, :account_key
+    obj_needs :data, :auth_uri
+    obj_needs :data, :tenant
+    obj_needs :data, :network
+
+    undefine_attribute :id    # Do not return any predefined ID
+    undefine_attribute :name  # Do not return any predefined NAME
+  end
+end

data/lib/core_process/cloud/process/external_network.rb

@@ -0,0 +1,94 @@
+# encoding: UTF-8
+
+# (c) Copyright 2014 Hewlett-Packard Development Company, L.P.
+#
+#    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.
+
+# It requires Core objects to be defined + default ForjProcess functions.
+
+# External network process attached to a network
+class CloudProcess
+  def forj_get_or_create_ext_net(sCloudObj, hParams)
+    PrcLib.state("Checking router '%s' gateway", hParams[:router, :name])
+
+    router_obj = hParams[:router]
+    router_name = hParams[:router, :name]
+    network_id = hParams[:router, :gateway_network_id]
+    if network_id
+      external_network = forj_query_external_network(sCloudObj,
+                                                     { :id => network_id },
+                                                     hParams)
+      PrcLib.info("Router '%s' is attached to the "\
+                  "external gateway '%s'.", router_name,
+                  external_network[:name])
+    else
+      PrcLib.info("Router '%s' needs to be attached to an "\
+                  'external gateway.', router_name)
+      PrcLib.state('Attaching')
+      external_network = forj_query_external_network(:network, {}, hParams)
+      if !external_network.empty?
+        router_obj[:gateway_network_id] = external_network[:id]
+        forj_update_router(:router, hParams)
+        PrcLib.info("Router '%s' attached to the "\
+                    "external network '%s'.",
+                    router_name, external_network[:name])
+      else
+        PrcLib.fatal(1, "Unable to attach router '%s' to an external gateway. "\
+                        'Required for boxes to get internet access. ',
+                     get_data(:router, :name))
+      end
+    end
+
+    # Need to keep the :network object as :external_network object type.
+    external_network.type = sCloudObj
+    external_network
+  end
+
+  def forj_query_external_network(_sCloudObj, sQuery, _hParams)
+    PrcLib.state('Identifying External gateway')
+    begin
+      # Searching for external network
+      networks = controller_query(:network, sQuery.merge(:external => true))
+
+      case networks.length
+      when 0
+        PrcLib.info('No external network')
+        nil
+      when 1
+        PrcLib.info("Found external network '%s'.", networks[0, :name])
+        networks[0]
+      else
+        PrcLib.warning('Found several external networks. '\
+                       "Selecting the first one '%s'", networks[0, :name])
+        networks[0]
+      end
+   rescue => e
+     PrcLib.error("%s\n%s", e.message, e.backtrace.join("\n"))
+    end
+  end
+end
+
+# Define framework object on BaseDefinition
+module Lorj
+  # Identify an external network thanks to the network router.
+  class BaseDefinition
+    define_obj(:external_network,
+
+               :create_e => :forj_get_or_create_ext_net,
+               :query_e => :forj_query_external_network
+               )
+
+    obj_needs :CloudObject,  :network_connection
+    obj_needs :CloudObject,  :router
+  end
+end

data/lib/core_process/cloud/process/flavor.rb

@@ -0,0 +1,99 @@
+# encoding: UTF-8
+
+# (c) Copyright 2014 Hewlett-Packard Development Company, L.P.
+#
+#    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.
+
+# It requires Core objects to be defined + default ForjProcess functions.
+
+# ---------------------------------------------------------------------------
+# flavor management
+# ---------------------------------------------------------------------------
+class CloudProcess
+  # Depending on clouds/rights, we can create flavor or not.
+  # Usually, flavor records already exists, and the controller may map them
+  # CloudProcess predefines some values. Consult CloudProcess.rb for details
+  def forj_get_or_create_flavor(sCloudObj, hParams)
+    flavor_name = hParams[:flavor_name]
+    PrcLib.state("Searching for flavor '%s'", flavor_name)
+
+    flavors = query_flavor(sCloudObj, { :name => flavor_name }, hParams)
+    if flavors.length == 0
+      if !hParams[:create]
+        PrcLib.error("Unable to create %s '%s'. Creation is not "\
+                     'supported.', sCloudObj, flavor_name)
+        ForjLib::Data.new.set(nil, sCloudObj)
+      else
+        create_flavor(sCloudObj, hParams)
+      end
+    else
+      flavors[0]
+    end
+  end
+
+  # Should return 1 or 0 flavor.
+  def query_flavor(sCloudObj, sQuery, hParams)
+    flavor_name = hParams[:flavor_name]
+    list = forj_query_flavor(sCloudObj, sQuery, hParams)
+    query_single(sCloudObj, list, sQuery, flavor_name)
+  end
+
+  # Should return 1 or 0 flavor.
+  def forj_query_flavor(sCloudObj, sQuery, _hParams)
+    ssl_error_obj = SSLErrorMgt.new
+    begin
+      list = controller_query(sCloudObj, sQuery)
+    rescue => e
+      retry unless ssl_error_obj.error_detected(e.message, e.backtrace, e)
+    end
+    list
+  end
+end
+
+# Define framework object on BaseDefinition
+module Lorj
+  # ************************************ Flavor Object
+  # Identify flavor
+  class BaseDefinition # rubocop: disable ClassAndModuleChildren
+    define_obj(:flavor,
+
+               :create_e => :forj_get_or_create_flavor,
+               :query_e => :forj_query_flavor
+               #         :get_e      => :forj_get_flavor,
+               #         :update_e   => :forj_update_flavor,
+               #         :delete_e   => :forj_delete_flavor
+               )
+
+    obj_needs :CloudObject,  :compute_connection
+    obj_needs :data,         :flavor_name,         :for => [:create_e]
+    # Cloud provider will need to map to one of those predefined flavors.
+    # limitation values may match exactly or at least ensure those limitation
+    # are under provider limitation
+    # ie, at least the CloudProcess limitation can less than the
+    # Cloud provider defines.
+    # CloudProcess EHD = 160, then Provider EHD = 200 is ok
+    # but Provider EHD = 150 is not ok.
+    predefine_data_value('tiny',    :desc => 'VCU: 1,  RAM:512M, HD:1G,   '\
+                                             'EHD: 0G,   Swap: 0G')
+    predefine_data_value('xsmall',  :desc => 'VCU: 1,  RAM:1G,   HD:10G,  '\
+                                             'EHD: 10G,  Swap: 0G')
+    predefine_data_value('small',   :desc => 'VCU: 2,  RAM:2G,   HD:30G,  '\
+                                             'EHD: 10G,  Swap: 0G')
+    predefine_data_value('medium',  :desc => 'VCU: 2,  RAM:4G,   HD:30G,  '\
+                                             'EHD: 50G,  Swap: 0G')
+    predefine_data_value('large',   :desc => 'VCU: 4,  RAM:8G,   HD:30G,  '\
+                                             'EHD: 100G, Swap: 0G')
+    predefine_data_value('xlarge',  :desc => 'VCU: 8,  RAM:16G,  HD:30G,  '\
+                                             'EHD: 200G, Swap: 0G')
+  end
+end

data/lib/core_process/cloud/process/images.rb

@@ -0,0 +1,87 @@
+# encoding: UTF-8
+
+# (c) Copyright 2014 Hewlett-Packard Development Company, L.P.
+#
+#    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.
+
+# It requires Core objects to be defined + default ForjProcess functions.
+
+# ---------------------------------------------------------------------------
+# Image management
+# ---------------------------------------------------------------------------
+class CloudProcess
+  def forj_get_or_create_image(sCloudObj, hParams)
+    image_name = hParams[:image_name]
+    PrcLib.state("Searching for image '%s'", image_name)
+
+    search_the_image(sCloudObj, { :name => image_name }, hParams)
+    # No creation possible.
+  end
+
+  def search_the_image(sCloudObj, sQuery, hParams)
+    image_name = hParams[:image_name]
+    images = forj_query_image(sCloudObj, sQuery, hParams)
+    case images.length
+    when 0
+      PrcLib.info("No image '%s' found", image_name)
+      nil
+    when 1
+      PrcLib.info("Found image '%s'.", image_name)
+      images[0, :ssh_user] = ssh_user(images[0, :name])
+      images[0]
+    else
+      PrcLib.info("Found several images '%s'. Selecting the first "\
+                  "one '%s'", image_name, images[0, :name])
+      images[0, :ssh_user] = ssh_user(images[0, :name])
+      images[0]
+    end
+  end
+
+  def forj_query_image(sCloudObj, sQuery, _hParams)
+    ssl_error_obj = SSLErrorMgt.new
+    begin
+      images = controller_query(sCloudObj, sQuery)
+    rescue => e
+      retry unless ssl_error_obj.error_detected(e.message, e.backtrace, e)
+    end
+    images.each do |image|
+      image[:ssh_user] = ssh_user(image[:name])
+    end
+    images
+  end
+
+  def ssh_user(image_name)
+    return 'fedora' if image_name =~ /fedora/i
+    return 'centos' if image_name =~ /centos/i
+    'ubuntu'
+  end
+end
+
+# Define framework object on BaseDefinition
+module Lorj
+  # ************************************ Image Object
+  # Identify image
+  class BaseDefinition
+    define_obj(:image,
+
+               :create_e => :forj_get_or_create_image,
+               :query_e => :forj_query_image
+               #         :get_e      => :forj_get_image
+               #         :update_e   => :forj_update_image
+               #         :delete_e   => :forj_delete_image
+               )
+
+    obj_needs :CloudObject,  :compute_connection
+    obj_needs :data,         :image_name,          :for => [:create_e]
+  end
+end

data/lib/core_process/cloud/process/internet_network.rb

@@ -0,0 +1,34 @@
+# encoding: UTF-8
+
+# (c) Copyright 2014 Hewlett-Packard Development Company, L.P.
+#
+#    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.
+
+# It requires Core objects to be defined + default ForjProcess functions.
+
+# Define framework object on BaseDefinition
+module Lorj
+  # ************************************ Internet network Object
+  # Define Internet network
+  #
+  # This object contains the logic to ensure the router's network has a gateway
+  # to the external network (internet)
+  # is capable to connect to internet
+  # And to create this connection if possible.
+  class BaseDefinition # rubocop: disable ClassAndModuleChildren
+    define_obj(:internet_network,    :nohandler => true)
+
+    obj_needs :CloudObject,  :external_network # External network to connect if
+    # needed.
+  end
+end

data/lib/core_process/cloud/process/internet_server.rb

@@ -0,0 +1,30 @@
+# encoding: UTF-8
+
+# (c) Copyright 2014 Hewlett-Packard Development Company, L.P.
+#
+#    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.
+
+# It requires Core objects to be defined + default ForjProcess functions.
+
+# Define framework object on BaseDefinition
+module Lorj
+  # ************************************ Internet SERVER Object
+  # internet server is a server connected to the internet network.
+  class BaseDefinition
+    define_obj(:internet_server,    :nohandler => true)
+
+    obj_needs :CloudObject,  :internet_network
+    obj_needs :CloudObject,  :server
+    obj_needs :CloudObject,  :public_ip
+  end
+end