stax 0.1.15 → 0.1.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2f568912290ecbedb81651020823c805d852d376bb7258143cecf3f4fada6669
-  data.tar.gz: f05fefe06932f2cfb2d61ef46dae6ea61ffd64cb861fb165505e59946ace1a56
+  metadata.gz: 71409fa2f0b164176dd1939b5db76d2f61459debdaad1ea5ff2d8c78f4068860
+  data.tar.gz: a054ede18a8a56ddb3be6d142d75e0a14e5ccec43ac816213b561b6a3549fcdb
 SHA512:
-  metadata.gz: 98b027a525e66191c981c8ef664bd803765cee72df66d2106acffd21ead9409ccb17749991144ec09da57415bf971e4c0124a68fec71485cc49f0432ae07d4a5
-  data.tar.gz: a038562e8c5524f78c2a20a8ff7b5580c14c40d5af86b2a210cd4627c2347d16cbd73338b63a52ee116885a245005691bc02a6ca275ca6ee5506e24f1dc1312c
+  metadata.gz: f4e8797a309b2558fcc316a69acda2a8125c08b8b104dcc5f1b9fd1d78f0d56229c3253147d13e6457add20171416f8c0a96f36eca1e75fd5127ba32f3ed47b4
+  data.tar.gz: 9fd02c1d9048cb92bf996808e8956dbf8eb1c5ce95134ebfb54402e3a094d039804128c3ba5cf235fc124bf9a6a63cbff8267b250a9ac55532f01b43054fffb5

data/lib/stax/mixin/rds.rb

@@ -17,6 +17,9 @@ module Stax
         'in-sync': :green,
         Complete:  :green,
         Active:    :green,
+        COMPLETED: :green,
+        AVAILABLE: :green,
+        SWITCHOVER_COMPLETED: :green,
       }
 
       no_commands do
@@ -132,6 +135,205 @@ module Stax
         end
       end
 
+      desc 'create-upgrade-candidate', 'create blue/green deployment'
+      method_option :target_engine_version, type: :string, default: '', desc: 'target engine version'
+      method_option :target_cluster_parameter_group, type: :string, default: '', desc: 'target cluster parameter group'
+      method_option :target_instance_parameter_group, type: :string, default: '', desc: 'target instance parameter group'
+      method_option :target_db_instance_class, type: :string, default: '', desc: 'target instance class'
+      def create_upgrade_candidate
+        target_engine_version = options[:target_engine_version]
+        target_cluster_parameter_group = options[:target_cluster_parameter_group]
+        target_instance_parameter_group = options[:target_instance_parameter_group]
+        target_db_instance_class = options[:target_db_instance_class]
+
+        unless stack_rds_clusters.is_a?(Array) && stack_rds_clusters.any?
+          say("No DB clusters associated with #{my.stack_name}", :red)
+          return
+        end        
+
+        # get cluster source_arn from stack
+        if stack_rds_clusters.length == 1
+          source_arn = stack_rds_clusters[0].db_cluster_arn
+        else
+          say("Multiple DB Clusters associated with #{my.stack_name}. Cannot determine which cluster to use as source.", :red)
+          return
+        end
+
+        # Specify the required blue/green deployment parameters
+        deployment_params = {
+          blue_green_deployment_name: "#{my.stack_name}-next-#{SecureRandom.alphanumeric(12)}",
+          source: source_arn,
+        }
+
+        # Check if optional values are set and add them to the deployment parameters
+        if !target_engine_version.empty?
+          deployment_params[:target_engine_version] = target_engine_version
+        end
+
+        if !target_cluster_parameter_group.empty?
+          deployment_params[:target_db_cluster_parameter_group_name] = target_cluster_parameter_group
+        end
+
+        if !target_instance_parameter_group.empty?
+          deployment_params[:target_db_parameter_group_name] = target_instance_parameter_group
+        end
+
+        if !target_db_instance_class.empty?
+          deployment_params[:target_db_instance_class] = target_db_instance_class
+        end
+
+        say("Creating blue/green deployment #{deployment_params[:blue_green_deployment_name]} for #{source_arn}", :yellow)
+        resp = Aws::Rds.client.create_blue_green_deployment(deployment_params)
+        if resp.blue_green_deployment.status != "PROVISIONING"
+          say("Failed to create blue/green deployment #{deployment_params[:blue_green_deployment_name]}", :red)
+          puts resp.to_h
+          return
+        end
+
+        invoke(:tail_upgrade_candidate, [], id: resp.blue_green_deployment.blue_green_deployment_identifier)
+      end
+
+      desc 'delete-upgrade-candidate', 'delete blue/green deployment'
+      method_option :id, type: :string, required: true, desc: 'id of blue/green deployment to delete'
+      method_option :delete_target, type: :boolean, default: false, desc: 'delete resources in green deployment'
+      def delete_upgrade_candidate
+        deployment_identifier = options[:id]
+        delete_target = options[:delete_target]
+
+        # Future TODO: Even though the RDS API doesn't allow for target resources to be deleted 
+        # post-switchover (likely because these resources are the old DB resources), we could
+        # allow for an automatic clean up the leftover resources by deleting these resources
+        # with specific RDS API calls.
+        if delete_target && Aws::Rds.client.describe_blue_green_deployments({ blue_green_deployment_identifier: deployment_identifier }).blue_green_deployments[0].status == "SWITCHOVER_COMPLETED"
+          say("You can't specify --delete-target if the blue/green deployment status is SWITCHOVER_COMPLETED", :red)
+          return
+        end
+
+        if yes?("Really delete blue/green deployment #{deployment_identifier}?", :yellow)
+          say("Deleting blue/green deployment #{deployment_identifier}", :red)
+          resp = Aws::Rds.client.delete_blue_green_deployment({
+            blue_green_deployment_identifier: deployment_identifier,
+            delete_target: delete_target,
+          })
+
+          if resp.blue_green_deployment.status != "DELETING"
+            say("Failed to delete blue/green deployment #{deployment_identifier}", :red)
+            puts resp.to_h
+            return
+          end
+
+          # tail the blue/green deployment until it is deleted
+          begin
+            invoke(:tail_upgrade_candidate, [], id: deployment_identifier)
+          rescue ::Aws::RDS::Errors::BlueGreenDeploymentNotFoundFault
+            say("Deleted blue/green deployment #{deployment_identifier}", :green)
+          end
+        end
+      end
+
+      desc 'switchover-upgrade-candidate', 'switchover blue/green deployment'
+      method_option :id, type: :string, required: true, desc: 'id of blue/green deployment'
+      method_option :timeout, type: :numeric, default: 300, desc: 'amount of time, in seconds, for the switchover to complete'
+      def switchover_upgrade_candidate
+        deployment_identifier = options[:id]
+        timeout = options[:timeout]
+
+        if yes?("Really switchover blue/green deployment #{deployment_identifier}?", :yellow)
+          say("Switchover blue/green deployment #{deployment_identifier}", :yellow)
+          resp = Aws::Rds.client.switchover_blue_green_deployment({
+            blue_green_deployment_identifier: deployment_identifier,
+            switchover_timeout: timeout,
+          })
+
+          if resp.blue_green_deployment.status != "SWITCHOVER_IN_PROGRESS"
+            say("Failed to switchover blue/green deployment #{deployment_identifier}", :red)
+            puts resp.to_h
+            return
+          end
+
+          # tail the blue/green deployment until it is complete
+          invoke(:tail_upgrade_candidate, [], id: deployment_identifier)
+        end
+      end
+
+      desc 'tail-upgrade-candidate', 'tail blue/green deployment'
+      method_option :id, type: :string, required: true, desc: 'id of blue/green deployment'
+      def tail_upgrade_candidate
+        deployment_identifier = options[:id]
+
+        previous_status = nil
+        previous_switchover_details = []
+        previous_tasks = []
+      
+        loop do
+          resp = Aws::Rds.client.describe_blue_green_deployments({
+            blue_green_deployment_identifier: deployment_identifier, 
+          })
+      
+          if resp[:blue_green_deployments].empty?
+            say("Deployment not found: #{deployment_identifier}", :red)
+            return
+          end
+      
+          deployment = resp[:blue_green_deployments][0]
+
+          current_status = color(deployment[:status])
+          current_switchover_details = deployment[:switchover_details]
+          current_tasks = deployment[:tasks]
+
+          if previous_status.nil?
+            say("Deployment Name: #{deployment[:blue_green_deployment_name]}", :blue)
+            say("Deployment ID: #{deployment_identifier}", :white)
+            say("Create Time: #{deployment[:create_time]}", :green)
+          end
+            
+          if previous_status.nil? || previous_status != current_status
+            print_table [[Time.now.utc.strftime('%Y-%m-%d %H:%M:%S UTC'), "Deployment Status", current_status]]
+          end
+
+          if !current_switchover_details.nil?
+            current_switchover_details.each do |current_item|
+              previous_item = previous_switchover_details.find { |item| item[:source_member] == current_item[:source_member] }
+              
+              if previous_item.nil? || current_item != previous_item
+                if current_item[:target_member].nil?
+                  prefix = "#{set_color('Pending DB Resource', :cyan)}"
+                else
+                  prefix = current_item[:target_member].include?(':cluster:') ? "#{set_color('DB Cluster', :cyan)}" : "#{set_color('DB Instance', :cyan)}"
+                end
+                print_table [[Time.now.utc.strftime('%Y-%m-%d %H:%M:%S UTC'), prefix, current_item[:target_member], color(current_item[:status] || :CREATING)]]
+              end
+            end
+          end
+      
+          if !current_tasks.nil?
+            current_tasks.each do |current_item|
+              previous_item = previous_tasks.find { |item| item[:name] == current_item[:name] }
+        
+              if previous_item.nil? || current_item != previous_item
+                print_table [[Time.now.utc.strftime('%Y-%m-%d %H:%M:%S UTC'), "#{set_color('Task', :magenta)}", current_item[:name], color(current_item[:status])]]
+              end
+            end
+          end
+
+          if deployment[:status] == "AVAILABLE"
+            say("Deployment is complete.", :green)
+            break
+          end
+
+          if deployment[:status] == "SWITCHOVER_COMPLETED"
+            say("Deployment switchover is complete.", :green)
+            break
+          end
+
+          previous_status = current_status
+          previous_switchover_details = current_switchover_details
+          previous_tasks = current_tasks
+      
+          sleep 10  # Wait for 10 seconds before polling again
+        end
+      end   
+
       desc 'snapshots', 'list snapshots for stack clusters'
       def snapshots
         stack_db_clusters.map(&:physical_resource_id).each do |id|

data/lib/stax/version.rb

@@ -1,3 +1,3 @@
 module Stax
-  VERSION = '0.1.15'
+  VERSION = '0.1.16'
 end

data/stax.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake"
   spec.add_development_dependency "stax-examples"
 
   spec.add_dependency('aws-sdk-cloudformation')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stax
 version: !ruby/object:Gem::Version
-  version: 0.1.15
+  version: 0.1.16
 platform: ruby
 authors:
 - Richard Lister
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-10 00:00:00.000000000 Z
+date: 2023-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -28,16 +28,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: stax-examples
   requirement: !ruby/object:Gem::Requirement
@@ -610,7 +610,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Control Cloudformation stack and other stuff.