deltacloud-client-vm 1.1.4.2 → 1.1.4.3

data/lib/deltacloud_vm/client/methods/firewall.rb

@@ -0,0 +1,67 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.  The
+# ASF licenses this file to you 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.
+
+module DeltacloudVM::Client
+  module Methods
+    module Firewall
+
+      # Retrieve list of all firewall entities
+      #
+      # - filter_opts:
+      #   - :id -> Filter entities using 'id' attribute
+      #
+      def firewalls(filter_opts={})
+        from_collection :firewalls,
+        connection.get(api_uri('firewalls'), filter_opts)
+      end
+
+      # Retrieve the single firewall entity
+      #
+      # - firewall_id -> Firewall entity to retrieve
+      #
+      def firewall(firewall_id)
+        from_resource :firewall,
+          connection.get(api_uri("firewalls/#{firewall_id}"))
+      end
+
+      # Create a new firewall
+      #
+      # - name - Name to associate with new firewall
+      # - create_opts
+      #   :name -> Name of firewall
+      #
+      def create_firewall(name, create_opts={})
+        create_resource :firewall, { :name => name }.merge(create_opts)
+      end
+
+      def destroy_firewall(firewall_id)
+        destroy_resource :firewall, firewall_id
+      end
+
+      def add_firewall_rule(firewall_id, protocol, port_from, port_to, opts={})
+        r = connection.post(api_uri("firewalls/#{firewall_id}/rules")) do |request|
+          request.params = {
+            :protocol => protocol,
+            :port_from => port_from,
+            :port_to => port_to
+          }
+          # TODO: Add support for sources
+        end
+        model(:firewall).convert(self, r.body)
+      end
+
+    end
+  end
+end

data/lib/deltacloud_vm/client/methods/hardware_profile.rb

@@ -0,0 +1,41 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.  The
+# ASF licenses this file to you 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.
+
+module DeltacloudVM::Client
+  module Methods
+    module HardwareProfile
+
+      # Retrieve list of all hardware_profiles
+      #
+      # - filter_opts:
+      #   - :id -> Filter hardware_profiles using their 'id'
+      #
+      def hardware_profiles(filter_opts={})
+        from_collection :hardware_profiles,
+          connection.get(api_uri('hardware_profiles'), filter_opts)
+      end
+
+      # Retrieve the given hardware_profile
+      #
+      # - hwp_id -> hardware_profile to retrieve
+      #
+      def hardware_profile(hwp_id)
+        from_resource :hardware_profile,
+          connection.get(api_uri("hardware_profiles/#{hwp_id}"))
+      end
+
+    end
+  end
+end

data/lib/deltacloud_vm/client/methods/image.rb

@@ -0,0 +1,61 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.  The
+# ASF licenses this file to you 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.
+
+module DeltacloudVM::Client
+  module Methods
+    module Image
+
+      # Retrieve list of all images
+      #
+      # - filter_opts:
+      #   - :id -> Filter images using their 'id'
+      #   - :state -> Filter images  by their 'state'
+      #   - :architecture -> Filter images  by their 'architecture'
+      #
+      def images(filter_opts={})
+        from_collection :images,
+          connection.get(api_uri('images'), filter_opts)
+      end
+
+      # Retrieve the given image
+      #
+      # - image_id -> Image to retrieve
+      #
+      def image(image_id)
+        from_resource :image,
+          connection.get(api_uri("images/#{image_id}"))
+      end
+
+      # Create a new image from instance
+      #
+      # - instance_id -> The stopped instance used for creation
+      # - create_opts
+      #   - :name     -> Name of the new image
+      #   - :description -> Description of the new image
+      #
+      def create_image(instance_id, create_opts={})
+        create_resource :image, { :instance_id => instance_id }.merge(create_opts)
+      end
+
+      # Destroy given image
+      # NOTE: This operation might not be supported for all drivers.
+      #
+      def destroy_image(image_id)
+        destroy_resource :image, image_id
+      end
+
+    end
+  end
+end

data/lib/deltacloud_vm/client/methods/instance.rb

@@ -0,0 +1,141 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.  The
+# ASF licenses this file to you 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.
+
+module DeltacloudVM::Client
+  module Methods
+    module Instance
+
+      # Retrieve list of all instances
+      #
+      # - filter_opts:
+      #   - :id -> Filter instances using their 'id'
+      #   - :state -> Filter instances by their 'state'
+      #   - :realm_id -> Filter instances based on their 'realm_id'
+      #
+      def instances(filter_opts={})
+        from_collection(
+          :instances,
+          connection.get(api_uri('/instances'), filter_opts)
+        )
+      end
+
+      # Retrieve the given instance
+      #
+      # - instance_id -> Instance to retrieve
+      #
+      def instance(instance_id)
+        from_resource(
+          :instance,
+          connection.get(api_uri("instances/#{instance_id}"))
+        )
+      end
+
+      # Create a new instance
+      #
+      # - image_id ->    Image to use for instance creation
+      #                  (img1, ami-12345, etc...)
+      # - create_opts -> Various options that DC support for the current
+      #                  provider.
+      #
+      # Returns created instance, or list of created instances or all instances.
+      #
+      def create_instance(image_id, create_opts={})
+        create_opts[:user_data] = Base64::encode64(create_opts[:user_data]) if create_opts[:user_data]
+        r = create_resource :instance, create_opts.merge(
+          :image_id => image_id,
+          :no_convert_model => true
+        )
+        parse_create_instance(r)
+      end
+
+      # Destroy the current +Instance+
+      # Returns 'true' if the response was 204 No Content
+      #
+      # - instance_id -> The 'id' of the Instance to destroy
+      #
+      def destroy_instance(instance_id)
+        destroy_resource :instance, instance_id
+      end
+
+      # Attempt to change the +Instance+ state to STOPPED
+      #
+      # - instance_id -> The 'id' of the Instance to stop
+      #
+      def stop_instance(instance_id)
+        instance_action :stop, instance_id
+      end
+
+      # Attempt to change the +Instance+ state to STARTED
+      #
+      # - instance_id -> The 'id' of the Instance to start
+      #
+      def start_instance(instance_id)
+        instance_action :start, instance_id
+      end
+
+      # Attempt to reboot the +Instance+
+      #
+      # - instance_id -> The 'id' of the Instance to reboot
+      #
+      def reboot_instance(instance_id)
+        instance_action :reboot, instance_id
+      end
+
+      private
+
+      # Avoid codu duplication ;-)
+      #
+      def instance_action(action, instance_id)
+        result = connection.post(
+          api_uri("/instances/#{instance_id}/#{action}")
+        )
+        if result.status.is_ok?
+          from_resource(:instance, result)
+        else
+          instance(instance_id)
+        end
+      end
+
+      # Handles parsing of +create_instance+ method
+      #
+      # - response -> +create_instance+ HTTP response body
+      #
+      def parse_create_instance(response)
+        # If DeltacloudVM API return only Location (30x), follow it and
+        # retrieve created instance from there.
+        #
+        if response.status.is_redirect?
+          # If DeltacloudVM API redirect to list of instances
+          # then return list of **all** instances, otherwise
+          # grab the instance_id from Location header
+          #
+          redirect_instance = response.headers['Location'].split('/').last
+          if redirect_instance == 'instances'
+            instances
+          else
+            instance(redirect_instance)
+          end
+        elsif response.body.to_xml.root.name == 'instances'
+          # If more than 1 instance was created, return list
+          #
+          from_collection(:instances, response.body)
+        else
+          from_resource(:instance, response)
+        end
+      end
+
+    end
+  end
+end

data/lib/deltacloud_vm/client/methods/instance_state.rb

@@ -0,0 +1,41 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.  The
+# ASF licenses this file to you 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.
+
+module DeltacloudVM::Client
+  module Methods
+    module InstanceState
+
+      # Representation of the current driver state machine
+      #
+      def instance_states
+        r = connection.get(api_uri("instance_states"))
+        r.body.to_xml.root.xpath('state').map do |se|
+          state = model(:instance_state).new_state(se['name'])
+          se.xpath('transition').each do |te|
+            state.transitions << model(:instance_state).new_transition(
+              te['to'], te['action']
+            )
+          end
+          state
+        end
+      end
+
+      def instance_state(name)
+        instance_states.find { |s| s.name.to_s.eql?(name.to_s) }
+      end
+
+    end
+  end
+end

data/lib/deltacloud_vm/client/methods/key.rb

@@ -0,0 +1,58 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.  The
+# ASF licenses this file to you 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.
+
+module DeltacloudVM::Client
+  module Methods
+    module Key
+
+      # Retrieve list of all key entities
+      #
+      # - filter_opts:
+      #   - :id -> Filter entities using 'id' attribute
+      #
+      def keys(filter_opts={})
+        from_collection :keys,
+          connection.get(api_uri('keys'), filter_opts)
+      end
+
+      # Retrieve the single key entity
+      #
+      # - key_id -> Key entity to retrieve
+      #
+      def key(key_id)
+        from_resource :key,
+          connection.get(api_uri("keys/#{key_id}"))
+      end
+
+      # Create a new credentials to use with authentication
+      # to an +Instance+
+      #
+      # - key_name -> The name of the key
+      # - create_opts
+      #   : public_key -> Your SSH public key (eg. ~/.ssh/id_rsa.pub)
+      #
+      def create_key(key_name, create_opts={})
+        create_resource :key, create_opts.merge(:name => key_name)
+      end
+
+      # Destroy the SSH key
+      #
+      def destroy_key(key_id)
+        destroy_resource :key, key_id
+      end
+
+    end
+  end
+end

data/lib/deltacloud_vm/client/methods/load_balancer.rb

@@ -0,0 +1,96 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.  The
+# ASF licenses this file to you 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.
+
+module DeltacloudVM::Client
+  module Methods
+    module LoadBalancer
+
+      # Retrieve list of all load_balancer entities
+      #
+      # Filter options:
+      #
+      # - :id -> Filter entities using 'id' attribute
+      #
+      def load_balancers(filter_opts={})
+        from_collection :load_balancers,
+        connection.get(api_uri('load_balancers'), filter_opts)
+      end
+
+      # Retrieve the single load_balancer entity
+      #
+      # - load_balancer_id -> LoadBalancer entity to retrieve
+      #
+      def load_balancer(load_balancer_id)
+        from_resource :load_balancer,
+          connection.get(api_uri("load_balancers/#{load_balancer_id}"))
+      end
+
+      # Destroy load balancer
+      # Returns 'true' if the response was 204 No Content
+      #
+      # - load_balancer_id -> The 'id' of the LoadBalancer to destroy
+      #
+      def destroy_load_balancer(load_balancer_id)
+        destroy_resource :load_balancer, load_balancer_id
+      end
+
+      # Create a new load_balancer
+      #
+      # - create_opts
+      # :name               - Load Balancer name
+      # :realm_id           - Load Balancer realm id
+      # :listener_protocol  - Protocol to use for LB listener (HTTP or TCP)
+      # :listener_balancer_port - Load Balancer port (like. 80)
+      # :listener_instance_port - Instances port (like, 8080)
+      #
+      # Example:
+      #
+      #  client.create_load_balancer(:name => 'test2', :realm_id => 'us-east-1a', :listener_protocol => 'HTTP', :listener_balancer_port => '80', :listener_instance_port => '8080')
+      #
+      def create_load_balancer(create_opts={})
+        must_support! :load_balancers
+        response = connection.post(api_uri('load_balancers')) do |request|
+          request.params = create_opts
+        end
+        model(:load_balancer).convert(self, response.body)
+      end
+
+      # Register an Instance to given Load Balancer
+      #
+      # load_balancer_id - Load Balancer to use
+      # instance_id      - Instance to register to load balancer
+      #
+      def register_instance(load_balancer_id, instance_id)
+        response = connection.post(api_uri("/load_balancers/#{load_balancer_id}/register")) do |request|
+          request.params = { 'instance_id' => instance_id }
+        end
+        model(:load_balancer).convert(self, response.body)
+      end
+
+      # Unregister an Instance from given Load Balancer
+      #
+      # load_balancer_id - Load Balancer to use
+      # instance_id      - Instance to unregister from load balancer
+      #
+      def unregister_instance(load_balancer_id, instance_id)
+        response = connection.post(api_uri("/load_balancers/#{load_balancer_id}/unregister")) do |request|
+          request.params = { 'instance_id' => instance_id }
+        end
+        model(:load_balancer).convert(self, response.body)
+      end
+
+    end
+  end
+end