ruby_aem_aws 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 39ea851d8557738c522f0f06fd811dee54378d83
+  data.tar.gz: 931e7372b825518b9e0ad3b23498b0013831c0bb
+SHA512:
+  metadata.gz: da5c388b8803836046e97f8af7ce3308fbd419b230a7fa86483d54508c0f8f0bfdbeb149cc6a3c41dffb2577ddd8387c3a3443b09835f64a75221b86eb53c312
+  data.tar.gz: f66ff53f11b7f035fa337ce3524f5c9630c489b453e799887b09e6e56f6e7ec2237c90e9a7acc88a0332d6241b66a23ead413f9eaa94e2d30aa09c12bb229535

data/lib/ruby_aem_aws.rb

@@ -0,0 +1,74 @@
+# Copyright 2018 Shine Solutions
+#
+# 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_relative 'ruby_aem_aws/consolidated_stack'
+require_relative 'ruby_aem_aws/full_set_stack'
+
+module RubyAemAws
+  # AemAws class represents the AWS stack for AEM.
+  class AemAws
+    # @param conf configuration hash of the following configuration values:
+    # - region: the AWS region (eg ap-southeast-2)
+    # @return new RubyAemAws::AemAws instance
+    def initialize(conf = {})
+      conf[:region] ||= Constants::REGION_DEFAULT
+
+      aws = AwsCreator.create_aws
+      @ec2_client = aws[:Ec2Client]
+      @ec2_resource = aws[:Ec2Resource]
+      @elb_client = aws[:ElbClient]
+      @auto_scaling_client = aws[:AutoScalingClient]
+      # The V2 API only supports Application ELBs, and we currently use Classic.
+      # @elb_client = Aws::ElasticLoadBalancingV2::Client.new(region: conf[:region])
+      @cloud_watch_client = aws[:CloudWatchClient]
+    end
+
+    def test_connection
+      result = []
+      @ec2_client.describe_regions.regions.each do |region|
+        result.push("Region #{region.region_name} (#{region.endpoint})")
+      end
+      !result.empty?
+    end
+
+    # Create a consolidated instance.
+    #
+    # @param stack_prefix AWS tag: StackPrefix
+    # @return new RubyAemAws::ConsolidatedStack instance
+    def consolidated(stack_prefix)
+      RubyAemAws::ConsolidatedStack.new(stack_prefix, @ec2_resource, @cloud_watch_client)
+    end
+
+    # Create a full set instance.
+    #
+    # @param stack_prefix AWS tag: StackPrefix
+    # @return new RubyAemAws::FullSetStack instance
+    def full_set(stack_prefix)
+      RubyAemAws::FullSetStack.new(stack_prefix, @ec2_resource, @elb_client, @auto_scaling_client, @cloud_watch_client)
+    end
+  end
+
+  # Encapsulate AWS class creation for mocking.
+  class AwsCreator
+    def self.create_aws(region = Constants::REGION_DEFAULT)
+      {
+        Ec2Client: Aws::EC2::Client.new(region: region),
+        Ec2Resource: Aws::EC2::Resource.new(region: region),
+        ElbClient: Aws::ElasticLoadBalancing::Client.new(region: region),
+        AutoScalingClient: Aws::AutoScaling::Client.new(region: region),
+        CloudWatchClient: Aws::CloudWatch::Client.new(region: region)
+      }
+    end
+  end
+end

data/lib/ruby_aem_aws/component/abstract_component.rb

@@ -0,0 +1,39 @@
+# Copyright 2018 Shine Solutions
+#
+# 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_relative 'component_descriptor'
+require_relative 'mixins/instance_describer'
+require_relative '../error'
+
+module RubyAemAws
+  # Add common methods to all Components.
+  module AbstractComponent
+    include Component
+    include InstanceDescriber
+
+    def to_s
+      "#{self.class.name.split('::').last}(#{@descriptor.stack_prefix unless @descriptor.nil?})"
+    end
+
+    private def filter_for_descriptor
+      {
+        filters: [
+          { name: 'tag:StackPrefix', values: [@descriptor.stack_prefix] },
+          { name: 'tag:Component', values: [@descriptor.ec2.component] },
+          { name: 'tag:Name', values: [@descriptor.ec2.name] }
+        ]
+      }
+    end
+  end
+end

data/lib/ruby_aem_aws/component/abstract_grouped_component.rb

@@ -0,0 +1,39 @@
+# Copyright 2018 Shine Solutions
+#
+# 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 'aws-sdk'
+require_relative 'abstract_component'
+
+module RubyAemAws
+  # Add common methods to all Components.
+  module AbstractGroupedComponent
+    include AbstractComponent
+
+    def get_all_instances
+      ec2_resource.instances(filter_for_descriptor)
+    end
+
+    def get_instance_by_id(instance_id)
+      ec2_resource.instance(instance_id)
+    end
+
+    def get_num_of_instances
+      get_all_instances.entries.length
+    end
+
+    def get_random_instance
+      get_all_instances.entries.sample
+    end
+  end
+end

data/lib/ruby_aem_aws/component/abstract_single_component.rb

@@ -0,0 +1,35 @@
+# Copyright 2018 Shine Solutions
+#
+# 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 'aws-sdk'
+require_relative 'abstract_component'
+
+module RubyAemAws
+  # Add common methods to all Components.
+  module AbstractSingleComponent
+    include AbstractComponent
+
+    def get_instance
+      instances = ec2_resource.instances(filter_for_descriptor).select { |instance| InstanceState::ALL_ACTIVE.include?(instance.state.name) }
+      count = instances.count
+      raise RubyAemAws::ExpectedSingleInstanceError if count > 1
+      return nil if count.zero?
+      instances.first
+    end
+
+    def get_all_instances
+      [get_instance]
+    end
+  end
+end

data/lib/ruby_aem_aws/component/author.rb

@@ -0,0 +1,44 @@
+# Copyright 2018 Shine Solutions
+#
+# 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_relative 'author_primary'
+require_relative 'author_standby'
+
+module RubyAemAws
+  module Component
+    # Interface to the AWS instances running the Author components of a full-set AEM stack.
+    class Author
+      attr_reader :author_primary, :author_standby
+
+      # ELB_ID = 'AuthorLoadBalancer'.freeze
+      # ELB_NAME = 'AEM Author Load Balancer'.freeze
+
+      # @param stack_prefix AWS tag: StackPrefix
+      # @param ec2_resource AWS EC2 resource
+      # @return new RubyAemAws::FullSet::Author
+      def initialize(stack_prefix, ec2_resource, cloud_watch_client)
+        @author_primary = Component::AuthorPrimary.new(stack_prefix, ec2_resource, cloud_watch_client)
+        @author_standby = Component::AuthorStandby.new(stack_prefix, ec2_resource, cloud_watch_client)
+      end
+
+      # def terminate_primary_instance
+
+      # def terminate_standby_instance
+
+      # def wait_until_healthy
+      #   - wait until both primary and standby are healthy
+      # end
+    end
+  end
+end

data/lib/ruby_aem_aws/component/author_dispatcher.rb

@@ -0,0 +1,55 @@
+# Copyright 2018 Shine Solutions
+#
+# 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_relative 'abstract_grouped_component'
+require_relative 'mixins/healthy_count_verifier'
+require_relative 'mixins/metric_verifier'
+require_relative 'component_descriptor'
+
+module RubyAemAws
+  module Component
+    # Interface to the AWS instances playing and supporting the AuthorDispatcher role in a full-set AEM stack.
+    class AuthorDispatcher
+      attr_reader :descriptor, :ec2_resource, :asg_client, :elb_client, :cloud_watch_client
+      include AbstractGroupedComponent
+      include HealthyCountVerifier
+      include MetricVerifier
+
+      EC2_COMPONENT = 'author-dispatcher'.freeze
+      EC2_NAME = 'AEM Author Dispatcher'.freeze
+      ELB_ID = 'AuthorDispatcherLoadBalancer'.freeze
+      ELB_NAME = 'AEM Author Dispatcher Load Balancer'.freeze
+
+      # @param stack_prefix AWS tag: StackPrefix
+      # @param ec2_resource AWS EC2 resource
+      # @param asg_client AWS AutoScalingGroup client
+      # @param elb_client AWS ElasticLoadBalancer client
+      # @param cloud_watch_client AWS CloudWatch client
+      # @return new RubyAemAws::FullSet::AuthorDispatcher
+      def initialize(stack_prefix, ec2_resource, asg_client, elb_client, cloud_watch_client)
+        @descriptor = ComponentDescriptor.new(stack_prefix,
+                                              EC2Descriptor.new(EC2_COMPONENT, EC2_NAME),
+                                              ELBDescriptor.new(ELB_ID, ELB_NAME))
+        @ec2_resource = ec2_resource
+        @elb_client = elb_client
+        @asg_client = asg_client
+        @cloud_watch_client = cloud_watch_client
+      end
+
+      # def terminate_all_instances
+
+      # def terminate_random_instance
+    end
+  end
+end

data/lib/ruby_aem_aws/component/author_primary.rb

@@ -0,0 +1,42 @@
+# Copyright 2018 Shine Solutions
+#
+# 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_relative 'abstract_single_component'
+require_relative 'mixins/healthy_state_verifier'
+require_relative 'mixins/metric_verifier'
+
+module RubyAemAws
+  module Component
+    # Interface to the AWS instance running the Author-Primary component of a full-set AEM stack.
+    class AuthorPrimary
+      attr_reader :descriptor, :ec2_resource, :cloud_watch_client
+      include AbstractSingleComponent
+      include HealthyStateVerifier
+      include MetricVerifier
+
+      EC2_COMPONENT = 'author-primary'.freeze
+      EC2_NAME = 'AEM Author - Primary'.freeze
+
+      # @param stack_prefix AWS tag: StackPrefix
+      # @param ec2_resource AWS EC2 resource
+      # @return new RubyAemAws::FullSet::AuthorPrimary
+      def initialize(stack_prefix, ec2_resource, cloud_watch_client)
+        @descriptor = ComponentDescriptor.new(stack_prefix,
+                                              EC2Descriptor.new(EC2_COMPONENT, EC2_NAME))
+        @ec2_resource = ec2_resource
+        @cloud_watch_client = cloud_watch_client
+      end
+    end
+  end
+end

data/lib/ruby_aem_aws/component/author_publish_dispatcher.rb

@@ -0,0 +1,45 @@
+# Copyright 2018 Shine Solutions
+#
+# 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 'aws-sdk'
+require_relative 'abstract_single_component'
+require_relative 'mixins/healthy_state_verifier'
+require_relative 'mixins/metric_verifier'
+require_relative 'component_descriptor'
+
+module RubyAemAws
+  module Component
+    # Interface to a single AWS instance running all three AEM components as a consolidated stack.
+    class AuthorPublishDispatcher
+      attr_reader :descriptor, :ec2_resource, :cloud_watch_client
+      include AbstractSingleComponent
+      include HealthyStateVerifier
+      include MetricVerifier
+
+      EC2_COMPONENT = 'author-publish-dispatcher'.freeze
+      EC2_NAME = 'AuthorPublishDispatcher'.freeze
+
+      # @param stack_prefix AWS tag: StackPrefix
+      # @param ec2_resource AWS EC2 resource
+      # @param cloud_watch_client AWS CloudWatch client
+      # @return new RubyAemAws::Consolidated::AuthorPublishDispatcher instance
+      def initialize(stack_prefix, ec2_resource, cloud_watch_client)
+        @descriptor = ComponentDescriptor.new(stack_prefix,
+                                              EC2Descriptor.new(EC2_COMPONENT, EC2_NAME))
+        @ec2_resource = ec2_resource
+        @cloud_watch_client = cloud_watch_client
+      end
+    end
+  end
+end

data/lib/ruby_aem_aws/component/author_standby.rb

@@ -0,0 +1,44 @@
+# Copyright 2018 Shine Solutions
+#
+# 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_relative 'abstract_grouped_component'
+require_relative 'mixins/healthy_state_verifier'
+require_relative 'mixins/metric_verifier'
+
+module RubyAemAws
+  module Component
+    # Interface to the AWS instance running the Author-Standby component of a full-set AEM stack.
+    class AuthorStandby
+      attr_reader :descriptor, :ec2_resource, :cloud_watch_client
+      include AbstractGroupedComponent
+      # Can't verify state by count as there's no ASG.
+      include HealthyStateVerifier
+      include MetricVerifier
+
+      EC2_COMPONENT = 'author-standby'.freeze
+      EC2_NAME = 'AEM Author - Standby'.freeze
+
+      # @param stack_prefix AWS tag: StackPrefix
+      # @param ec2_resource AWS EC2 resource
+      # @param cloud_watch_client AWS CloudWatch client
+      # @return new RubyAemAws::FullSet::AuthorStandby
+      def initialize(stack_prefix, ec2_resource, cloud_watch_client)
+        @descriptor = ComponentDescriptor.new(stack_prefix,
+                                              EC2Descriptor.new(EC2_COMPONENT, EC2_NAME))
+        @ec2_resource = ec2_resource
+        @cloud_watch_client = cloud_watch_client
+      end
+    end
+  end
+end

data/lib/ruby_aem_aws/component/chaos_monkey.rb

@@ -0,0 +1,50 @@
+# Copyright 2018 Shine Solutions
+#
+# 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_relative 'abstract_single_component'
+require_relative 'mixins/healthy_state_verifier'
+require_relative 'mixins/metric_verifier'
+
+module RubyAemAws
+  module Component
+    # Interface to the AWS instance running the ChaosMonkey component of a full-set AEM stack.
+    class ChaosMonkey
+      attr_reader :descriptor, :ec2_resource, :asg_client, :cloud_watch_client
+      include AbstractSingleComponent
+      # Can't verify state by count as there's no ELB.
+      include HealthyStateVerifier
+      include MetricVerifier
+
+      EC2_COMPONENT = 'chaos-monkey'.freeze
+      EC2_NAME = 'AEM Chaos Monkey'.freeze
+
+      # @param stack_prefix AWS tag: StackPrefix
+      # @param ec2_resource AWS EC2 resource
+      # @param asg_client AWS AutoScalingGroup client
+      # @param cloud_watch_client AWS CloudWatch client
+      # @return new RubyAemAws::FullSet::ChaosMonkey
+      def initialize(stack_prefix, ec2_resource, asg_client, cloud_watch_client)
+        @descriptor = ComponentDescriptor.new(stack_prefix,
+                                              EC2Descriptor.new(EC2_COMPONENT, EC2_NAME))
+        @ec2_resource = ec2_resource
+        @asg_client = asg_client
+        @cloud_watch_client = cloud_watch_client
+      end
+
+      # def terminate_all_instances
+
+      # def terminate_random_instance
+    end
+  end
+end

data/lib/ruby_aem_aws/component/component_descriptor.rb

@@ -0,0 +1,27 @@
+# Copyright 2018 Shine Solutions
+#
+# 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.
+
+module RubyAemAws
+  module Component
+    ComponentDescriptor = Struct.new(:stack_prefix_in, :ec2, :elb) do
+      def stack_prefix
+        # Unwrap from {:stack_prefix = value} to the value if necessary.
+        return stack_prefix_in[:stack_prefix] if stack_prefix_in.is_a? Hash
+        stack_prefix_in
+      end
+    end
+    EC2Descriptor = Struct.new(:component, :name)
+    ELBDescriptor = Struct.new(:id, :name)
+  end
+end

data/lib/ruby_aem_aws/component/mixins/healthy_count_verifier.rb

@@ -0,0 +1,135 @@
+# Copyright 2018 Shine Solutions
+#
+# 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_relative '../../constants'
+
+module RubyAemAws
+  # Mixin for checking health of a component via ELB 'healthy' count vs ASG desired_capacity.
+  # Add this to a component to make it capable of determining its own health.
+  module HealthyCountVerifier
+    # Aggregate health_states considered healthy.
+    # @return health_state is ready or scaling.
+    def healthy?
+      %i[ready scaling].include? health_state
+    end
+
+    # Provides detail of the state of the instances comprising the component.
+    # @return one of:
+    # - no_asg: AutoScalingGroup could not be located (by StackPrefix and Component tags).
+    # - no_elb: ElasticLoadBalancer could not be located (by StackPrefix and aws:cloudformation:logical-id tags).
+    # - misconfigured: AutoScalingGroup.desired_capacity is less than 1.
+    # - recovering: ELB running instance count is less than AutoScalingGroup.desired_capacity.
+    # - scaling: ELB running instance count is more than AutoScalingGroup.desired_capacity.
+    # - ready: ELB running instance count is equal to AutoScalingGroup.desired_capacity.
+    def health_state
+      asg = find_auto_scaling_group(asg_client)
+      return :no_asg if asg.nil?
+
+      # Debug:
+      # unless asg.nil?
+      #   puts("ASG: #{asg} #{asg.auto_scaling_group_name} (#{asg.desired_capacity})")
+      #   asg.instances.each do |i|
+      #     puts("  Instance #{i.instance_id}: #{i.health_status}")
+      #   end
+      # end
+
+      elb = find_elb(elb_client)
+      return :no_elb if elb.nil?
+
+      elb_running_instances = 0
+      # puts("ELB: #{elb.load_balancer_name} (#{elb.instances.length})")
+      get_instances_state_from_elb(elb).each do |i|
+        # puts("  Instance #{i[:id]}: #{i[:state]}")
+        elb_running_instances += 1 if i[:state] == RubyAemAws::Constants::INSTANCE_STATE_HEALTHY
+      end
+
+      desired_capacity = asg.desired_capacity
+      # puts("calc health_state: #{elb_running_instances} / #{desired_capacity}")
+      return :misconfigured if desired_capacity < 1
+
+      return :recovering if elb_running_instances < desired_capacity
+      return :scaling if elb_running_instances > desired_capacity
+      :ready
+    end
+
+    def wait_until_healthy
+      raise NotYetImplementedError
+    end
+
+    private
+
+    # @return AutoScalingGroup by StackPrefix and Component tags.
+    def find_auto_scaling_group(asg_client)
+      autoscaling_groups = asg_client.describe_auto_scaling_groups
+      autoscaling_groups.auto_scaling_groups.each do |autoscaling_group|
+        asg_matches_stack_prefix = false
+        asg_matches_component = false
+        tags = autoscaling_group.tags
+        tags.each do |tag|
+          if tag.key == 'StackPrefix' && tag.value == descriptor.stack_prefix
+            asg_matches_stack_prefix = true
+            break if asg_matches_component
+            next
+          end
+          if tag.key == 'Component' && tag.value == descriptor.ec2.component
+            asg_matches_component = true
+            break if asg_matches_stack_prefix
+          end
+        end
+        return autoscaling_group if asg_matches_stack_prefix && asg_matches_component
+      end
+      nil
+    end
+
+    # @return ElasticLoadBalancer by StackPrefix and logical-id tags.
+    def find_elb(elb_client)
+      elbs = elb_client.describe_load_balancers.load_balancer_descriptions
+      elbs.each do |elb|
+        elb_matches_stack_prefix = false
+        elb_matches_logical_id = false
+        tag_descriptions = elb_client.describe_tags(load_balancer_names: [elb.load_balancer_name]).tag_descriptions
+        next if tag_descriptions.empty?
+
+        tags = tag_descriptions[0].tags
+        tags.each do |tag|
+          if tag.key == 'StackPrefix' && tag.value == descriptor.stack_prefix
+            elb_matches_stack_prefix = true
+            break if elb_matches_logical_id
+            next
+          end
+          if tag.key == 'aws:cloudformation:logical-id' && tag.value == descriptor.elb.id
+            elb_matches_logical_id = true
+            break if elb_matches_stack_prefix
+          end
+        end
+        return elb if elb_matches_stack_prefix && elb_matches_logical_id
+      end
+      nil
+    end
+
+    def get_instances_state_from_elb(elb)
+      stack_prefix_instances = []
+      elb.instances.each do |i|
+        instance = get_instance_by_id(i.instance_id)
+        next if instance.nil?
+        instance.tags.each do |tag|
+          next if tag.key != 'StackPrefix'
+          break if tag.value != descriptor.stack_prefix
+          stack_prefix_instances.push(id: i.instance_id, state: instance.state.name)
+        end
+      end
+      stack_prefix_instances
+    end
+  end
+end

data/lib/ruby_aem_aws/component/mixins/healthy_state_verifier.rb

@@ -0,0 +1,36 @@
+# Copyright 2018 Shine Solutions
+#
+# 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_relative '../../constants'
+
+module RubyAemAws
+  # Mixin for checking health of a component via EC2 instance state.
+  # Add this to a component to make it capable of determining its own health.
+  module HealthyStateVerifier
+    # @return true if there are one or more instances matching the descriptor and they are all healthy.
+    def healthy?
+      has_instance = false
+      get_all_instances.each do |i|
+        next if i.nil?
+        has_instance = true
+        return false if i.state.name != Constants::INSTANCE_STATE_HEALTHY
+      end
+      has_instance
+    end
+
+    def wait_until_healthy
+      raise NotYetImplementedError
+    end
+  end
+end

data/lib/ruby_aem_aws/component/mixins/instance_describer.rb

@@ -0,0 +1,33 @@
+# Copyright 2018 Shine Solutions
+#
+# 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.
+
+module RubyAemAws
+  # Mixin for describing component EC2 instance state.
+  # Add this to a component to make it capable of describing its instances.
+  module InstanceDescriber
+    # @return a string containing instance descriptions.
+    def describe_instances
+      descriptions = []
+      get_all_instances.each do |i|
+        next if i.nil?
+        descriptions.push(describe_instance(i))
+      end
+      descriptions.join(', ')
+    end
+
+    def describe_instance(instance)
+      "#{instance.instance_id} (#{instance.state.name})"
+    end
+  end
+end

data/lib/ruby_aem_aws/component/mixins/metric_verifier.rb

@@ -0,0 +1,43 @@
+# Copyright 2018 Shine Solutions
+#
+# 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.
+
+module RubyAemAws
+  # Mixin for checking that an instance has associated CloudWatch metrics.
+  module MetricVerifier
+    # @param metric_name the name of the metric to check for.
+    # @return true if the instance has a metric with @metric_name.
+    def metric?(metric_name)
+      !metric_instances(metric_name).empty?
+    end
+
+    # @param metric_name the name of the metric to check for.
+    # @return an array of instance_ids that have a metric with @metric_name.
+    def metric_instances(metric_name)
+      instances_with_metric = []
+      instances = get_all_instances
+      instances.each do |instance|
+        next if instance.nil?
+        instance_id = instance.instance_id
+        metrics = @cloud_watch_client.list_metrics(namespace: 'AWS/EC2',
+                                                   metric_name: metric_name,
+                                                   dimensions: [
+                                                     name: 'InstanceId',
+                                                     value: instance_id
+                                                   ]).metrics
+        instances_with_metric.push(instance_id) unless metrics.empty?
+      end
+      instances_with_metric
+    end
+  end
+end

data/lib/ruby_aem_aws/component/orchestrator.rb

@@ -0,0 +1,50 @@
+# Copyright 2018 Shine Solutions
+#
+# 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_relative 'abstract_single_component'
+require_relative 'mixins/healthy_state_verifier'
+require_relative 'mixins/metric_verifier'
+
+module RubyAemAws
+  module Component
+    # Interface to the AWS instance running the Orchestrator component of a full-set AEM stack.
+    class Orchestrator
+      attr_reader :descriptor, :ec2_resource, :asg_client, :cloud_watch_client
+      include AbstractSingleComponent
+      # Can't verify state by count as there's no ELB.
+      include HealthyStateVerifier
+      include MetricVerifier
+
+      EC2_COMPONENT = 'orchestrator'.freeze
+      EC2_NAME = 'AEM Orchestrator'.freeze
+
+      # @param stack_prefix AWS tag: StackPrefix
+      # @param ec2_resource AWS EC2 resource
+      # @param asg_client AWS AutoScalingGroup client
+      # @param cloud_watch_client AWS CloudWatch client
+      # @return new RubyAemAws::FullSet::Orchestrator
+      def initialize(stack_prefix, ec2_resource, asg_client, cloud_watch_client)
+        @descriptor = ComponentDescriptor.new(stack_prefix,
+                                              EC2Descriptor.new(EC2_COMPONENT, EC2_NAME))
+        @ec2_resource = ec2_resource
+        @asg_client = asg_client
+        @cloud_watch_client = cloud_watch_client
+      end
+
+      # def terminate_all_instances
+
+      # def terminate_random_instance
+    end
+  end
+end

data/lib/ruby_aem_aws/component/publish.rb

@@ -0,0 +1,50 @@
+# Copyright 2018 Shine Solutions
+#
+# 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_relative 'abstract_grouped_component'
+require_relative 'mixins/healthy_state_verifier'
+require_relative 'mixins/metric_verifier'
+
+module RubyAemAws
+  module Component
+    # Interface to the AWS instance running the Publish component of a full-set AEM stack.
+    class Publish
+      attr_reader :descriptor, :ec2_resource, :cloud_watch_client, :asg_client
+      include AbstractGroupedComponent
+      # Can't verify state by count as there's no ELB.
+      include HealthyStateVerifier
+      include MetricVerifier
+
+      EC2_COMPONENT = 'publish'.freeze
+      EC2_NAME = 'AEM Publish'.freeze
+
+      # @param stack_prefix AWS tag: StackPrefix
+      # @param ec2_resource AWS EC2 resource
+      # @param asg_client AWS AutoScalingGroup client
+      # @param cloud_watch_client AWS CloudWatch client
+      # @return new RubyAemAws::FullSet::AuthorPrimary
+      def initialize(stack_prefix, ec2_resource, asg_client, cloud_watch_client)
+        @descriptor = ComponentDescriptor.new(stack_prefix,
+                                              EC2Descriptor.new(EC2_COMPONENT, EC2_NAME))
+        @ec2_resource = ec2_resource
+        @asg_client = asg_client
+        @cloud_watch_client = cloud_watch_client
+      end
+
+      # def terminate_all_instances
+
+      # def terminate_random_instance
+    end
+  end
+end

data/lib/ruby_aem_aws/component/publish_dispatcher.rb

@@ -0,0 +1,53 @@
+# Copyright 2018 Shine Solutions
+#
+# 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_relative 'abstract_grouped_component'
+require_relative 'mixins/healthy_count_verifier'
+require_relative 'mixins/metric_verifier'
+
+module RubyAemAws
+  module Component
+    # Interface to the AWS instance running the PublishDispatcher component of a full-set AEM stack.
+    class PublishDispatcher
+      attr_reader :descriptor, :ec2_resource, :asg_client, :elb_client, :cloud_watch_client
+      include AbstractGroupedComponent
+      include HealthyCountVerifier
+      include MetricVerifier
+
+      EC2_COMPONENT = 'publish-dispatcher'.freeze
+      EC2_NAME = 'AEM Publish Dispatcher'.freeze
+      ELB_ID = 'PublishDispatcherLoadBalancer'.freeze
+      ELB_NAME = 'AEM Publish Dispatcher Load Balancer'.freeze
+
+      # @param stack_prefix AWS tag: StackPrefix
+      # @param ec2_resource AWS EC2 resource
+      # @param asg_client AWS AutoScalingGroup client
+      # @param cloud_watch_client AWS CloudWatch client
+      # @return new RubyAemAws::FullSet::PublishDispatcher
+      def initialize(stack_prefix, ec2_resource, asg_client, elb_client, cloud_watch_client)
+        @descriptor = ComponentDescriptor.new(stack_prefix,
+                                              EC2Descriptor.new(EC2_COMPONENT, EC2_NAME),
+                                              ELBDescriptor.new(ELB_ID, ELB_NAME))
+        @ec2_resource = ec2_resource
+        @asg_client = asg_client
+        @elb_client = elb_client
+        @cloud_watch_client = cloud_watch_client
+      end
+
+      # def terminate_all_instances
+
+      # def terminate_random_instance
+    end
+  end
+end

data/lib/ruby_aem_aws/consolidated_stack.rb

@@ -0,0 +1,35 @@
+# Copyright 2018 Shine Solutions
+#
+# 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_relative 'component/author_publish_dispatcher'
+
+module RubyAemAws
+  # Factory for the consolidated AEM stack component interface.
+  class ConsolidatedStack
+    # @param stack_prefix AWS tag: StackPrefix
+    # @param ec2_resource AWS EC2 client
+    # @param cloud_watch_client AWS CloudWatch client
+    # @return new RubyAemAws::ConsolidatedStack instance
+    def initialize(stack_prefix, ec2_resource, cloud_watch_client)
+      @stack_prefix = stack_prefix
+      @ec2_resource = ec2_resource
+      @cloud_watch_client = cloud_watch_client
+    end
+
+    # @return new RubyAemAws::Component::AuthorPublishDispatcher instance
+    def author_publish_dispatcher
+      RubyAemAws::Component::AuthorPublishDispatcher.new(@stack_prefix, @ec2_resource, @cloud_watch_client)
+    end
+  end
+end

data/lib/ruby_aem_aws/constants.rb

@@ -0,0 +1,32 @@
+# Copyright 2018 Shine Solutions
+#
+# 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.
+
+module RubyAemAws
+  class InstanceState
+    PENDING = 'pending'.freeze
+    RUNNING = 'running'.freeze
+    SHUTTING_DOWN = 'shutting_down'.freeze
+    TERMINATED = 'terminated'.freeze
+    STOPPING = 'stopping'.freeze
+    STOPPED = 'stopped'.freeze
+
+    ALL_ACTIVE = [PENDING, RUNNING, SHUTTING_DOWN, STOPPING, STOPPED].freeze
+  end
+
+  class Constants
+    REGION_DEFAULT = 'ap-southeast-2'.freeze
+
+    INSTANCE_STATE_HEALTHY = RubyAemAws::InstanceState::RUNNING.freeze
+  end
+end

data/lib/ruby_aem_aws/error.rb

@@ -0,0 +1,36 @@
+# Copyright 2018 Shine Solutions
+#
+# 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.
+
+module RubyAemAws
+  # Raise this when a method is not yet implemented.
+  class NotYetImplementedError < StandardError
+    def initialize(msg = 'Not yet implemented')
+      super
+    end
+  end
+
+  # Raise this when a component unexpectedly has more than one instance.
+  class ExpectedSingleInstanceError < StandardError
+    # def initialize(count, descriptor)
+    #   message << 'Expected exactly one instance'
+    #   message << " but got #{count}" unless count.nil?
+    #   message << "for (#{descriptor.stack_prefix}, #{descriptor.ec2.component}, #{descriptor.ec2.name})" unless descriptor.nil?
+    #   super(message)
+    # end
+
+    def initialize(msg = 'Expected exactly one instance')
+      super
+    end
+  end
+end

data/lib/ruby_aem_aws/full_set_stack.rb

@@ -0,0 +1,69 @@
+# Copyright 2018 Shine Solutions
+#
+# 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_relative 'component/author_dispatcher'
+require_relative 'component/author'
+require_relative 'component/chaos_monkey'
+require_relative 'component/orchestrator'
+require_relative 'component/publish_dispatcher'
+require_relative 'component/publish'
+
+module RubyAemAws
+  # Factory for the full-set AEM stack component interfaces.
+  class FullSetStack
+    # @param stack_prefix AWS tag: StackPrefix
+    # @param ec2_resource AWS EC2 resource
+    # @param elb_client AWS ELB client
+    # @param auto_scaling_client AWS AutoScaling client
+    # @param cloud_watch_client AWS CloudWatch client
+    # @return new RubyAemAws::FullSetStack instance
+    def initialize(stack_prefix, ec2_resource, elb_client, auto_scaling_client, cloud_watch_client)
+      @stack_prefix = stack_prefix
+      @ec2_resource = ec2_resource
+      @elb_client = elb_client
+      @auto_scaling_client = auto_scaling_client
+      @cloud_watch_client = cloud_watch_client
+    end
+
+    # @return new RubyAemAws::Component::AuthorDispatcher instance
+    def author_dispatcher
+      RubyAemAws::Component::AuthorDispatcher.new(@stack_prefix, @ec2_resource, @auto_scaling_client, @elb_client, @cloud_watch_client)
+    end
+
+    # @return new RubyAemAws::Component::Author instance
+    def author
+      RubyAemAws::Component::Author.new(@stack_prefix, @ec2_resource, @cloud_watch_client)
+    end
+
+    # @return new RubyAemAws::Component::ChaosMonkey instance
+    def chaos_monkey
+      RubyAemAws::Component::ChaosMonkey.new(@stack_prefix, @ec2_resource, @auto_scaling_client, @cloud_watch_client)
+    end
+
+    # @return new RubyAemAws::Component::Orchestrator instance
+    def orchestrator
+      RubyAemAws::Component::Orchestrator.new(@stack_prefix, @ec2_resource, @auto_scaling_client, @cloud_watch_client)
+    end
+
+    # @return new RubyAemAws::Component::Publish instance
+    def publish
+      RubyAemAws::Component::Publish.new(@stack_prefix, @ec2_resource, @auto_scaling_client, @cloud_watch_client)
+    end
+
+    # @return new RubyAemAws::Component::PublishDispatcher instance
+    def publish_dispatcher
+      RubyAemAws::Component::PublishDispatcher.new(@stack_prefix, @ec2_resource, @auto_scaling_client, @elb_client, @cloud_watch_client)
+    end
+  end
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: ruby_aem_aws
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+platform: ruby
+authors:
+- Shine Solutions
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-03-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: retries
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.5
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.5
+description: ruby_aem_aws is a Ruby client for Shine Solutions Adobe Experience Manager
+  (AEM) Platform on AWS
+email:
+- opensource@shinesolutions.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/ruby_aem_aws.rb
+- lib/ruby_aem_aws/component/abstract_component.rb
+- lib/ruby_aem_aws/component/abstract_grouped_component.rb
+- lib/ruby_aem_aws/component/abstract_single_component.rb
+- lib/ruby_aem_aws/component/author.rb
+- lib/ruby_aem_aws/component/author_dispatcher.rb
+- lib/ruby_aem_aws/component/author_primary.rb
+- lib/ruby_aem_aws/component/author_publish_dispatcher.rb
+- lib/ruby_aem_aws/component/author_standby.rb
+- lib/ruby_aem_aws/component/chaos_monkey.rb
+- lib/ruby_aem_aws/component/component_descriptor.rb
+- lib/ruby_aem_aws/component/mixins/healthy_count_verifier.rb
+- lib/ruby_aem_aws/component/mixins/healthy_state_verifier.rb
+- lib/ruby_aem_aws/component/mixins/instance_describer.rb
+- lib/ruby_aem_aws/component/mixins/metric_verifier.rb
+- lib/ruby_aem_aws/component/orchestrator.rb
+- lib/ruby_aem_aws/component/publish.rb
+- lib/ruby_aem_aws/component/publish_dispatcher.rb
+- lib/ruby_aem_aws/consolidated_stack.rb
+- lib/ruby_aem_aws/constants.rb
+- lib/ruby_aem_aws/error.rb
+- lib/ruby_aem_aws/full_set_stack.rb
+homepage: https://github.com/shinesolutions/ruby_aem_aws
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: AEM API Ruby client
+test_files: []