lorj_cloud 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4233f4744a02510e08773415b97e9e2c1d22a573
-  data.tar.gz: 65f7e65ab5b524739d081bfd6fac667a0b92e815
+  metadata.gz: c97d1a526cc33c76ce049d26943adab2c485c976
+  data.tar.gz: acfd3212f964e401b51dd8b03d6dabe631e6a1ac
 SHA512:
-  metadata.gz: 6942511c15d7ca200f7994f3e78db471cc1d051aef996d68118694e2512e6decae0310f14b1b470aa725cc3079cdeaf5b037d5986f0db54d6e5afcd8a2c748f2
-  data.tar.gz: b6e027ec8f848aec4be5ad2bd8a241c2f1e65699bcf5234b0c815b85f2979230336b0960503deb2dd442e8a114d21e4d7267a164ab50d84571ab99475c5400f5
+  metadata.gz: 7f84ffe8eb4fc5d91b8148e3d7779c3416d721f3021ca691b40ef97094ddb456368992f6dd1708d4d1ad42836bd9d848f96e90b5a3962b17decc2a2290c7e0b6
+  data.tar.gz: 9e0aecb2ca0c8c8a93b124d8ab4dbba4433b8bcc7b2647d2ffc24b1712f6b3fa2745cd2aae91c9ff884bccab832a4fbcd918d2158228fd68ca040ab7b39f9057

data/bin/console

@@ -1,5 +1,18 @@
 #!/usr/bin/env ruby
 
+# (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.
 require 'bundler/setup'
 require 'lorj_cloud'
 

data/bin/lorj_cloud

@@ -0,0 +1,67 @@
+#!/usr/bin/env ruby
+
+# (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.
+# require 'byebug'
+
+require 'bundler/setup'
+require 'lorj_cloud'
+
+process_module = 'cloud'
+
+PrcLib.log_object = Logger.new(STDOUT)
+PrcLib.level = Logger::DEBUG
+PrcLib.core_level = 5
+
+unless Lorj.processes.key?(process_module)
+  PrcLib.fatal(1, "Unable to found the process module '%s'. \n"\
+                  'Modules loaded:', process_module,  Lorj.processes.keys)
+end
+
+if Lorj.processes[process_module].controllers.nil?
+  PrcLib.fatal(1, "no controllers found in module '%s'.\n", process_module)
+end
+
+PrcLib.high_level_msg('Welcome to lorj_cloud - Simple process to build a '\
+                      "cloud box\n"\
+                      'This simple script uses lorj_cloud process to guide you'\
+                      ' setup and create a server in your cloud.')
+
+#  say("Please choose your cloud provider:")
+#  provider = choose do |q|
+#  controllers = Lorj.processes[process_module].controllers.keys
+#  q.choices(*controllers)
+#  end
+
+provider = 'openstack'
+
+processes = [{ :process_module => process_module,
+               :controller_name => provider }]
+
+core = Lorj::Core.new(nil, processes)
+
+PrcLib.message('You are going to create a server')
+
+#  server = ask('Enter a server name:') do |q|
+#  q.validate = /\w+/
+#  end
+server = 'test'
+
+PrcLib.message('Now, we are going to ask you some data about your cloud and '\
+               'information to create your server')
+#  byebug
+
+core.setup(:server)
+
+core.create(:server, :server_name => server)

data/bin/setup

@@ -1,4 +1,19 @@
 #!/bin/bash
+
+# (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.
+
 set -euo pipefail
 IFS=$'\n\t'
 

data/lib/lorj_cloud/version.rb

@@ -1,4 +1,5 @@
 # LorjCloud module
 module LorjCloud
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
+  DATE = '2015-05-20'
 end

data/lib/process/cloud/data.yaml

@@ -0,0 +1,136 @@
+# (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.
+
+# Following declares generic FORJ data to handle Fog object (compute/network/dns/...)
+# It defines the account file structure. section/key=value
+# All data can be predefined by default value (config.yaml/defaults.yaml) except
+# those identified by :account_exclusive: true
+:setup:
+  :steps:
+    :provider_config:
+      :desc:    "Provider configuration:"
+    :cloud_config:
+      :desc:    "Cloud configuration:"
+      :add:
+        - :keypair_path
+        - :keypair_base
+:sections:
+  # This section define updatable data available from config.yaml. But will never be added in an account file.
+  # Used by forj set/get functions
+  :default:
+    :account_name:
+      :desc:              "Default account name used by forj cli"
+    :provider_name:
+      :desc:              "Default provider name while running forj setup. By default, hpcloud is selected."
+  # Defines account credentials data
+  :account:
+    :name:
+      :desc:              "Account Name"
+      :readonly:          true
+      :account_exclusive: true
+    :provider:
+      :desc:              "Cloud provider name."
+      :readonly:          true
+      :account_exclusive: true
+
+  # Defines services
+  :services:
+    :compute:
+      :desc:              "Service identification for compute"
+      :account_exclusive: true
+      :account:           true
+      :step:              :provider_config
+    :network:
+      :desc:              "Service identification for network"
+      :account_exclusive: true
+      :account:           true
+      :step:              :provider_config
+
+  # Defines ssh keys credentials
+  :credentials:
+    :keypair_path:
+      :desc:               "Contains the full path to the :keypair_base."
+      :ask_step:           :provider_config
+    :keypair_base:
+      :desc:               "Contains the key file base name without .pem/.pub."
+      :ask_step:           :provider_config
+    :keypair_name:
+      :desc:               "keypair name defined in your cloud to access your server."
+      :ask_step:           :provider_config
+    :auth_uri:
+      :desc:               "Generic service auth url"
+      :ask_step:           :provider_config
+      :account_exclusive:  true
+      :account:            true
+      :required:           true
+    :user_domain:
+      :ask_step:           :provider_config
+      :account_exclusive:  true
+      :account:            true
+      :required:           false
+    :account_id:
+      :desc:               "Generic Cloud Account name."
+      :ask_step:           :provider_config
+      :account_exclusive:  true
+      :account:            true
+      :required:           true
+    :account_key:
+      :desc:               "Generic cloud account key"
+      :ask_step:           :provider_config
+      :account_exclusive:  true
+      :account:            true
+      :required:           true
+      :encrypted:          true
+    :tenant:
+      :desc:               "Tenant Name (Project name)"
+      :ask_step:           :provider_config
+      :account_exclusive:  true
+      :account:            true
+      :required:           true
+    :prj_domain:
+      :ask_step:           :provider_config
+      :account_exclusive:  true
+      :account:            true
+      :required:           false
+
+  :server:
+    :network_name:
+      :ask_step:        :cloud_config
+      :desc:            "Network name to attach to each forge boxes. By default we use 'forj'. If it doesn't exist, it will be created."
+    :security_group:
+      :desc:            "Security group name to configure and attach to each forge boxes."
+      :ask_step:        :cloud_config
+    :box_name:
+      :desc:            "Box name"
+    :flavor_name:
+      :desc:            "Server Flavor name"
+      :ask_step:        :cloud_config
+      :account:         true
+      :list_values:
+         :query_type:   :query_call # Will execute a query on flavor, query_params is empty for all.
+         :object:       :flavor
+         :value:        :name
+         :validate:     :list_strict
+    :image_name:
+      :desc:            "Image name"
+      :ask_step:        :cloud_config
+      :account:         true
+      :list_values:
+         :query_type:   :query_call # Will execute a query on flavor, query_params is empty for all. No filter currently working.
+         :object:       :image
+         :value:        :name
+         :validate:     :list_strict
+    :ports:
+      :desc:            "List of security group rules (1 port or range of ports) to open to the external network."
+      :ask_step:        :cloud_config

data/lib/process/cloud/defaults.yaml

@@ -0,0 +1,17 @@
+# (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.
+
+:default:
+  # Users: Default user for ssh connection, if user doesn't exits, forj cli will try to get the user from the server image on it's name attribute
+  :users: ['ubuntu', 'fedora', 'cloud-user', 'cirros', 'centos', 'cloud', 'root']

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

@@ -23,9 +23,9 @@
 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])
+    PrcLib.debug("%s:%s Connecting to '%s' - Project '%s'",
+                 self.class, sCloudObj, config[:provider],
+                 hParams['credentials#tenant'])
     begin
       controller_connect(sCloudObj)
    rescue => e
@@ -47,13 +47,12 @@ class Lorj::BaseDefinition
   # 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
+  obj_needs :data, 'credentials#auth_uri'
+  obj_needs :data, 'credentials#account_id'
+  obj_needs :data, 'credentials#account_key'
+  obj_needs :data, 'credentials#tenant'
 
   undefine_attribute :id    # Do not return any predefined ID
   undefine_attribute :name  # Do not return any predefined NAME
@@ -62,14 +61,13 @@ end
 # compute_connection
 class Lorj::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
+  obj_needs :data, 'credentials#account_id'
+  obj_needs :data, 'credentials#account_key'
+  obj_needs :data, 'credentials#auth_uri'
+  obj_needs :data, 'credentials#tenant'
+  obj_needs :data, 'services#compute'
 
   undefine_attribute :id    # Do not return any predefined ID
   undefine_attribute :name  # Do not return any predefined NAME
@@ -78,14 +76,13 @@ end
 # network_connection
 class Lorj::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
+  obj_needs :data, 'credentials#account_id'
+  obj_needs :data, 'credentials#account_key'
+  obj_needs :data, 'credentials#auth_uri'
+  obj_needs :data, 'credentials#tenant'
+  obj_needs :data, 'services#network'
 
   undefine_attribute :id    # Do not return any predefined ID
   undefine_attribute :name  # Do not return any predefined NAME

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

@@ -24,7 +24,7 @@ class CloudProcess
   # 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]
+    flavor_name = hParams['server#flavor_name']
     PrcLib.state("Searching for flavor '%s'", flavor_name)
 
     flavors = query_flavor(sCloudObj, { :name => flavor_name }, hParams)
@@ -43,7 +43,7 @@ class CloudProcess
 
   # Should return 1 or 0 flavor.
   def query_flavor(sCloudObj, sQuery, hParams)
-    flavor_name = hParams[:flavor_name]
+    flavor_name = hParams['server#flavor_name']
     #  list = forj_query_flavor(sCloudObj, sQuery, hParams)
     #  query_single(sCloudObj, list, sQuery, flavor_name)
     query_single(sCloudObj, sQuery, flavor_name)
@@ -73,8 +73,8 @@ class Lorj::BaseDefinition # rubocop: disable ClassAndModuleChildren
             #         :delete_e   => :forj_delete_flavor
             )
 
-  obj_needs :CloudObject,  :compute_connection
-  obj_needs :data,         :flavor_name,         :for => [:create_e]
+  obj_needs :CloudObject, :compute_connection
+  obj_needs :data,        'server#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

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

@@ -21,7 +21,7 @@
 # ---------------------------------------------------------------------------
 class CloudProcess
   def forj_get_or_create_image(sCloudObj, hParams)
-    image_name = hParams[:image_name]
+    image_name = hParams['server#image_name']
     PrcLib.state("Searching for image '%s'", image_name)
 
     search_the_image(sCloudObj, { :name => image_name }, hParams)
@@ -29,7 +29,7 @@ class CloudProcess
   end
 
   def search_the_image(sCloudObj, sQuery, hParams)
-    image_name = hParams[:image_name]
+    image_name = hParams['server#image_name']
     images = forj_query_image(sCloudObj, sQuery, hParams)
     case images.length
     when 0
@@ -95,5 +95,5 @@ class Lorj::BaseDefinition # rubocop: disable Style/ClassAndModuleChildren
             )
 
   obj_needs :CloudObject,  :compute_connection
-  obj_needs :data,         :image_name,          :for => [:create_e]
+  obj_needs :data,         'server#image_name',          :for => [:create_e]
 end

data/lib/process/cloud/process/keypairs.rb

@@ -39,7 +39,7 @@ class CloudProcess
   #                        also set - Used to import it)
   #
   def forj_get_or_create_keypair(sCloudObj, hParams)
-    keypair_name = hParams[:keypair_name]
+    keypair_name = hParams['credentials#keypair_name']
     PrcLib.state("Searching for keypair '%s'", keypair_name)
 
     keypair = forj_get_keypair(sCloudObj, keypair_name, hParams)
@@ -102,7 +102,7 @@ class Lorj::BaseDefinition
             )
 
   obj_needs :CloudObject,  :compute_connection
-  obj_needs :data,         :keypair_name,        :for => [:create_e]
+  obj_needs :data,         'credentials#keypair_name', :for => [:create_e]
   obj_needs :data,         :keypair_path
   obj_needs :data,         :keypair_base
 
@@ -174,9 +174,11 @@ class CloudProcess
 
   def keypair_import(hParams, loc_kpair)
     PrcLib.fatal(1, "Unable to import keypair '%s'. "\
-                    'Public key file is not found. '\
+                    "Public key file '%s' is not found. "\
                     "Please run 'forj setup %s'",
-                 hParams[:keypair_name],
+                 hParams['credentials#keypair_name'],
+                 File.join(loc_kpair[:keypair_path],
+                           loc_kpair[:public_key_name]),
                  config[:account_name]) unless loc_kpair[:public_key_exist?]
     public_key_file = File.join(loc_kpair[:keypair_path],
                                 loc_kpair[:public_key_name])
@@ -185,7 +187,7 @@ class CloudProcess
       public_key = File.read(public_key_file)
     rescue => e
       PrcLib.fatal(1, "Unable to import keypair '%s'. '%s' is "\
-                      "unreadable.\n%s", hParams[:keypair_name],
+                      "unreadable.\n%s", hParams['credentials#keypair_name'],
                    loc_kpair[:public_key_file],
                    e.message)
     end
@@ -200,7 +202,7 @@ class CloudProcess
   end
 
   def create_keypair(sCloudObj, hParams)
-    key_name = hParams[:keypair_name]
+    key_name = hParams['credentials#keypair_name']
     PrcLib.state("Importing keypair '%s'", key_name)
     ssl_error_obj = SSLErrorMgt.new
     begin
@@ -274,7 +276,7 @@ class CloudProcess
   end
 
   def get_keypairs_path(hParams, hKeys)
-    keypair_name = hParams[:keypair_name]
+    keypair_name = hParams['credentials#keypair_name']
 
     if hKeys[:private_key_exist?]
       hParams[:private_key_file] = File.join(hKeys[:keypair_path],

data/lib/{providers → process/cloud/providers}/hpcloud/hpcloud.rb

@@ -28,10 +28,10 @@ load File.join(hpcloud_path, 'security_groups.rb')
 # Defines Meta HPCloud object
 class Hpcloud
   define_obj :services
-  obj_needs :data, :account_id,      :mapping => :hp_access_key
-  obj_needs :data, :account_key,     :mapping => :hp_secret_key
-  obj_needs :data, :auth_uri,        :mapping => :hp_auth_uri
-  obj_needs :data, :tenant,          :mapping => :hp_tenant_id
+  obj_needs :data, 'credentials#account_id',      :mapping => :hp_access_key
+  obj_needs :data, 'credentials#account_key',     :mapping => :hp_secret_key
+  obj_needs :data, 'credentials#auth_uri',        :mapping => :hp_auth_uri
+  obj_needs :data, 'credentials#tenant',          :mapping => :hp_tenant_id
   obj_needs :data, ':excon_opts/:connect_timeout', :default_value => 30
   obj_needs :data, ':excon_opts/:read_timeout',    :default_value => 240
   obj_needs :data, ':excon_opts/:write_timeout',   :default_value => 240
@@ -41,18 +41,18 @@ class Hpcloud
   define_obj :compute_connection
   # Defines Data used by compute.
 
-  obj_needs :data, :account_id,  :mapping => :hp_access_key
-  obj_needs :data, :account_key, :mapping => :hp_secret_key
-  obj_needs :data, :auth_uri,    :mapping => :hp_auth_uri
-  obj_needs :data, :tenant,      :mapping => :hp_tenant_id
-  obj_needs :data, :compute,     :mapping => :hp_avl_zone
+  obj_needs :data, 'credentials#account_id',  :mapping => :hp_access_key
+  obj_needs :data, 'credentials#account_key', :mapping => :hp_secret_key
+  obj_needs :data, 'credentials#auth_uri',    :mapping => :hp_auth_uri
+  obj_needs :data, 'credentials#tenant',      :mapping => :hp_tenant_id
+  obj_needs :data, 'services#compute',        :mapping => :hp_avl_zone
 
   define_obj :network_connection
-  obj_needs :data, :account_id,  :mapping => :hp_access_key
-  obj_needs :data, :account_key, :mapping => :hp_secret_key
-  obj_needs :data, :auth_uri,    :mapping => :hp_auth_uri
-  obj_needs :data, :tenant,      :mapping => :hp_tenant_id
-  obj_needs :data, :network,     :mapping => :hp_avl_zone
+  obj_needs :data, 'credentials#account_id',  :mapping => :hp_access_key
+  obj_needs :data, 'credentials#account_key', :mapping => :hp_secret_key
+  obj_needs :data, 'credentials#auth_uri',    :mapping => :hp_auth_uri
+  obj_needs :data, 'credentials#tenant',      :mapping => :hp_tenant_id
+  obj_needs :data, 'services#network',        :mapping => :hp_avl_zone
 
   # Forj predefine following query mapping, used by ForjProcess
   # id => id, name => name
@@ -117,20 +117,20 @@ class Hpcloud
   def_attr_mapping :public_ip, :ip
 
   # defines setup Cloud data (:account => true for setup)
-  define_data(:account_id,
+  define_data('credentials#account_id',
               :account => true,
               :desc => 'HPCloud Access Key (From horizon, user drop down, '\
                        'manage keys)',
               :validate => /^[A-Z0-9]*$/
              )
-  define_data(:account_key,
+  define_data('credentials#account_key',
               :account => true,
               :desc => 'HPCloud secret Key (From horizon, user drop down, '\
                        'manage keys)',
               :encrypted => false,
               :validate => /^.+/
              )
-  define_data(:auth_uri,
+  define_data('credentials#auth_uri',
               :account => true,
               :desc => 'HPCloud Authentication service URL (default is HP '\
                        'Public cloud)',
@@ -138,17 +138,16 @@ class Hpcloud
               :default_value => 'https://region-a.geo-1.identity.hpcloudsvc'\
                                 '.com:35357/v2.0/'
              )
-  define_data(:tenant,
+  define_data('credentials#tenant',
               :account => true,
               :desc => 'HPCloud Tenant ID (from horizon, identity, projecs,'\
                        ' Project ID)',
               :validate => /^[0-9]+$/
              )
 
-  define_data(:compute,
+  define_data('services#compute',
               :account => true,
               :desc => 'HPCloud Compute service zone (Ex: region-a.geo-1)',
-              :depends_on => [:account_id, :account_key, :auth_uri, :tenant],
               :list_values => {
                 :query_type => :controller_call,
                 :object => :services,
@@ -158,10 +157,9 @@ class Hpcloud
               }
              )
 
-  define_data(:network,
+  define_data('services#network',
               :account => true,
               :desc => 'HPCloud Network service zone (Ex: region-a.geo-1)',
-              :depends_on => [:account_id, :account_key, :auth_uri, :tenant],
               :list_values => {
                 :query_type => :controller_call,
                 :object => :services,
@@ -227,9 +225,10 @@ class HpcloudController # rubocop: disable Metrics/ClassLength
                               hParams[:user_data], hParams[:meta_data])
     when :image
       required?(hParams, :compute_connection)
-      required?(hParams, :image_name)
+      required?(hParams, 'server#image_name')
 
-      HPCompute.get_image(hParams[:compute_connection], hParams[:image_name])
+      HPCompute.get_image(hParams[:compute_connection],
+                          hParams['server#image_name'])
     when :network
       required?(hParams, :network_connection)
       required?(hParams, :network_name)
@@ -252,11 +251,12 @@ class HpcloudController # rubocop: disable Metrics/ClassLength
                                  hParams[:security_group], hParams[:sg_desc])
     when :keypairs
       required?(hParams, :compute_connection)
-      required?(hParams, :keypair_name)
+      required?(hParams, 'credentials#keypair_name')
       required?(hParams, :public_key)
 
       HPKeyPairs.create_keypair(hParams[:compute_connection],
-                                hParams[:keypair_name], hParams[:public_key])
+                                hParams['credentials#keypair_name'],
+                                hParams[:public_key])
     when :router
       required?(hParams, :network_connection)
       required?(hParams, :router_name)

data/lib/{providers → process/cloud/providers}/openstack/openstack.rb

@@ -21,11 +21,11 @@ require 'uri'
 
 hpcloud_path = File.expand_path(File.dirname(__FILE__))
 
-require File.join(hpcloud_path, 'openstack_query.rb')
-require File.join(hpcloud_path, 'openstack_get.rb')
-require File.join(hpcloud_path, 'openstack_delete.rb')
-require File.join(hpcloud_path, 'openstack_create.rb')
-require File.join(hpcloud_path, 'openstack_update.rb')
+load File.join(hpcloud_path, 'openstack_query.rb')
+load File.join(hpcloud_path, 'openstack_get.rb')
+load File.join(hpcloud_path, 'openstack_delete.rb')
+load File.join(hpcloud_path, 'openstack_create.rb')
+load File.join(hpcloud_path, 'openstack_update.rb')
 
 # Defines Meta Openstack object
 class Openstack
@@ -34,37 +34,49 @@ class Openstack
   define_obj :services
   # Define Data used by service
 
-  obj_needs :data, :account_id,  :mapping => :openstack_username
-  obj_needs :data, :account_key, :mapping => :openstack_api_key,
-                                 :decrypt => true
-  obj_needs :data, :auth_uri,    :mapping => :openstack_auth_uri
-  obj_needs :data, :tenant,      :mapping => :openstack_tenant
+  obj_needs :data, 'credentials#account_id',  :mapping => :openstack_username
+  obj_needs :data, 'credentials#account_key', :mapping => :openstack_api_key,
+                                              :decrypt => true
+  obj_needs :data, 'credentials#auth_uri',    :mapping => :openstack_auth_url
+  obj_needs :data, 'credentials#tenant',      :mapping => :openstack_tenant
   obj_needs :data, ':excon_opts/:connect_timeout', :default_value => 30
   obj_needs :data, ':excon_opts/:read_timeout',    :default_value => 240
   obj_needs :data, ':excon_opts/:write_timeout',   :default_value => 240
 
+  obj_needs_optional # Data required if uri contains v3
+  obj_needs :data, :user_domain, :mapping => :openstack_user_domain
+  obj_needs :data, :prj_domain, :mapping => :openstack_project_domain
+
   define_obj :compute_connection
   # Defines Data used by compute.
 
-  obj_needs :data, :account_id,  :mapping => :openstack_username
-  obj_needs :data, :account_key, :mapping => :openstack_api_key,
-                                 :decrypt => true
-  obj_needs :data, :auth_uri,    :mapping => :openstack_auth_url
-  obj_needs :data, :tenant,      :mapping => :openstack_tenant
-  obj_needs :data, :compute,     :mapping => :openstack_region
+  obj_needs :data, 'credentials#account_id',  :mapping => :openstack_username
+  obj_needs :data, 'credentials#account_key', :mapping => :openstack_api_key,
+                                              :decrypt => true
+  obj_needs :data, 'credentials#auth_uri',    :mapping => :openstack_auth_url
+  obj_needs :data, 'credentials#tenant',      :mapping => :openstack_tenant
+  obj_needs :data, 'services#compute',     :mapping => :openstack_region
+
+  obj_needs_optional # Data required if uri contains v3
+  obj_needs :data, :user_domain, :mapping => :openstack_user_domain
+  obj_needs :data, :prj_domain, :mapping => :openstack_project_domain
 
   define_obj :network_connection
-  obj_needs :data, :account_id,  :mapping => :openstack_username
-  obj_needs :data, :account_key, :mapping => :openstack_api_key,
-                                 :decrypt => true
-  obj_needs :data, :auth_uri,    :mapping => :openstack_auth_url
-  obj_needs :data, :tenant,      :mapping => :openstack_tenant
-  obj_needs :data, :network,     :mapping => :openstack_region
+  obj_needs :data, 'credentials#account_id',  :mapping => :openstack_username
+  obj_needs :data, 'credentials#account_key', :mapping => :openstack_api_key,
+                                              :decrypt => true
+  obj_needs :data, 'credentials#auth_uri',    :mapping => :openstack_auth_url
+  obj_needs :data, 'credentials#tenant',      :mapping => :openstack_tenant
+  obj_needs :data, 'services#network',     :mapping => :openstack_region
+
+  obj_needs_optional # Data required if uri contains v3
+  obj_needs :data, :user_domain, :mapping => :openstack_user_domain
+  obj_needs :data, :prj_domain, :mapping => :openstack_project_domain
 
   # Openstack tenants object
   define_obj(:tenants, :create_e => :openstack_get_tenant)
   obj_needs :CloudObject, :compute_connection
-  obj_needs :data, :tenant
+  obj_needs :data, 'credentials#tenant'
 
   # Openstack Network
   define_obj :network
@@ -101,28 +113,32 @@ class Openstack
   def_attr_mapping :port_max, :port_range_max
   def_attr_mapping :addr_map, :remote_ip_prefix
   def_attr_mapping :sg_id,    :security_group_id
+end
 
-  define_data(:account_id,
+# Defines Meta Openstack object
+class Openstack
+  define_data('credentials#account_id',
               :account => true,
               :desc => 'Openstack Username',
               :validate => /^.+/
              )
 
-  define_data(:account_key,
+  define_data('credentials#account_key',
               :account => true,
               :desc => 'Openstack Password',
               :validate => /^.+/
              )
-  define_data(:auth_uri,
+  define_data('credentials#auth_uri',
               :account => true,
               :explanation => "The authentication service is identified as '"\
                 "identity' under your horizon UI - Project/Compute then "\
                 'Access & security.',
               :desc => 'Openstack Authentication service URL. '\
-                'Ex: https://mycloud:5000/v2.0/tokens',
+                'Ex: https://mycloud:5000/v2.0/tokens, '\
+                'https://mycloud:5000/v3/auth/tokens, ...',
               :validate => %r{^http(s)?:\/\/.*\/tokens$}
              )
-  define_data(:tenant,
+  define_data('credentials#tenant',
               :account => true,
               :explanation => 'The Project name is shown from your horizon UI'\
                 ', on top left, close to the logo',
@@ -130,9 +146,30 @@ class Openstack
               :validate => /^.+/
              )
 
-  define_data(:compute,
+  define_data(:user_domain,
+              :account => true,
+              :explanation => 'Openstack authentication (v3) requires your '\
+                'user domain.',
+              :desc => 'User domain name',
+              :validate => /^.+/,
+              :pre_step_function => :openstack_domain_required?,
+              :before => 'credentials#account_id',
+              :after => 'credentials#auth_uri'
+             )
+
+  define_data(:prj_domain,
+              :account => true,
+              :desc => 'Tenant domain name',
+              :default_value => 'Default',
+              :validate => /^.+/,
+              :pre_step_function => :openstack_domain_required?,
+              :before => 'credentials#tenant',
+              :after => 'credentials#auth_uri'
+             )
+
+  define_data('services#compute',
               :account => true,
-              :default_value => '<%= config[:network] %>',
+              :default_value => "<%= config['services#network'] %>",
               :explanation => 'Depending on your installation, you may need to'\
                 ' provide a Region name. This information is shown under your '\
                 'horizon UI - close right to the project name (top left).'\
@@ -141,19 +178,18 @@ class Openstack
                 'set as OS_REGION_NAME.'\
                 "\nIf there is no region shown, you can ignore it.",
               :desc => 'Openstack Compute Region (Ex: RegionOne)',
-              :depends_on => [:account_id, :account_key, :auth_uri, :tenant],
               :list_values => {
                 :query_type => :controller_call,
                 :object => :services,
-                :query_call => :get_services,
+                :query_call => :list_services,
                 :query_params => { :list_services => [:Compute, :compute] },
                 :validate => :list_strict
               }
              )
 
-  define_data(:network,
+  define_data('services#network',
               :account => true,
-              :default_value => '<%= config[:compute] %>',
+              :default_value => "<%= config['services#compute'] %>",
               :desc => 'Openstack Network Region (Ex: RegionOne)',
               :explanation => 'Depending on your installation, you may need to'\
                 ' provide a Region name. This information is shown under your '\
@@ -162,11 +198,10 @@ class Openstack
                 'API, then download the Openstack RC file. The Region name is '\
                 'set as OS_REGION_NAME.'\
                 "\nIf there is no region shown, you can ignore it.",
-              :depends_on => [:account_id, :account_key, :auth_uri, :tenant],
               :list_values => {
                 :query_type => :controller_call,
                 :object => :services,
-                :query_call => :get_services,
+                :query_call => :list_services,
                 :query_params => { :list_services => [:Networking, :network] },
                 :validate => :list_strict
               }
@@ -177,7 +212,7 @@ class Openstack
   attr_value_mapping :create, 'BUILD'
   attr_value_mapping :boot,   :boot
   attr_value_mapping :active, 'ACTIVE'
-  attr_value_mapping :error, 'ERROR'
+  attr_value_mapping :error,  'ERROR'
 
   def_attr_mapping :private_ip_address, :accessIPv4
   def_attr_mapping :public_ip_address, :accessIPv4
@@ -266,15 +301,7 @@ class OpenstackController
   def connect(sObjectType, hParams)
     case sObjectType
     when :services
-      # Fog use URI type for auth uri: URI.parse(:auth_uri)
-      # Convert openstack_auth_uri to type URI
-      hParams[:hdata][:openstack_auth_uri] =
-          URI.parse(hParams[:hdata][:openstack_auth_uri])
-      retrieve_result =
-          Fog::OpenStack.retrieve_tokens_v2(hParams[:hdata],
-                                            hParams[:excon_opts])
-      creds = format_retrieve_result(retrieve_result)
-      return creds
+      get_services(hParams)
     when :compute_connection
       Fog::Compute.new(
         hParams[:hdata].merge(:provider => :openstack)
@@ -333,7 +360,7 @@ end
 # Following class describe how FORJ should handle Openstack Cloud objects.
 class OpenstackController
   # This function requires to return an Array of values or nil.
-  def get_services(sObjectType, oParams)
+  def list_services(sObjectType, oParams)
     case sObjectType
     when :services
       # oParams[sObjectType] will provide the controller object.
@@ -367,22 +394,88 @@ class OpenstackController
       end
       return result
     else
-      controller_error "'%s' is not a valid object for 'get_services'",
+      controller_error "'%s' is not a valid object for 'list_services'",
                        sObjectType
     end
   end
 
-  def format_retrieve_result(retrieve_result)
-    {
-      :auth_token => retrieve_result['access']['token']['id'],
-      :expires => retrieve_result['access']['token']['expires'],
-      :service_catalog =>
-          get_service_catalog(retrieve_result['access']['serviceCatalog']),
-      :endpoint_url => nil,
-      :cdn_endpoint_url => nil
-    }
+  # function to return a well formatted data for list of services
+  def get_services(hParams)
+    # Fog use URI type for auth uri: URI.parse('credentials#auth_uri')
+    # Convert openstack_auth_uri to type URI
+    openstack_auth_url = hParams[:hdata][:openstack_auth_url]
+    hParams[:hdata][:openstack_auth_uri] = URI.parse(openstack_auth_url)
+
+    case openstack_auth_url
+    when /v1(\.\d+)?/
+      version = :v1
+      body = Fog::OpenStack.retrieve_tokens_v1(hParams[:hdata],
+                                               hParams[:excon_opts])
+    when /v2(\.\d+)?/
+      version = :v2
+      body = Fog::OpenStack.retrieve_tokens_v2(hParams[:hdata],
+                                               hParams[:excon_opts])
+    when /v3(\.\d+)?/
+      version = :v3
+      body = Fog::OpenStack.retrieve_tokens_v3(hParams[:hdata],
+                                               hParams[:excon_opts])
+    else
+      version = :v2
+      body = Fog::OpenStack.retrieve_tokens_v2(hParams[:hdata],
+                                               hParams[:excon_opts])
+    end
+    build_result(version, body)
+  end
+  # Function to provide a wel formatted standard data, usable by openstack
+  # provider
+  #
+  # * *args*:
+  #   - version: :v1, :v2 or :v3. Based on openstack authentication version
+  #   - body: result of Internal Fog::OpenStack.retrieve_tokens_v?
+  # * *returns*:
+  #   - Hash: Requires at least:
+  #     - :service_catalog : Hash of services available.
+  #
+  def build_result(version, body)
+    case version
+    when :v1 # Not supported
+      { :service_catalog => {} }
+    when :v2 #
+      {
+        :auth_token => body['access']['token']['id'],
+        :expires => body['access']['token']['expires'],
+        :service_catalog =>
+            get_service_catalog(body['access']['serviceCatalog']),
+        :endpoint_url => nil,
+        :cdn_endpoint_url => nil
+      }
+    when :v3 # body is an Array: 0 is the body, and 1 is the header
+      {
+        :auth_token => body[1]['X-Subject-Token'],
+        :expires => body[0]['token']['expires'],
+        :service_catalog =>
+            get_service_catalog(body[0]['token']['catalog']),
+        :endpoint_url => nil,
+        :cdn_endpoint_url => nil
+      }
+    end
   end
 
+  # Build service catalog at the following format:
+  #
+  # :<type>:
+  #   'name': <name>
+  #   :<region> : <url>
+  #
+  # where:
+  # - type  : Can be :identity, :orchestration, :volume, ...
+  # - name  : Is the name of the service like 'swift', 'heat', 'cinder', ...
+  # - region: Is the region name. Can be any string like 'regionOne'
+  # - url   : is the exposed url of that service
+  #           like https://swift.company.com/v1/HOSP_...
+  #
+  # It supports V2/V3 service auth response.
+  #
   def get_service_catalog(body)
     fail 'Unable to parse service catalog.' unless body
     service_catalog = {}
@@ -392,19 +485,30 @@ class OpenstackController
       type = type.to_sym
       next if s['endpoints'].nil?
       service_catalog[type] = {}
+      # V2/V3 auth output
       service_catalog[type]['name'] = s['name']
-      service_catalog = parse_service_catalog_endpoint(s, type, service_catalog)
+      parse_service_catalog_endpoint(s, type, service_catalog)
     end
     service_catalog
   end
 
+  # function which read a list of endpoints of a service to extract the url
+  #
+  # v2: Get 'endpoints'[]/'publicURL'
+  # v3: Get 'endpoints'[]/'url' if 'endpoints'[]/'interface' == 'public'
   def parse_service_catalog_endpoint(s, type, service_catalog)
     s['endpoints'].each do |ep|
       next if ep['region'].nil?
-      next if ep['publicURL'].nil?
-      next if ep['publicURL'].empty?
+
+      if ep['interface'] == 'public' # V3 auth output
+        service_catalog[type][ep['region'].to_sym] = ep['url']
+        break
+      end
+
+      next if ep['publicURL'].nil? || ep['publicURL'].empty?
+      # V2 auth output
       service_catalog[type][ep['region'].to_sym] = ep['publicURL']
+      break
     end
-    service_catalog
   end
 end

data/lib/{providers → process/cloud/providers}/openstack/openstack_create.rb

@@ -78,13 +78,13 @@ class OpenstackController
 
   def create_keypairs(hParams)
     required?(hParams, :compute_connection)
-    required?(hParams, :keypair_name)
+    required?(hParams, 'credentials#keypair_name')
     required?(hParams, :public_key)
 
     # API:
     # https://github.com/fog/fog/blob/master/lib/fog/openstack/docs/compute.md
     service = hParams[:compute_connection]
-    service.key_pairs.create(:name => hParams[:keypair_name],
+    service.key_pairs.create(:name => hParams['credentials#keypair_name'],
                              :public_key => hParams[:public_key])
   end
 
@@ -126,7 +126,11 @@ class OpenstackController
     while server.state != 'ACTIVE'
       sleep(5)
       server = compute_connect.servers.get(server.id)
-      return if server.state == 'ERROR'
+
+      if server.state == 'Error'
+        controller_error('Unable to assign a Public IP to a server '\
+                         "in error '%s'", server.name)
+      end
     end
 
     addresses = compute_connect.addresses.all

data/lib/{providers → process/cloud/providers}/openstack/openstack_process.rb

@@ -17,10 +17,15 @@
 # Specific openstack process added to the application process.
 class OpenstackProcess
   def openstack_get_tenant(sObjectType, hParams)
-    tenant_name = hParams[:tenant]
+    tenant_name = hParams['credentials#tenant']
     query = { :name => tenant_name }
     PrcLib.state("searching for tenant '%s'", tenant_name)
     list = query_single(sObjectType, query, tenant_name)
     return list[0] if list.length > 0
   end
+
+  def openstack_domain_required?(_data)
+    return true if config[:auth_uri].match(%r{/v3/})
+    false
+  end
 end

data/lorj_cloud.gemspec

@@ -8,6 +8,7 @@ Gem::Specification.new do |spec|
   spec.version       = LorjCloud::VERSION
   spec.authors       = ["Christophe Larsonneur"]
   spec.email         = ["clarsonneur@gmail.com"]
+  spec.date          = LorjCloud::DATE
 
   spec.summary       = %q{Lorj cloud process.}
   spec.description   = %q{simplify cloud management, thanks to predefined process to manage cloud obj and make it work. }
@@ -25,8 +26,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.9"
   spec.add_development_dependency "rake", "~> 10.0"
   
-  spec.add_runtime_dependency "lorj", "~> 1.0.10"
-  spec.add_runtime_dependency "fog", "~> 1.26.0"
+  spec.add_runtime_dependency "lorj", "~> 1.0.11"
+  spec.add_runtime_dependency "fog", "~> 1.30.0"
   spec.add_development_dependency "rspec", "~> 3.1.0"
-  spec.add_development_dependency "rubocop", "~> 0.30.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lorj_cloud
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Christophe Larsonneur
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-04-17 00:00:00.000000000 Z
+date: 2015-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -44,28 +44,28 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.0.10
+        version: 1.0.11
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.0.10
+        version: 1.0.11
 - !ruby/object:Gem::Dependency
   name: fog
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.26.0
+        version: 1.30.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.26.0
+        version: 1.30.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -80,20 +80,6 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 3.1.0
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.30.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.30.0
 description: 'simplify cloud management, thanks to predefined process to manage cloud
   obj and make it work. '
 email:
@@ -110,11 +96,12 @@ files:
 - README.md
 - Rakefile
 - bin/console
+- bin/lorj_cloud
 - bin/setup
-- lib/data.yaml
-- lib/defaults.yaml
 - lib/lorj_cloud.rb
 - lib/lorj_cloud/version.rb
+- lib/process/cloud/data.yaml
+- lib/process/cloud/defaults.yaml
 - lib/process/cloud/process/common.rb
 - lib/process/cloud/process/connection.rb
 - lib/process/cloud/process/external_network.rb
@@ -131,22 +118,22 @@ files:
 - lib/process/cloud/process/server.rb
 - lib/process/cloud/process/server_log.rb
 - lib/process/cloud/process/subnetwork.rb
+- lib/process/cloud/providers/hpcloud/compute.rb
+- lib/process/cloud/providers/hpcloud/hpcloud.rb
+- lib/process/cloud/providers/hpcloud/network.rb
+- lib/process/cloud/providers/hpcloud/security_groups.rb
+- lib/process/cloud/providers/mock/mock.rb
+- lib/process/cloud/providers/openstack/openstack.rb
+- lib/process/cloud/providers/openstack/openstack_create.rb
+- lib/process/cloud/providers/openstack/openstack_delete.rb
+- lib/process/cloud/providers/openstack/openstack_get.rb
+- lib/process/cloud/providers/openstack/openstack_process.rb
+- lib/process/cloud/providers/openstack/openstack_query.rb
+- lib/process/cloud/providers/openstack/openstack_update.rb
+- lib/process/cloud/providers/templates/compute.rb
+- lib/process/cloud/providers/templates/mycloud.rb
+- lib/process/cloud/providers/templates/network.rb
 - lib/process/cloud_process.rb
-- lib/providers/hpcloud/compute.rb
-- lib/providers/hpcloud/hpcloud.rb
-- lib/providers/hpcloud/network.rb
-- lib/providers/hpcloud/security_groups.rb
-- lib/providers/mock/mock.rb
-- lib/providers/openstack/openstack.rb
-- lib/providers/openstack/openstack_create.rb
-- lib/providers/openstack/openstack_delete.rb
-- lib/providers/openstack/openstack_get.rb
-- lib/providers/openstack/openstack_process.rb
-- lib/providers/openstack/openstack_query.rb
-- lib/providers/openstack/openstack_update.rb
-- lib/providers/templates/compute.rb
-- lib/providers/templates/mycloud.rb
-- lib/providers/templates/network.rb
 - lorj_cloud.gemspec
 homepage: https://github.com/forj-oss/lorj_cloud
 licenses: []
@@ -172,4 +159,3 @@ signing_key:
 specification_version: 4
 summary: Lorj cloud process.
 test_files: []
-has_rdoc: