lorj 0.2.0 → 1.0.0

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

@@ -0,0 +1,260 @@
+# 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.
+# ---------------------------------------------------------------------------
+# Router management
+# ---------------------------------------------------------------------------
+class CloudProcess
+  # Process Create handler
+  def forj_get_or_create_router(_sCloudObj, hParams)
+    sub_net_obj = hParams[:subnetwork]
+
+    unless hParams[:router_name]
+      config[:router_name] = 'router-%s', hParams[:network, :name]
+      hParams[:router_name] = config[:router_name]
+    end
+
+    router_name = hParams[:router_name]
+    router_port = get_router_interface_attached(:port, hParams)
+
+    if !router_port
+      # Trying to get router
+      router = get_router(router_name)
+      router = create_router(router_name) unless router
+      create_router_interface(sub_net_obj, router) if router
+    else
+      router = query_router_from_port(router_port, hParams)
+    end
+    router
+  end
+end
+
+# Define framework object on BaseDefinition
+module Lorj
+  # ************************************ Router Object
+  # Identify the router of a network.
+  class BaseDefinition
+    define_obj(:router,
+
+               :create_e => :forj_get_or_create_router,
+               #         :query_e    => :forj_query_router,
+               #         :get_e      => :forj_get_router,
+               :update_e => :controller_update
+               #         :delete_e   => :forj_delete_router
+               )
+    obj_needs :CloudObject,  :network_connection
+    obj_needs :CloudObject,  :network,             :for => [:create_e]
+    obj_needs :CloudObject,  :subnetwork,          :for => [:create_e]
+    obj_needs_optional
+    obj_needs :data,         :router_name,         :for => [:create_e]
+
+    def_attribute :gateway_network_id
+  end
+
+  # ************************************ Port Object
+  # Identify port attached to network
+  class BaseDefinition
+    define_obj :port,   :nohandler => true
+
+    obj_needs :CloudObject,  :network_connection
+    def_attribute :device_id
+
+    def_query_attribute :network_id
+    def_query_attribute :device_owner
+  end
+
+  # ************************************ Router interface Object
+  # Identify interface attached to a router
+  # This object will probably be moved to controller task
+  # To keep the network model more generic.
+  class BaseDefinition
+    # No process handler defined. Just Controller object
+    define_obj :router_interface,   :nohandler => true
+
+    obj_needs :CloudObject,  :network_connection
+    obj_needs :CloudObject,  :router,              :for => [:create_e]
+    obj_needs :CloudObject,  :subnetwork,          :for => [:create_e]
+
+    undefine_attribute :name
+    undefine_attribute :id
+  end
+end
+
+# Router Process internal functions
+class CloudProcess
+  def get_router(name)
+    PrcLib.state("Searching for router '%s'", name)
+    begin
+      routers = controller_query(:router, :name => name)
+      case routers.length
+      when 1
+        routers[0]
+      else
+        PrcLib.info("Router '%s' not found.", name)
+        nil
+      end
+   rescue => e
+     PrcLib.error("%s\n%s", e.message, e.backtrace.join("\n"))
+    end
+  end
+
+  def create_router(router_name, oExternalNetwork = nil)
+    begin
+      if oExternalNetwork
+        ext_net = get_data(oExternalNetwork, :name)
+        PrcLib.state("Creating router '%s' attached to the external "\
+                     "Network '%s'", router_name, ext_net)
+        config[:external_gateway_id] = get_data(oExternalNetwork, :id)
+      else
+        PrcLib.state("Creating router '%s' without external Network",
+                     router_name)
+      end
+
+      router = controller_create(:router)
+      if oExternalNetwork
+        PrcLib.info("Router '%s' created and attached to the external "\
+                    "Network '%s'.", router_name, ext_net)
+      else
+        PrcLib.info("Router '%s' created without external Network.",
+                    router_name)
+      end
+   rescue => e
+     raise ForjError.new, "Unable to create '%s' router\n%s",
+           router_name, e.message
+    end
+    router
+  end
+
+  def delete_router(net_conn_obj, router_obj)
+    PrcLib.state("Deleting router '%s'", router.name)
+    begin
+      #################
+      provider_delete_router(net_conn_obj, router_obj)
+   # net_conn_obj.routers.get(router.id).destroy
+   rescue => e
+     PrcLib.error("Unable to delete '%s' router ID", router_id, e)
+    end
+  end
+
+  def query_router_from_port(router_port, hParams)
+    query = { :id => router_port[:device_id] }
+    routers = controller_query(:router, query)
+    case routers.length
+    when 1
+      PrcLib.info("Found router '%s' attached to the network '%s'.",
+                  routers[0, :name], hParams[:network, :name])
+      routers[0]
+    else
+      PrcLib.warning('Unable to find the router '\
+                     "id '%s'", router_port[:device_id])
+      ForjLib::Data.new
+    end
+  end
+  # TODO: Move router interface management to hpcloud controller.
+  # Router interface to connect to the network
+  def create_router_interface(oSubnet, router_obj)
+    PrcLib.state("Attaching subnet '%s' to router '%s'",
+                 oSubnet[:name], router_obj[:name])
+    begin
+      controller_create(:router_interface)
+
+    #################
+    # provider_add_interface()
+    # router_obj.add_interface(oSubnet.id, nil)
+    rescue => e
+      PrcLib.error("%s\n%s", e.message, e.backtrace.join("\n"))
+    end
+  end
+
+  def delete_router_interface(oSubnet, router_obj)
+    PrcLib.state("Removing subnet '%s' from router '%s'",
+                 oSubnet.name, router_obj.name)
+    subnet_id = oSubnet.id
+    begin
+      #################
+      router_obj.remove_interface(subnet_id)
+    rescue => e
+      PrcLib.error("%s\n%s", e.message, e.backtrace.join("\n"))
+    end
+  end
+
+  def get_router_interface_attached(sCloudObj, hParams)
+    PrcLib.state("Searching for router port attached to the network '%s'",
+                 hParams[:network, :name])
+    begin
+      # Searching for router port attached
+      #################
+      query = { :network_id => hParams[
+                               :network, :id],
+                :device_owner => 'network:router_interface' }
+
+      ports = controller_query(sCloudObj, query)
+      case ports.length
+      when 0
+        PrcLib.info("No router port attached to the network '%s'",
+                    hParams[:network, :name])
+        nil
+      else
+        PrcLib.info("Found a router port attached to the network '%s' ",
+                    hParams[:network, :name])
+        ports[0]
+      end
+   rescue => e
+     PrcLib.error("%s\n%s", e.message, e.backtrace.join("\n"))
+    end
+  end
+
+  # Gateway management
+  def get_gateway(net_conn_obj, name)
+    return nil if !name || !net_conn_obj
+
+    PrcLib.state("Getting gateway '%s'", name)
+    networks = net_conn_obj
+    begin
+      netty = networks.get(name)
+   rescue => e
+     PrcLib.error("%s\n%s", e.message, e.backtrace.join("\n"))
+    end
+    PrcLib.state("Found gateway '%s'", name) if netty
+    PrcLib.state("Unable to find gateway '%s'", name) unless netty
+    netty
+  end
+
+  def query_external_network(_hParams)
+    PrcLib.state('Identifying External gateway')
+    begin
+      # Searching for router port attached
+      #################
+      query = { :router_external => true }
+      networks = controller_query(:network, query)
+      case networks.length
+      when 0
+        PrcLib.info('No external network')
+        ForjLib::Data.new
+      when 1
+        PrcLib.info("Found external network '%s'.", networks[0, :name])
+        networks[0]
+      else
+        PrcLib.warn('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

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

@@ -0,0 +1,120 @@
+# 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.
+
+# SecurityGroups rules management
+class CloudProcess
+  # Process Delete handler
+  def forj_delete_rule(sCloudObj, _hParams)
+    ssl_error_obj = SSLErrorMgt.new
+    begin
+      controller_delete(sCloudObj)
+    rescue => e
+      retry unless ssl_error_obj.error_detected(e.message, e.backtrace, e)
+    end
+  end
+
+  # Process Query handler
+  def forj_query_rule(sCloudObj, sQuery, hParams)
+    rule = '%s %s:%s - %s to %s', hParams[:dir], hParams[:rule_proto],
+           hParams[:port_min], hParams[:port_max],
+           hParams[:addr_map]
+    PrcLib.state("Searching for rule '%s'", rule)
+    ssl_error_obj = SSLErrorMgt.new
+    begin
+      info = {
+        :items => [:dir, :rule_proto, :port_min, :port_max, :addr_map],
+        :items_form => '%s %s:%s - %s to %s'
+      }
+      list = controller_query(sCloudObj, sQuery)
+      query_single(sCloudObj, list, sQuery, rule, info)
+    rescue => e
+      retry unless ssl_error_obj.error_detected(e.message, e.backtrace, e)
+    end
+  end
+
+  # Process Create handler
+  def forj_get_or_create_rule(sCloudObj, hParams)
+    query = {
+      :dir => hParams[:dir],
+      :proto => hParams[:proto],
+      :port_min => hParams[:port_min],
+      :port_max => hParams[:port_max],
+      :addr_map => hParams[:addr_map],
+      :sg_id => hParams[:sg_id]
+    }
+
+    rules = forj_query_rule(sCloudObj, query, hParams)
+    if rules.length == 0
+      create_rule(sCloudObj, hParams)
+    else
+      rules[0]
+    end
+  end
+end
+
+# Define framework object on BaseDefinition
+module Lorj
+  # ************************************ Security group rules Object
+  # Identify Rules attached to the security group
+  class BaseDefinition
+    define_obj(:rule,
+
+               :create_e => :forj_get_or_create_rule,
+               :query_e => :forj_query_rule
+               #         :delete_e   => :forj_delete_rule
+               )
+
+    undefine_attribute :name  # Do not return any predefined name attribute
+
+    obj_needs :CloudObject, :network_connection
+    obj_needs :CloudObject, :security_groups, :for => [:create_e]
+    obj_needs :data,        :sg_id, :for => [:create_e],
+                                    :extract_from => [:security_groups,
+                                                      :attrs, :id]
+
+    obj_needs :data,        :dir,                 :for => [:create_e]
+    predefine_data_value :IN,   :desc => 'Input NAT/firewall rule map type'
+    predefine_data_value :OUT,  :desc => 'Output NAT/firewall rule map type'
+
+    obj_needs :data,        :proto,               :for => [:create_e]
+    obj_needs :data,        :port_min,            :for => [:create_e]
+    obj_needs :data,        :port_max,            :for => [:create_e]
+    obj_needs :data,        :addr_map,            :for => [:create_e]
+  end
+end
+
+# SecurityGroups rules management
+class CloudProcess
+  # Rules internal #
+  #----------------#
+  def create_rule(sCloudObj, hParams)
+    rule = '%s %s:%s - %s to %s', hParams[:dir], hParams[:rule_proto],
+           hParams[:port_min], hParams[:port_max],
+           hParams[:addr_map]
+    PrcLib.state("Creating rule '%s'", rule)
+    ssl_error_obj = SSLErrorMgt.new
+    begin
+      rule = controller_create(sCloudObj)
+      PrcLib.info("Rule '%s' created.", rule)
+    rescue StandardError => e
+      retry unless ssl_error_obj.error_detected(e.message, e.backtrace, e)
+      PrcLib.error 'error creating the rule for port %s', rule
+    end
+    rule
+  end
+end

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

@@ -0,0 +1,121 @@
+# 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.
+
+# SecurityGroups management
+class CloudProcess
+  # Process Create handler
+  def forj_get_or_create_sg(sCloudObj, hParams)
+    sg_name = hParams[:security_group]
+    PrcLib.state("Searching for security group '%s'", sg_name)
+
+    security_group = forj_query_sg(sCloudObj, { :name => sg_name }, hParams)
+    security_group = create_security_group(sCloudObj,
+                                           hParams) unless security_group
+    register(security_group)
+
+    PrcLib.info('Configuring Security Group \'%s\'', sg_name)
+    ports = config.get(:ports)
+
+    ports.each do |port|
+      port = port.to_s if port.class != String
+      if !(/^\d+(-\d+)?$/ =~ port)
+        PrcLib.error("Port '%s' is not valid. Must be <Port> or "\
+                     '<PortMin>-<PortMax>', port)
+      else
+        port_found_match = /^(\d+)(-(\d+))?$/.match(port)
+        portmin = port_found_match[1]
+        portmax = (port_found_match[3]) ? (port_found_match[3]) : (portmin)
+        # Need to set runtime data to get or if missing
+        # create the required rule.
+        config[:dir]        = :IN
+        config[:proto] = 'tcp'
+        config[:port_min]   = portmin.to_i
+        config[:port_max]   = portmax.to_i
+        config[:addr_map]   = '0.0.0.0/0'
+
+        # object.Create(:rule)
+        Create(:rule)
+      end
+    end
+    security_group
+  end
+
+  # Process Delete handler
+  def forj_delete_sg(sCloudObj, _hParams)
+    ssl_error_obj = SSLErrorMgt.new
+    begin
+      controller_delete(sCloudObj)
+    rescue => e
+      retry unless ssl_error_obj.error_detected(e.message, e.backtrace, e)
+    end
+  end
+
+  # Process Query handler
+  def forj_query_sg(sCloudObj, sQuery, hParams)
+    ssl_error_obj = SSLErrorMgt.new
+
+    begin
+      sgroups = controller_query(sCloudObj, sQuery)
+    rescue => e
+      retry unless ssl_error_obj.error_detected(e.message, e.backtrace, e)
+      PrcLib.fatal(1, 'Unable to get list of security groups.', e)
+    end
+    case sgroups.length
+    when 0
+      PrcLib.info("No security group '%s' found",
+                  hParams[:security_group])
+      nil
+    when 1
+      PrcLib.info("Found security group '%s'", sgroups[0, :name])
+      sgroups[0]
+    end
+  end
+end
+
+# Define framework object on BaseDefinition
+module Lorj
+  # ************************************ Security groups Object
+  # Identify security_groups
+  class BaseDefinition
+    define_obj(:security_groups,
+
+               :create_e => :forj_get_or_create_sg,
+               :query_e => :forj_query_sg,
+               :delete_e => :forj_delete_sg
+               )
+
+    obj_needs :CloudObject,  :network_connection
+    obj_needs :data,         :security_group,      :for => [:create_e]
+    obj_needs_optional
+    obj_needs :data,         :sg_desc,             :for => [:create_e]
+  end
+end
+
+# SecurityGroups Process internal functions #
+class CloudProcess
+  def create_security_group(sCloudObj, hParams)
+    PrcLib.state("Creating security group '%s'", hParams[:security_group])
+    begin
+      sg = controller_create(sCloudObj)
+      PrcLib.info("Security group '%s' created.", sg[:name])
+    rescue => e
+      PrcLib.error("%s\n%s", e.message, e.backtrace.join("\n"))
+    end
+    sg
+  end
+end

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

@@ -0,0 +1,127 @@
+# 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.
+
+# ---------------------------------------------------------------------------
+# Server management
+# ---------------------------------------------------------------------------
+class CloudProcess
+  # Process Handler functions
+  def forj_get_or_create_server(sCloudObj, hParams)
+    server_name = hParams[:server_name]
+    PrcLib.state("Searching for server '%s'", server_name)
+    servers = forj_query_server(sCloudObj, { :name => server_name }, hParams)
+    if servers.length > 0
+      # Get server details
+      forj_get_server(sCloudObj, servers[0][:attrs][:id], hParams)
+    else
+      create_server(sCloudObj, hParams)
+    end
+  end
+
+  def forj_delete_server(sCloudObj, hParams)
+    ssl_error_obj = SSLErrorMgt.new
+    begin
+      controller_delete(sCloudObj)
+      PrcLib.info('Server %s was destroyed ', hParams[:server][:name])
+    rescue => e
+      retry unless ssl_error_obj.error_detected(e.message, e.backtrace, e)
+    end
+  end
+
+  def forj_query_server(sCloudObj, sQuery, _hParams)
+    ssl_error_obj = SSLErrorMgt.new
+    begin
+      controller_query(sCloudObj, sQuery)
+    rescue => e
+      retry unless ssl_error_obj.error_detected(e.message, e.backtrace, e)
+    end
+  end
+
+  def forj_get_server(sCloudObj, sId, _hParams)
+    ssl_error_obj = SSLErrorMgt.new
+    begin
+      controller_get(sCloudObj, sId)
+    rescue => e
+      retry unless ssl_error_obj.error_detected(e.message, e.backtrace, e)
+    end
+  end
+end
+
+# Define framework object on BaseDefinition
+class Lorj
+  # ************************************ SERVER Object
+  # Identify the server to use/build on the network/...
+  class BaseDefinition
+    define_obj(:server,
+
+               :create_e => :forj_get_or_create_server,
+               :query_e => :forj_query_server,
+               :get_e => :forj_get_server,
+               #         :update_e   => :forj_update_server,
+               :delete_e => :forj_delete_server
+               )
+
+    obj_needs :CloudObject,  :compute_connection
+    obj_needs :CloudObject,  :flavor,              :for => [:create_e]
+    obj_needs :CloudObject,  :network,             :for => [:create_e]
+    obj_needs :CloudObject,  :security_groups,     :for => [:create_e]
+    obj_needs :CloudObject,  :keypairs,            :for => [:create_e]
+    obj_needs :CloudObject,  :image,               :for => [:create_e]
+    obj_needs :data,         :server_name,         :for => [:create_e]
+
+    obj_needs_optional
+    obj_needs :data,         :user_data,           :for => [:create_e]
+    obj_needs :data,         :meta_data,           :for => [:create_e]
+
+    def_attribute :status
+    predefine_data_value :create,   :desc => 'Server is creating.'
+    predefine_data_value :boot,     :desc => 'Server is booting.'
+    predefine_data_value :active,   :desc => 'Server is started.'
+    def_attribute :private_ip_address
+    def_attribute :public_ip_address
+
+    def_attribute :image_id
+    def_attribute :key_name
+  end
+end
+
+# Internal Process function
+class CloudProcess
+  def create_server(sCloudObj, hParams)
+    name = hParams[:server_name]
+    begin
+      PrcLib.info('boot: meta-data provided.') if hParams[:meta_data]
+      PrcLib.info('boot: user-data provided.') if hParams[:user_data]
+      PrcLib.state('creating server %s', name)
+      server = controller_create(sCloudObj)
+      PrcLib.info("%s '%s' created.", sCloudObj, name)
+    rescue => e
+      PrcLib.fatal(1, "Unable to create server '%s'", name, e)
+    end
+    server
+  end
+
+  def forj_get_server_log(sCloudObj, sId, _hParams)
+    ssl_error_obj = SSLErrorMgt.new
+    begin
+      controller_get(sCloudObj, sId)
+    rescue => e
+      retry unless ssl_error_obj.error_detected(e.message, e.backtrace, e)
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+# 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
+class Lorj
+  # ************************************ SERVER Console Object
+  # Object representing the console log attached to a server
+  class BaseDefinition
+    define_obj(:server_log,
+
+               :get_e => :forj_get_server_log
+               )
+
+    obj_needs :CloudObject,  :server
+    obj_needs :data,         :log_lines
+    undefine_attribute :name
+    undefine_attribute :id
+    def_attribute :output
+  end
+end