cfn_manage 0.8.2 → 0.8.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2dd0b050dc1153431acfe35eac706b4652a6272aaedc58645c9787469ec6f48c
-  data.tar.gz: '0359145ed126dbea9d356d00a0f19c9a924f2cced0e7958b83aed71bac737c60'
+  metadata.gz: 43ecbbdac266b5a5b658468b6419e8851058db5dc16e1ed8a147e607237c1157
+  data.tar.gz: 2ad869e839f2da3af86bf7af2bb848bf82ba553f43f24ad90c78f30b0c7808aa
 SHA512:
-  metadata.gz: 0ec5af1767e16c77a87c40060193524e931e00c044a94146d40329a057678cbd5b786f081bf3b2f53d7d9f79975ae4612ee81b726bf5e64f83a7ac8a46ad4101
-  data.tar.gz: 331c32d26cb56880bba951f31db76ea88dfb0aad67dbb233988b72eeb1537980cd2471ce010e319db3c9e0c3423da166cd95f9151878fe971e30b0579bfae97a
+  metadata.gz: aa465fca8812fce4f2d5c464fdb5492c0a44a51c5bde5812584093c6fd7f4abebb4186f6e0f02f16997d070ae597cbd9f6335b26621377d79fa034c3873ff57e
+  data.tar.gz: f8ad3a5549a5b3423fcfa0f49539418d0bf59271508efd74566711ea94b63557c50c8f40989ac16fbb173f3ea9e318b1d575b507ea9912f59dea347fa97409c1

data/.gitignore

@@ -0,0 +1,8 @@
+# Created by .ignore support plugin (hsz.mobi)
+Gemfile.lock
+*.gem
+release.sh
+
+.DS_Store
+
+coverage/

data/.rspec

@@ -0,0 +1,2 @@
+--require spec_helper
+--colour

data/.travis.yml

@@ -0,0 +1,20 @@
+sudo: required
+dist: trusty
+language: ruby
+rvm:
+  - 2.5
+before_install:
+  - gem install -v 2.0.2 bundler --no-document
+  - bundle _2.0.2_ install
+script:
+  - bundle exec rake spec
+  - gem build cfn_manage.gemspec
+  - gem install cfn_manage-*.gem
+  - cfn_manage --version
+deploy:
+  provider: rubygems
+  api_key: "${RUBYGEMS_API_KEY}"
+  gem: cfn_manage
+  on:
+   all_branches: true
+   condition: $TRAVIS_BRANCH =~ ^develop|master &&  $TRAVIS_EVENT_TYPE =~ ^push|api$ && $TRAVIS_REPO_SLUG == "base2Services/cfn-start-stop-stack"

data/Dockerfile

@@ -0,0 +1,7 @@
+FROM ruby:2.5
+
+ARG CFN_MANAGE_VERSION=0.5.0
+
+RUN gem install cfn_manage -v ${CFN_MANAGE_VERSION}
+
+CMD ["cfn_manage","help"]

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :test do
+  gem 'rake'
+  gem 'rspec'
+  gem 'simplecov'
+end

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 base2Services
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,311 @@
+# cfn-library
+
+[![Build Status](https://travis-ci.org/base2Services/cfn-start-stop-stack.svg?branch=develop)](https://travis-ci.org/base2Services/cfn-start-stop-stack)
+
+## About
+
+Base2Services Common Cloud Formation stacks functionality
+
+## Installation
+
+- As a gem `gem install cfn_manage`
+
+- As a docker container `docker pull base2/cfn-manage`
+
+- Download source code `git clone https://github.com/base2Services/cfn-start-stop-stack`
+
+## Run As Docker Container
+
+Running cfn_manage inside a docker container means you don't have to worry about
+managing the runtime environment.
+
+```bash
+docker run -ti --rm -v $HOME/.aws/credentials:/root/.aws/credentials base2/cfn-manage
+```
+
+You can also pass in additional [Environment Variables](## Environment Variables) using the `-e` flag in the run command
+
+```bash
+docker run -ti --rm -v $HOME/.aws/credentials:/root/.aws/credentials -e AWS_REGION=us-east-1 base2/cfn-manage
+```
+
+## Functionality
+
+### Stack traversal
+
+Used to traverse through stack and all it's substacks
+
+### Start-stop environment functionality
+
+Stop environment will
+
+- Set all ASG's size to 0
+- Stops RDS instances
+- If RDS instance is Multi-AZ, it is converted to single-az prior it
+  is being stopped
+- Disable CloudWatch Alarm actions
+
+Start environment operation will
+
+- Set all ASG's size to what was prior stop operation
+- Starts ASG instances
+- If ASG instance was Mutli-AZ, it is converted back to Multi-AZ
+- Enable CloudWatch Alarm actions
+Metadata about environment, such as number of desired/max/min instances within ASG and MultiAZ property
+for rds instances, is stored in S3 bucket specified via `--source-bucket` switch or `SOURCE_BUCKET` environment
+variable.
+
+Both start and stop environment operations are idempotent, so if you run `stop-environment`
+two times in a row, initial configuration of ASG will persist in S3 bucket (rather than storing 0/0/0) as ASG configuration.
+Same applies for `start` operation - running it against already running environment won't perform any operations.
+
+In case of some configuration data being lost, script will continue and work with existing data (e.g data about asgs
+removed from S3, but rds data persists will results in RDS instances being started)
+
+Order of operations is supported at this point as hardcoded weights per resource type. Pull Requests are welcome
+for supporting dynamic discovery of order of execution - local configuration file override is one of
+the possible sources.
+
+
+## Start - stop cloudformation stack
+
+### Supported resources
+
+#### AWS::AutoScaling::AutoScalingGroup
+
+**Stop** operation will set desired capacity of ASG to 0
+
+**Start** operation will restore previous capacity
+
+#### AWS::EC2::Instance
+
+**Stop** operation will stop instance [using StopInstances api call](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_StopInstances.html)
+
+**Start** operation will start instance [using StartInstances api call](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_StartInstances.html)
+
+
+#### AWS::RDS::DBInstance
+
+**Stop** operation will stop rds instance. Aurora is not supported yet on AWS side. Note that RDS instance can be stopped
+for two weeks at maximum. If instance is Multi-AZ, it will get converted to Single-AZ instance, before being stopped
+(Amazon does not support stopping Multi-AZ rds instances)
+
+
+**Start** operation will start rds instance. If instance was running in Multi-AZ mode before being stopped,
+it will get converted to Multi-AZ prior being started
+
+#### AWS::DocDB::DBCluster
+
+**Stop** Cluster will be stopped, note that a cluster can only be stopped for a maximum of 7 days, after this time it will turn back on.
+
+
+**Start** Cluster will be started
+
+#### AWS::CloudWatch::Alarm
+
+**Stop** operation will disable all of alarm's actions
+
+**Start** operation will enable all of alarm's actions
+
+#### AWS::EC2::SpotFleet
+
+**Stop** operation will set spot fleet target to capacity to 0
+
+**Start** operation will restore spot fleet target to capacity to what was set prior the stack being stopped.
+
+#### AWS::ECS::Cluster
+
+**Stop** operation will query all services running in the cluster and set desired capacity to 0
+
+**Start** operation will query all services assocated with the cluster restore desired capacity to what was set prior the stack being stopped.
+
+## CLI usage
+
+You'll find usage of `cfn_manage` within [usage.txt](bin/usage.txt) file
+
+```
+Usage: cfn_manage [command] [options]
+
+Commands:
+
+cfn_manage help
+
+cfn_manage version
+
+cfn_manage stop-environment --stack-name [STACK_NAME]
+
+cfn_manage start-environment --stack-name [STACK_NAME]
+
+cfn_manage stop-asg --asg-name [ASG]
+
+cfn_manage start-asg --asg-name [ASG]
+
+cfn_manage stop-rds --rds-instance-id [RDS_INSTANCE_ID]
+
+cfn_manage start-rds --rds-instance-id [RDS_INSTANCE_ID]
+
+cfn_manage stop-aurora-cluster --aurora-cluster-id [AURORA_CLUSTER_ID]
+
+cfn_manage start-aurora-cluster --aurora-cluster-id [AURORA_CLUSTER_ID]
+
+cfn_manage stop-docdb-cluster --docdb-cluster-id [DOCDB_CLUSTER_ID]
+
+cfn_manage start-docdb-cluster --docdb-cluster-id [DOCDB_CLUSTER_ID]
+
+cfn_manage stop-ec2 --ec2-instance-id [EC2_INSTANCE_ID]
+
+cfn_manage start-ec2 --ec2-instance-id [EC2_INSTANCE_ID]
+
+cfn_manage stop-spot-fleet --spot-fleet [SPOT_FLEET]
+
+cfn_manage start-spot-fleet --spot-fleet [SPOT_FLEET]
+
+cfn_manage stop-ecs-cluster --ecs-cluster [ECS_CLUSTER]
+
+cfn_manage start-ecs-cluster --ecs-cluster [ECS_CLUSTER]
+
+cfn_manage disable-alarm --alarm [ALARM]
+
+cfn_manage enable-alarm --alarm [ALARM]
+
+General options:
+
+--source-bucket [BUCKET]
+
+    Pucket used to store / pull information from
+
+--aws-role [ROLE_ARN]
+
+    AWS Role to assume when performing operations. Any reads and
+    write to source bucket will be performed outside of this role
+
+
+-r [AWS_REGION], --region [AWS_REGION]
+
+    AWS Region to use when making API calls
+
+-p [AWS_PROFILE], --profile [AWS_PROFILE]
+
+    AWS Shared profile to use when making API calls
+
+--dry-run
+
+    Applicable only to [start|stop-environment] commands. If dry run is enabled
+    info about assets being started / stopped will ne only printed to standard output,
+    without any action taken.
+    
+--debug
+
+    Displays debug logs
+
+--continue-on-error
+
+    Applicable only to [start|stop-environment] commands. If there is problem with stopping a resource,
+    (e.g. cloudformation stack not being synced or manual resource deletion) script will continue it's
+    operation. By default script stops when there is problem with starting/stopping resource, and expects
+    manual intervention to fix the root cause for failure.
+
+--skip-wait
+
+    Skips waiting for resources to achieve stopped or started states.
+
+--wait-async
+
+  Default wait action is to wait for each individual resource to be stopped and started before continuing.
+  This will enabled waiting for resources in groups based on priority. Option only useful when used with
+  start-environment and stop-environment commands.
+
+--ignore-missing-ecs-config
+
+    This option is required for starting a ecs service that was stopped outside of cfn_manage.
+
+--asg-suspend-termination
+
+    Will stop instances in the autoscaling group(s) instead of the default behaviour of termination.
+    
+--asg-wait-state
+    
+    Allowed values ['HealthyInASG','Running','HealthyInTargetGroup']
+    Default: 'HealthyInASG'
+    
+    'HealthyInASG' - waits for all instances to reach a healthy state in the asg
+    'Running' - waits for all instances to reach the EC2 running state
+    'HealthyInTargetGroup' - waits for all instances to reach a healthy state in all asg assocated target groups
+
+--ecs-wait-state
+    
+    Allowed values ['Running','HealthyInTargetGroup']
+    Default: 'Skip'
+    
+    'Running' - waits for all ecs services in cluster to reach the running state
+    'HealthyInTargetGroup' - waits for all ecs services in cluster to reach a healthy state in all assocated target groups
+            
+--tags
+
+    will query resource tags for individual resource settings.
+        `cfn_manage:priority` for prefered starting order
+    will default to defined resource order if no tag is found or resource doesn't support tags
+    
+--ecs-wait-container-instances
+    
+    waits for a container instance to be active in the ecs cluster before starting services
+```
+
+## Environment Variables
+
+Also, there are some environment variables that control behaviour of the application.
+There are command line switch counter parts for all of the
+
+`AWS_ASSUME_ROLE` as env var or `--aws-role` as CLI switch
+
+`AWS_REGION` as env car or `-r`, `--region` as CLI switch
+
+`AWS_PROFILE` as env var or `-p`, `--profile` as CLI switch
+
+`SOURCE_BUCKET` as env var or `--source-bucket` as CLI switch
+
+`DRY_RUN` as env var (set to '1' to enable) or `--dry-run` as CLI switch
+
+`IGNORE_MISSING_ECS_CONFIG` as env var (set to '1' to enable) or `--ignore-missing-ecs-config` as CLI switch
+
+`CFN_CONTINUE_ON_ERROR` as env var (set to '1' to enable) or `--continue-on-error` as CLI switch
+
+`SKIP_WAIT` as env var (set to '1' to enable) or `--skip-wait` as CLI switch
+
+`WAIT_ASYNC` as env var (set to '1' to enable) or `--wait-async` as CLI switch
+
+`ASG_SUSPEND_TERMINATION` as env var (set to '1' to enable) or `--asg-suspend-termination` as CLI switch
+
+`CFN_TAGS` as env var (set to '1' to enable) or `--tags` as CLI switch
+
+`ECS_WAIT_CONTAINER_INSTANCES` as env var (set to '1' to enable) or `--ecs-wait-container-instances` as CLI switch
+
+`CFN_DEBUG` as env var (set to '1' to enable) or `--debug` as CLI switch
+
+## AWS Resource Tags
+
+will query resource tags for individual resource settings. please see bellow the list of resources currently supported by tags and their options.
+
+#### AWS::AutoScaling::AutoScalingGroup'
+
+```yaml
+cfn_manage:wait_state: 'HealthyInASG'
+cfn_manage:skip_wait: true
+cfn_manage:suspend_termination: true
+```
+
+#### AWS::ECS::Cluster
+
+```yaml
+cfn_manage:wait_state: 'Running'
+cfn_manage:skip_wait: true
+cfn_manage:wait_container_instances: true
+cfn_manage:ignore_missing_ecs_config: true
+```
+
+## Release process
+
+ - Bump up version `gem install bump && bump [patch|minor|major]`
+ - Update timestamp in `cfn_manage.gemspec`
+ - Create and publish gem `gem build cfn_manage.gemspec && gem push cfn_manage-$VERSION.gem`
+ - Create release page on GitHub

data/Rakefile

@@ -0,0 +1,9 @@
+require "rake"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern = Dir.glob("spec/**/*_spec.rb")
+  t.rspec_opts = "--format documentation"
+end
+
+task default: :spec

data/cfn_manage.gemspec

@@ -0,0 +1,58 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cfn_manage/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'cfn_manage'
+  spec.version       = CfnManage::VERSION
+  spec.summary       = 'Manage AWS Cloud Formation stacks'
+  spec.description   = 'Start and stop aws resources in a cloudformation stack'
+  spec.authors       = ['Base2Services', 'Nikola Tosic', 'Angus Vine']
+  spec.homepage      = 'https://github.com/base2Services/cfn-start-stop-stack/blob/master/README.md'
+  spec.email         = 'itsupport@base2services.com'
+  spec.license       = "MIT"
+  
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = 'https://rubygems.org'
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/base2services/aws-client-vpn"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  
+  spec.required_ruby_version = '~> 2.5'
+
+  spec.add_runtime_dependency 'aws-sdk-core', '>=3.39.0','<4'
+  spec.add_runtime_dependency 'aws-sdk-s3', '~> 1', '<2'
+  spec.add_runtime_dependency 'aws-sdk-ec2', '~> 1', '<2'
+  spec.add_runtime_dependency 'aws-sdk-cloudformation', '~> 1', '<2'
+  spec.add_runtime_dependency 'aws-sdk-rds', '>=1.31.0', '<2'
+  spec.add_runtime_dependency 'aws-sdk-cloudwatch', '~> 1', '<2'
+  spec.add_runtime_dependency 'aws-sdk-iam', '~> 1', '<2'
+  spec.add_runtime_dependency 'aws-sdk-autoscaling', '~> 1', '<2'
+  spec.add_runtime_dependency 'aws-sdk-ecs', '~> 1', '<2'
+  spec.add_runtime_dependency 'aws-sdk-docdb', '>=1.9.0', '<2'
+  spec.add_runtime_dependency 'aws-sdk-transfer', '~>1', '<2'
+  spec.add_runtime_dependency 'aws-sdk-elasticloadbalancingv2', '~>1', '<2'
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 0.9"
+  spec.add_development_dependency "rspec-core", "~> 3.8"
+  spec.add_development_dependency "rspec-expectations", "~> 3.8"
+  spec.add_development_dependency "rspec-mocks", "~> 3.8"
+  spec.add_development_dependency 'simplecov', '~> 0.16'
+end

data/lib/cfn_manage/handlers/rds.rb

@@ -81,12 +81,20 @@ module CfnManage
 
         # stop rds instance and wait for it to be fully stopped
         $log.info("Stopping instance #{@instance_id}")
-        @rds_client.stop_db_instance({ db_instance_identifier: @instance_id })
+        begin
+          @rds_client.stop_db_instance({ db_instance_identifier: @instance_id })
+        rescue Aws::RDS::Errors::InvalidDBInstanceState => e
+          if e.message == "Cannot stop or start a Read-Replica instance"
+            $log.warn("Skipping due to error: #{e.message}") 
+            return
+          else
+            raise e
+          end
+        end
         unless CfnManage.skip_wait?
           $log.info("Waiting db instance to be stopped #{@instance_id}")
           wait('stopped')
         end
-
         return configuration
       end
 

data/lib/cfn_manage/version.rb

@@ -1,3 +1,3 @@
 module CfnManage
-  VERSION="0.8.2".freeze
+  VERSION="0.8.3".freeze
 end

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: cfn_manage
 version: !ruby/object:Gem::Version
-  version: 0.8.2
+  version: 0.8.3
 platform: ruby
 authors:
 - Base2Services
 - Nikola Tosic
 - Angus Vine
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2019-11-01 00:00:00.000000000 Z
+date: 2020-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core
@@ -272,14 +272,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -350,15 +350,25 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.16'
-description: ''
+description: Start and stop aws resources in a cloudformation stack
 email: itsupport@base2services.com
 executables:
 - cfn_manage
+- usage.txt
 extensions: []
 extra_rdoc_files: []
 files:
-- bin/cfn_manage
-- bin/usage.txt
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Dockerfile
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- cfn_manage.gemspec
+- exe/cfn_manage
+- exe/usage.txt
 - lib/cfn_manage.rb
 - lib/cfn_manage/aws_credentials.rb
 - lib/cfn_manage/cf_common.rb
@@ -380,7 +390,10 @@ files:
 homepage: https://github.com/base2Services/cfn-start-stop-stack/blob/master/README.md
 licenses:
 - MIT
-metadata: {}
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/base2Services/cfn-start-stop-stack/blob/master/README.md
+  source_code_uri: https://github.com/base2services/aws-client-vpn
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -396,7 +409,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.1.3
 signing_key: 
 specification_version: 4
 summary: Manage AWS Cloud Formation stacks