cucloud 0.6.1 → 0.7.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    OTI1MTYwMTY3YzBhZDI0YjA5YjBjM2M0NDc3MGMzYjA1YzAwZDZjZQ==
+    MmNkOGQyOTA4NGFiNzQ3NmNmMWIxNTMwNDM1MTQwMzFiZjRmYTZkMw==
   data.tar.gz: !binary |-
-    NTI0MjVhN2M1MGE0MDE2Mjc1NmNlZTIzZWYyZmVhNDJjZDRhYTM0Mg==
+    MWVjZjQzODJiNGFjNWVmYTEzYzQzMDFlMjBlNDZhMzE4OTgwYWY5OQ==
 SHA512:
   metadata.gz: !binary |-
-    Mzk2YjU0MTNlZDJmMWRiMmJlOGYxNzUxZGI1MGVjMzRhNDFjZGJiNDY1NjI3
-    MTg3YjhkM2I2MzhmMjI0YjZhMDBmN2FkZGMzMDFlYzBlNWQ4Yjc1ZTgzMTcy
-    MjQ2OWQ3NzcwYWRmOWVmODg5ZTEwMzc5NTM0YzBiOTBhYzYzMmY=
+    YTBkMzBhOGI2YWRlMGE0NzI5YzM2ZDc5OTc3NGNkOTgzNjFmMDg5NjU0ZDY2
+    NDA0Y2E2ODI2ZTc0NTM4NzlmZjRkZTUwMTg0YTVhOGFmNDczODAzM2U0ZDg1
+    NTU1ZTM1OWUxY2Q5Yjc4YjAyMjdkNTcxODdjMGM4MDZiMTMwMDY=
   data.tar.gz: !binary |-
-    MWVlMDNkYTY5NzgxZDQ1YmE3ODk2MThjMGQ2ZWMzN2JiNzMxYmQ1MTA3MDU5
-    ZGI3ODZiYjE3MGY2ZTQ1MTZmZWJhYTUyMDM2MzNlYmZiMjMyYTkwYTAzYTQy
-    OWNiODUxOTAwYjRkOGRlYzc4YjdjOGI4Mjk0NWVlM2RhODNmNmI=
+    YzM3MTBmYTQyNTRhM2E3YjM2OGQzODk2NjVmMzBhNmYyMjgxNjM1ZmQ3Yjli
+    NjZhYTM2MWY3MDZiMGJhZDM5M2U5MGYzMjg3NzY1MTVjMzEwZGI2NWM0NDZi
+    ODk4MTgwYzI0NDRhZmVmOTMyYjAxMGE0NTQ3NzI4YTBkNzMyZDY=

data/lib/cucloud.rb

@@ -4,12 +4,14 @@ require 'aws-sdk'
 module Cucloud
   require 'cucloud/version'
   require 'cucloud/ec2_utils'
+  require 'cucloud/ecs_utils'
   require 'cucloud/asg_utils'
   require 'cucloud/ssm_utils'
   require 'cucloud/iam_utils'
   require 'cucloud/vpc_utils'
   require 'cucloud/config_service_utils'
   require 'cucloud/cloud_trail_utils'
+  require 'cucloud/rds_utils'
 
   # This is the default region API calls are made against
   DEFAULT_REGION = 'us-east-1'.freeze

data/lib/cucloud/ec2_utils.rb

@@ -214,5 +214,27 @@ module Cucloud
       end
       volumes_backed_up_recently
     end
+
+    # Find snapshots with supplied properties, currently only supports days_old
+    # @param options [Hash]
+    # @return [Array] list of snapshot ids
+    def find_ebs_snapshots(options = {})
+      days_old = options[:days_old]
+      found_snapshots = []
+      snapshots = @ec2.describe_snapshots(owner_ids: ['self'], filters: [{ name: 'status', values: ['completed'] }])
+
+      snapshots.snapshots.each do |snapshot|
+        if !days_old.nil?
+          snapshot_days_old = (Time.now.to_i - snapshot.start_time.to_i) / SECONDS_IN_A_DAY
+
+          if snapshot_days_old > days_old
+            found_snapshots.push(snapshot.snapshot_id)
+          end
+        else
+          found_snapshots.push(snapshot.snapshot_id)
+        end
+      end
+      found_snapshots
+    end
   end
 end

data/lib/cucloud/ecs_utils.rb

@@ -0,0 +1,97 @@
+module Cucloud
+  # ECSUtils class - anything ecs related goes here!
+  class EcsUtils
+    # Define error classes
+    class InvalidTaskDefinitionError < ArgumentError
+    end
+
+    # Constructor for EcsUtils class
+    # @param ecs_client [Aws::ECS::Client] AWS ECS SDK Client
+    def initialize(ecs_client = Aws::ECS::Client.new)
+      ## DI for testing purposes
+      @ecs = ecs_client
+    end
+
+    # Get task definition details for given revision of task.  If revision is nil, return latest task
+    # @param family_prefix [String] Task family prefix
+    # @param revision [Integer] Specific revision
+    # @return [Aws::ECS::Types::TaskDefinition] Task definition object
+    def get_task_definition(family_prefix, revision = nil)
+      task = if revision.nil?
+               family_prefix
+             else
+               "#{family_prefix}:#{revision}"
+             end
+
+      # https://docs.aws.amazon.com/sdkforruby/api/Aws/ECS/Client.html#describe_task_definition-instance_method
+      @ecs.describe_task_definition(task_definition: task)['task_definition']
+    end
+
+    # Generate task definition options hash (that can be sumitted to AWS SDK) w/ new image
+    # @param task_definition [Aws::ECS::Types::TaskDefinition] Task definition object
+    # @param container_name [String] Name of container for which image should be updated
+    # @param new_image_dtr_uri [String] Location of new image in registry
+    # @return [Hash] An options hash that can be submitted via AWS sdk
+    def generate_td_options_hash_with_new_image(task_definition, container_name, new_image_dtr_uri)
+      options_hash = generate_td_options_hash(task_definition)
+
+      # Definitions can contain more than one container. Update the targetted def.
+      target_container_index = options_hash[:container_definitions].index { |c| c[:name] == container_name }
+      options_hash[:container_definitions][target_container_index][:image] = new_image_dtr_uri
+
+      options_hash
+    end
+
+    # Generate task definition options hash (that can be sumitted to AWS SDK) from existing definition
+    # @param task_definition [Aws::ECS::Types::TaskDefinition] Task definition object
+    # @return [Hash] An options hash that can be submitted via AWS sdk
+    def generate_td_options_hash(task_definition)
+      # make sure we got a valid launch config
+      raise InvalidTaskDefinitionError.new,
+            'Provided task definition is not valid' unless task_definition.is_a? Aws::ECS::Types::TaskDefinition
+
+      # convert to hash (required for aws sdk) and update necessary values
+      options_hash = task_definition.to_h
+
+      # request cannot have arn, revision or keys with empty values
+      options_hash.delete_if do |key, value|
+        key == :task_definition_arn || key == :revision || key == :status || key == :requires_attributes || value == ''
+      end
+    end
+
+    # Create new task definition in AWS
+    # @param options [Hash] Options hash to be passed along in request
+    # @return [Hash] Hash w/ task definition arn, family and revision
+    def register_task_definition(task_definition)
+      # https://docs.aws.amazon.com/sdkforruby/api/Aws/ECS/Client.html#register_task_definition-instance_method
+      new_def = @ecs.register_task_definition(task_definition)['task_definition']
+
+      {
+        arn: new_def['task_definition_arn'],
+        family: new_def['family'],
+        revision: new_def['revision']
+      }
+    end
+
+    # Get definition for service based on service name
+    # @param cluster_name [String] Name of cluster on which this service is configured
+    # @param service_name [String] Name of service
+    # @return [Aws::ECS::Types::Service] Service definition
+    def get_service(cluster_name, service_name)
+      # https://docs.aws.amazon.com/sdkforruby/api/Aws/ECS/Client.html#describe_services-instance_method
+      @ecs.describe_services(cluster: cluster_name, services: [service_name])[:services].first
+    end
+
+    # Update the task definition associated with a service - this effectively deploys new task on service
+    # @param cluster_name [String] Name of cluster on which this service is configured
+    # @param service_name [String] Name of service
+    # @param task_arn [String] Task ARN to be used by service
+    # @return [Aws::ECS::Types::Service] Updated service
+    def update_service_task_definition!(cluster_name, service_name, task_arn)
+      # https://docs.aws.amazon.com/sdkforruby/api/Aws/ECS/Client.html#update_service-instance_method
+      @ecs.update_service(cluster: cluster_name,
+                          service: service_name,
+                          task_definition: task_arn)['service']
+    end
+  end
+end

data/lib/cucloud/rds_utils.rb

@@ -0,0 +1,87 @@
+module Cucloud
+  # RdsUtils class - for interacting with the AWS relational database service
+  class RdsUtils
+    def initialize(rds_client = Aws::RDS::Client.new)
+      @rds = rds_client
+    end
+
+    # Get the RDS instance object with the given name
+    # @param db_instance_identifier [String] RDS instance identifier (e.g., "jadu-test-dev")
+    # @return [Aws::RDS::DBInstance] the instance object
+    def get_instance(db_instance_identifier)
+      resource = Aws::RDS::Resource.new(client: @rds)
+      resource.db_instance(db_instance_identifier)
+    end
+
+    # Begins the creation of a snapshot of the given RDS instance.
+    # This is a non-blocking call so it will return before the snapshot
+    # is created and available.
+    # @param rds_instance [Aws::RDS::DBInstance] the RDS instance which to snapshot
+    # @param tags [Array<Hash>] tags to assign to the snapshot;
+    #   each array element should be of the form { key: "some key", value: "some value" }
+    # @return [Aws::RDS::DBSnapshot] handle to the new snapshot
+    def start_snapshot(rds_instance, tags = [])
+      date = Time.new
+      snap_id = rds_instance.db_instance_identifier + '-' + date.year.to_s + '-' \
+          + zerofill2(date.month) + '-' + zerofill2(date.day) + '-' \
+          + zerofill2(date.hour) + '-' + zerofill2(date.min)
+      rds_instance.create_snapshot(
+        db_snapshot_identifier:  snap_id,
+        tags: tags
+      )
+    end
+
+    # Return list of pending snapshots for the instance.
+    # New snapshots cannot be created if there are any snapshots in the process
+    # of being created for the given instance.
+    # @param rds_instance [Aws::RDS::DBInstance] the RDS instance to examine
+    # @return [Collection<Aws::RDS::DBSnapshot>] the collection of snapshots in the process of being created
+    def pending_snapshots(rds_instance)
+      snaps = rds_instance.snapshots
+      snaps.select do |snap|
+        snap.status == 'creating'
+      end
+    end
+
+    # Wait for the completion and availability of a snapshot.
+    # @param snapshot [Aws::RDS::DBSnapshot] the snapshot of interest
+    # @param max_attempts [Integer] (optional) maximum number of times to poll the snapshot
+    #   for status updates; defaults to nil which polls indefinitely
+    # @param delay [Integer] (optional) number of seconds to delay between polling;
+    #   defaults to 10
+    # @return [Aws::RDS::DBSnapshot] snapshot with updated attributes;
+    #   returns nil if the snapshot did not complete within the allowed time.
+    def wait_until_snapshot_available(snapshot, max_attempts = nil, delay = 10)
+      snapshot.wait_until(max_attempts: max_attempts, delay: delay) do |snap|
+        # Status == available is a conservative test for completion.
+        # A more liberal test would be percent_progress == 100.
+        snap.status == 'available'
+      end
+    rescue Aws::Waiters::Errors::WaiterFailed
+      nil
+    end
+
+    # Create a new snapshot of the instance, if no snapshots are already
+    # in the process of being created, and wait indefinitely
+    # until the snapshot is complete.
+    # @param rds_instance [Aws::RDS::DBInstance] the RDS instance which to snapshot
+    # @param tags [Array<Hash>] tags to assign to the snapshot;
+    #   each array element should be of the form { key: "some key", value: "some value" }
+    # @return  [Aws::RDS::DBSnapshot] handle to the new snapshot;
+    #   nil if a new snapshot cannot be created because of other pending snapshots
+    def create_snapshot_and_wait_until_available(rds_instance, tags = [])
+      return nil unless pending_snapshots(rds_instance).empty?
+      snap = start_snapshot(rds_instance, tags)
+      wait_until_snapshot_available(snap, nil, 10)
+    end
+
+    private
+
+    # Return the given non-negative number as a string, zero-padded to 2 digits.
+    # @param n [Integet] a number 0-99
+    # @return [String] the zero-padded string
+    def zerofill2(n)
+      n.to_s.rjust(2, '0')
+    end
+  end
+end

data/lib/cucloud/version.rb

@@ -1,5 +1,5 @@
 module Cucloud
   # Disable mutable constant warning - freezing this oddly breaks bundler
   # rubocop:disable Style/MutableConstant
-  VERSION = '0.6.1'
+  VERSION = '0.7.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cucloud
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.0
 platform: ruby
 authors:
 - sbower
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-08-17 00:00:00.000000000 Z
+date: 2016-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
@@ -152,8 +152,10 @@ files:
 - lib/cucloud/cloud_trail_utils.rb
 - lib/cucloud/config_service_utils.rb
 - lib/cucloud/ec2_utils.rb
+- lib/cucloud/ecs_utils.rb
 - lib/cucloud/elb_utils.rb
 - lib/cucloud/iam_utils.rb
+- lib/cucloud/rds_utils.rb
 - lib/cucloud/ssm_utils.rb
 - lib/cucloud/version.rb
 - lib/cucloud/vpc_utils.rb