deltacloud-client 1.1.2 → 1.1.3

data/lib/deltacloud/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 Deltacloud::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/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 Deltacloud::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/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 Deltacloud::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

data/lib/deltacloud/client/methods/metric.rb

@@ -0,0 +1,54 @@
+# 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 Deltacloud::Client
+  module Methods
+    module Metric
+
+      # Retrieve list of all metric entities
+      #
+      # Filter options:
+      #
+      # - :id -> Filter entities using 'id' attribute
+      #
+      def metrics(filter_opts={})
+        from_collection :metrics,
+        connection.get(api_uri('metrics'), filter_opts)
+      end
+
+      # Retrieve the single metric entity
+      #
+      # - metric_id -> Metric entity to retrieve
+      #
+      def metric(metric_id)
+        from_resource :metric,
+          connection.get(api_uri("metrics/#{metric_id}"))
+      end
+
+      # Create a new metric
+      #
+      # - create_opts
+      #
+      # def create_metric(create_opts={})
+      #   must_support! :metrics
+      #    response = connection.post(api_uri('metrics')) do |request|
+      #     request.params = create_opts
+      #   end
+      #   model(:metric).convert(self, response.body)
+      # end
+
+    end
+  end
+end

data/lib/deltacloud/client/methods/realm.rb

@@ -0,0 +1,42 @@
+# 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 Deltacloud::Client
+  module Methods
+    module Realm
+
+      # Retrieve list of all realms
+      #
+      # - filter_opts:
+      #   - :id -> Filter realms using their 'id'
+      #   - :state -> Filter realms  by their 'state'
+      #
+      def realms(filter_opts={})
+        from_collection :realms,
+          connection.get(api_uri("realms"), filter_opts)
+      end
+
+      # Retrieve the given realm
+      #
+      # - realm_id -> Instance to retrieve
+      #
+      def realm(realm_id)
+        from_resource :realm,
+          connection.get(api_uri("realms/#{realm_id}"))
+      end
+
+    end
+  end
+end

data/lib/deltacloud/client/methods/storage_snapshot.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 Deltacloud::Client
+  module Methods
+    module StorageSnapshot
+
+      # Retrieve list of all storage_snapshot entities
+      #
+      # - filter_options:
+      #   - :id -> Filter entities using 'id' attribute
+      #
+      def storage_snapshots(filter_opts={})
+        from_collection :storage_snapshots,
+          connection.get(api_uri('storage_snapshots'), filter_opts)
+      end
+
+      # Retrieve the single storage_snapshot entity
+      #
+      # - storage_snapshot_id -> StorageSnapshot entity to retrieve
+      #
+      def storage_snapshot(storage_snapshot_id)
+        from_resource :storage_snapshot,
+          connection.get(api_uri("storage_snapshots/#{storage_snapshot_id}"))
+      end
+
+      # Create a new StorageSnapshot based on +volume_id+
+      #
+      # - volume_id -> ID of the +StorageVolume+ to create snapshot from
+      # - create_opts ->
+      #   - :name -> Name of the StorageSnapshot
+      #   - :description -> Description of the StorageSnapshot
+      #
+      def create_storage_snapshot(volume_id, create_opts={})
+        create_resource :storage_snapshot, create_opts.merge(:volume_id => volume_id)
+      end
+
+      # Destroy the current +StorageSnapshot+
+      # Returns 'true' if the response was 204 No Content
+      #
+      # - snapshot_id -> The 'id' of the snapshot to destroy
+      #
+      def destroy_storage_snapshot(snapshot_id)
+        destroy_resource :storage_snapshot, snapshot_id
+      end
+
+    end
+  end
+end

data/lib/deltacloud/client/methods/storage_volume.rb

@@ -0,0 +1,94 @@
+# 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 Deltacloud::Client
+  module Methods
+    module StorageVolume
+
+      # Retrieve list of all storage_volumes
+      #
+      # - filter_opts:
+      #   - :id -> Filter storage_volumes using their 'id'
+      #   - :state -> Filter storage_volumes  by their 'state'
+      #
+      def storage_volumes(filter_opts={})
+        from_collection :storage_volumes,
+          connection.get(api_uri("storage_volumes"), filter_opts)
+      end
+
+      # Retrieve the given storage_volume
+      #
+      # - storage_volume_id -> Instance to retrieve
+      #
+      def storage_volume(storage_volume_id)
+        from_resource :storage_volume,
+          connection.get(api_uri("storage_volumes/#{storage_volume_id}"))
+      end
+
+      # Create new storage volume
+      #
+      # - :snapshot_id -> Snapshot to use for creating a new volume
+      # - :capacity    -> Initial Volume capacity
+      # - :realm_id    -> Create volume in this realm
+      # - :name        -> Volume name
+      # - :description -> Volume description
+      #
+      # NOTE: Some create options might not be supported by backend cloud
+      #
+      def create_storage_volume(create_opts={})
+        create_resource :storage_volume, create_opts
+      end
+
+      # Destroy the current +StorageVolume+
+      # Returns 'true' if the response was 204 No Content
+      #
+      # - volume_id -> The 'id' of the volume to destroy
+      #
+      def destroy_storage_volume(volume_id)
+        destroy_resource :storage_volume, volume_id
+      end
+
+      # Attach the Storage Volume to the Instance
+      # The +device+ parameter could be used if supported.
+      #
+      # - volume_id -> Volume ID (eg. 'vol1')
+      # - instance_id -> Target Instance ID (eg. 'inst1')
+      # - device -> Target device in Instance (eg. '/dev/sda2')
+      #
+      def attach_storage_volume(volume_id, instance_id, device=nil)
+        must_support! :storage_volumes
+        result = connection.post(api_uri("/storage_volumes/#{volume_id}/attach")) do |r|
+          r.params = { :instance_id => instance_id, :device => device }
+        end
+        if result.status.is_ok?
+          from_resource(:storage_volume, result)
+        end
+      end
+
+      # Detach the Storage Volume from the Instance
+      #
+      # -volume_id -> Volume to detach
+      #
+      def detach_storage_volume(volume_id)
+        must_support! :storage_volumes
+        result = connection.post(api_uri("/storage_volumes/#{volume_id}/detach"))
+        if result.status.is_ok?
+          from_resource(:storage_volume, result)
+        end
+      end
+
+    end
+  end
+end