drupalcluster 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c8d457e4dcb27114f13fbef2af0d92279d17caf6
+  data.tar.gz: 993e01b7fc9bdfd7b11e083a9dd2a7d177199f03
+SHA512:
+  metadata.gz: 2c378072481dd82c976d31687bd69f47cbb2662327a5db72681928d0460ffd48b3966c0f3fc875b2f56a48bcc0c4afbfdd90efdebcdba636f3da36889c4e3825
+  data.tar.gz: c693336408ca3f4b2c3a66348400b1edc58b3c0cdb394fa58362f4f50d156ef2361b0c8420a89f471a608d83190d2b0da09da3ed490c8e2db5b3cf2e73c8c3ad

data/bin/drupalcluster

@@ -0,0 +1,188 @@
+#!/usr/bin/ruby
+
+##
+#
+# drupalcluster  is a command line tool to quickly
+# deploy a Drupal hosting cluster of a scalable amount [2..5]
+# of virtual webservers.
+#
+# !! AWS identity is required for this script !!
+# Your AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY should be either
+# environment variables, or set in ~/.aws/credentials.
+#
+# The configuration file contains additional details for the cluster,
+# including an ssh KeyName that's needed to access the servers.
+# The KeyName defaults to 'Drupal', easiest if it's precreated.
+#    $HOME/.drc/drupalcluster.conf
+#
+# This is a demo version only, builds Drupal on HTTP connection.
+# Don't use it seriously. 
+# Especially, don't post personal/sensitive data on your Drupal site.
+#
+# ==== Commands
+# 
+#   create <name>     -- Creates a Drupal hosting cluster
+#   check [<name>]    -- Checks the status of creation/deletion 
+#   delete <name>     -- Deletes permanently the given cluster
+#   test <name|url>   -- Sends a simple HTTP GET to the URL (of the given cluster)
+#   attack <instance> -- Permanently terminates the given server instance
+#   list              -- Lists the recently created/deleted clusters.
+#
+
+require 'json'
+require 'inifile'
+
+require 'cli_framework'
+require 'netting'
+require 'aws/drupal_aws'
+require 'etc/stacks_json'
+require 'etc/utilities'
+
+##
+# Public methods of this class are just the CLI commands.
+# Its private methods are separated into modules.
+#
+class Drupal_Clusting
+
+  include Stacks_json
+  include Utilities
+  
+  def initialize
+    read_conf_file
+    read_stacks_json
+  end
+
+  ##
+  # Creates a Drupal cluster. You have to give it a name
+  # as parameter, and then a password for the DB admin.
+  # The process may take 10-15 minutes.
+  # If deployment was successful, the website URL and
+  # database details are displayed.
+  #
+  # ==== Example:
+  #   drupalcluster create MySite
+  #
+  def create stack_name
+    @conf[:create][:stack_name] = stack_name
+    @conf[:create_params]["DBPassword"] ||= get_password
+    # generate key of name KeyName if not yet
+    puts "Creating drupal cluster '#{stack_name}', may take a while.."
+    puts "Ctrl-C will not stop the creation."
+    created = AMA::create_stack @conf
+    if created
+      display_outputs(created)
+      @stacks[stack_name] = created['WebsiteURL']
+      write_stacks_json
+    end
+  end
+
+  ##
+  # Deletes the given cluster after confirmation.
+  #
+  # ==== Example:
+  #   drupalcluster delete MySite
+  #
+  def delete stack_name
+    puts "No way back. All users and contents will be lost."
+    confirm
+    AMA::delete_stack stack_name
+    puts "Deletion initiated. Use following command to see if it is finished:"
+    puts "  #{$PROGRAM_NAME} check #{stack_name}"
+    put_at_the_end stack_name
+  end
+  
+  ##
+  # Tests the given site by a simple HTTP GET /. 
+  # Either the cluster name or the Drupal site's base URL
+  # has to be specified as parameter.
+  #
+  # ==== Examples:
+  #   drupalcluster test                       -- tests the last created/deleted site
+  #   drupalcluster test MySite                -- tests site called 'MySite'
+  #   drupalcluster test http://xy.com/drupal  -- tests given URL
+  #
+  def test stack=nil
+    stack_url = stack
+    if stack !~ /https?:|\.amazonaws\./
+      stack_name = stack or previous
+      stack_url = @stacks[stack_name]
+    end
+    die("An http[s] URL or a previously created stack name is required."
+      ) unless stack_url
+    stack_url = stack_url.sub /\/drupal\/?/, ''
+    puts "Sending request to #{stack_url}"
+    http = Netting.new stack_url
+    res = http.get ''
+    puts "Result code is: #{res.code}"  if res.respond_to? :code
+  end
+  
+  ##
+  # Gives status about creation/deletion of the given cluster.
+  # Possible results are:
+  #    ongoing,  created,  failed,  stack does not exist
+  #
+  # If the cluster is successfully created, 
+  # check also provides its URL and database info
+  #
+  # Examples:
+  #   drupalcluster check           -- checks the last initiated creation/deletion
+  #   drupalcluster check MySite    -- checks processing of site called 'MySite'
+  #
+  def check stack_name=nil
+    stack_name = previous unless stack_name
+    puts "Checking stack #{stack_name}."
+    res = AMA::stack_status stack_name
+    puts res
+    if :created == res
+      outputs = AMA::info stack_name
+      display_outputs( outputs )
+      if @stacks[stack_name] != outputs['WebsiteURL']
+        @stacks[stack_name] = outputs['WebsiteURL']
+        write_stacks_json
+      end
+    end
+  end
+
+  ##
+  # Terminate one of the Drupal servers, referred 
+  # by its instance_id.
+  #
+  # The EC2 instance-id of the currently active server
+  # is displayed e.g. on the top of the PHP page
+  # that has the same URL but without "/drupal" at the end
+  #
+  # ==== Example:
+  #   drupalcluster attack i-0a68ac21dd859867b
+  #
+  def attack instance_id
+    puts "We are about to _terminate_ server instance '#{instance_id}'."
+    confirm
+    AMA::terminate instance_id
+    puts "Terminating instance.."
+  end
+  
+  ##
+  # Lists the previously created stacks and their URL's.
+  # Takes no parameters.
+  #
+  # ==== Example:
+  #   drupalcluster list
+  #
+  def list
+    @stacks.each_pair do |name, url|
+      puts "#{name}: #{url}"
+    end
+  end
+  
+  ##
+  # Describes the given command.
+  #
+  def help cmd=nil
+    puts
+    puts get_comment_above( cmd, __FILE__ )
+  end
+
+end
+
+#
+main(Drupal_Clusting)

data/conf/drupalcluster.conf

@@ -0,0 +1,22 @@
+[aws]
+  # not in use yet
+  region = eu-central-1
+
+[create]
+# template_url = https://s3.eu-central-1.amazonaws.com/drupalcluster/Drupal_in_VPC.yaml
+  template_url = https://s3.eu-central-1.amazonaws.com/drupalcluster/Drupal.yaml
+  disable_rollback = true
+
+[create_params]
+  DBUser = test
+# DBPassword = password
+  MultiAZDatabase = false
+  KeyName = Drupal
+  PuppetMasterIp = 172.31.44.226
+
+  HealthCheckInterval = 8
+  UnhealthyAfter = 4
+
+[drupal]
+  # not in use yet
+  admin_user = admin

data/drupalcluster.gemspec

@@ -0,0 +1,22 @@
+
+Gem::Specification.new do |s|
+
+  s.name        = 'drupalcluster'
+  s.version     = '0.1.1'
+  s.license     = "Nonstandard"
+  s.date        = '2017-11-03'
+  s.summary     = "Create/delete/test a multiserver Drupal site in Amazon cloud."
+  s.description = File.new("readme.md").read
+  s.authors     = ["Bertalan Pecsi"]
+  s.email       = 'zellerede@gmail.com'
+  all_files     = `git ls-files`.split $/
+  s.files       = all_files.select {|fname| fname !~ /html/}
+  s.executables = ["drupalcluster"]
+  s.homepage    = 'https://github.com/zellerede/drupal'
+  s.require_paths = ["bin",
+                     "lib"]
+
+  s.add_runtime_dependency 'aws-sdk', '>= 2.7'
+  s.add_runtime_dependency 'inifile', '>= 2.8'
+
+end

data/lib/aws/drupal_aws.rb

@@ -0,0 +1,114 @@
+##
+# The core functions of cloud manipulation, using aws-sdk
+# Managing a drupal hosting cluster in Amazon's cloud
+#
+# ~/.aws/ identityfiles are assumed
+#
+require 'aws-sdk'
+
+module AMA
+  extend self   # used as a namespace
+
+  ##
+  #
+  def create_stack conf
+    parameters = get_default_network_ids().update conf[:create_params]
+    paramlist = parameters.map {|k,v| {parameter_key: k.to_s, parameter_value: v.to_s}}
+    create_params = conf[:create].update({parameters: paramlist})
+    #puts create_params; return ###
+    cfn = Aws::CloudFormation::Client.new
+    begin
+      cfn.create_stack( create_params )
+      descr = cfn.wait_until(:stack_create_complete,
+                 {stack_name: conf[:create][:stack_name]}, { 
+        delay: 6,
+        max_attempts: 150, # 15 min
+        before_attempt: ->(*x) do 
+          print "."
+        end  
+      })
+      puts
+    rescue Aws::CloudFormation::Errors::ServiceError, \
+           Aws::Waiters::Errors::WaiterFailed, \
+           ArgumentError  => e
+      puts e
+      return
+    end
+    shape_outputs( descr )
+  end
+  
+  def delete_stack stack_name
+    begin
+      cfn = Aws::CloudFormation::Client.new
+      cfn.delete_stack({stack_name: stack_name})
+    rescue Aws::CloudFormation::Errors::ServiceError => e
+      puts e
+    end
+  end   
+
+  def stack_status stack_name
+    begin
+      cfn = Aws::CloudFormation::Client.new
+      events = cfn.describe_stack_events({stack_name: stack_name})
+    rescue Aws::CloudFormation::Errors::ServiceError, ArgumentError => e
+      puts e
+      return
+    end
+    last_event = events.stack_events.first
+    finished = ("AWS::CloudFormation::Stack" == last_event.resource_type)
+    finished &= (stack_name == last_event.logical_resource_id)
+    finished &= !("CREATE_IN_PROGRESS" == last_event.resource_status)
+    success = ("CREATE_COMPLETE" == last_event.resource_status)
+    finished ? 
+      (success ? :created : :failed) :
+      :ongoing
+  end
+
+  def info stack_name
+    begin
+      cfn = Aws::CloudFormation::Client.new
+      descr = cfn.describe_stacks({stack_name: stack_name})
+    rescue Aws::CloudFormation::Errors::ServiceError, ArgumentError => e
+      puts e
+      return
+    end
+    shape_outputs( descr )
+  end    
+  
+  def terminate instance_id
+    begin
+      ec2 = Aws::EC2::Client.new
+      ec2.terminate_instances({ instance_ids: [instance_id] })
+    rescue Aws::EC2::Errors => e
+      puts " *** #{e}"
+    end
+  end
+  
+  #
+  def get_default_network_ids
+    begin
+      ec2 = Aws::EC2::Client.new
+      descr = ec2.describe_vpcs
+      def_vpc = descr.vpcs.select {
+          |x| x.is_default } .first.vpc_id
+      descr = ec2.describe_subnets({ filters: [
+          {name: "vpc-id", values: [def_vpc]}
+      ] })
+    rescue Aws::EC2::Errors => e
+      puts " *** #{e}"
+      return
+    end
+    subnets = descr.subnets.map &:subnet_id
+    { VpcId: def_vpc,
+      SubnetA: subnets[0],
+      SubnetB: subnets[1] }
+  end
+
+  private
+  def shape_outputs( stacks_description )
+    stack = stacks_description.stacks.first
+    stack.outputs.map {|o| {o.output_key => o.output_value}
+      }.reduce {|hash1, hash2| hash1.update hash2} 
+  end
+
+end

data/lib/cli_framework.rb

@@ -0,0 +1,54 @@
+#!/usr/bin/ruby
+#
+
+require 'set'
+
+##
+# Gives the set of all public instance methods of the given class.
+def methods_of cls
+  cls.public_instance_methods.to_set
+end
+
+##
+# This is the main function of the CLI.
+# Its parameter is an arbitrary class, whose public instance methods
+# will be the CLI commands.
+#
+def main executorCls
+  executor = executorCls.new
+  cmds = (methods_of(executorCls) - methods_of(Object)).sort
+  cmds.map! {|x| x.to_s}
+
+  issued = ARGV.shift
+  if not cmds.include? issued
+    puts "No command '#{issued}' is known."
+    die "Please select from: #{cmds.join ', '}"
+  end
+  
+  task = executorCls.public_instance_method(issued) .bind(executor)
+  begin
+    task.call *ARGV
+  rescue ArgumentError => e
+    puts "Try a different parameter set.." # show cmd help
+    puts e
+  rescue Interrupt
+    puts
+  end
+end
+
+##
+# Confirmation on STDIN
+def confirm
+  printf "Are you sure? [Y/n] "
+  answer = STDIN.gets.strip
+  if ("Y" != answer)
+    die "Command ignored."
+  end
+end
+
+##
+# Displays the given +text+, if any, then quits.
+def die text=""
+  puts text
+  exit
+end

data/lib/etc/stacks_json.rb

@@ -0,0 +1,44 @@
+##
+# This module is part of class Drupal_Clusting,
+# handles the  stack_name => stack_url  connection
+# by means of a json file and the hash @stack.
+module Stacks_json
+  @@stacks_file = File.join ENV['HOME'], '.drc', '.drstacks.json'
+
+  private
+  ##
+  # Gives back the last stack_name of the hash/json
+  def previous
+    name, url = @stacks.to_a.last
+    name
+  end
+
+  ##
+  # Reads the json file into @stacks. 
+  # In case of errors, it's quietly set to empty.
+  def read_stacks_json
+    @stacks = JSON.load File.new @@stacks_file
+  rescue SystemCallError # most probably: no such file yet
+    @stacks = {}
+  end
+
+  ##
+  # Writes the hash @stacks into the json file.
+  # In case of errors, argumentless functionality won't work.
+  def write_stacks_json
+    File.open(@@stacks_file, 'w') { |f|
+      JSON.dump(@stacks, f)
+    }
+  rescue SystemCallError
+  end
+
+  ##
+  # Effectively puts the given stack_name at the end 
+  # of both the hash and the .json file.
+  def put_at_the_end stack_name
+    @stacks.delete stack_name
+    @stacks[stack_name] = nil 
+    write_stacks_json
+  end
+
+end

data/lib/etc/utilities.rb

@@ -0,0 +1,67 @@
+require 'io/console'
+require 'fileutils'
+
+##
+# This module contains further utility methods for Drupal_Clusting class
+#
+module Utilities
+
+  private
+  @@conf_default = File.join File.dirname(__FILE__), '..', '..', 'conf', 'drupalcluster.conf'
+  @@conf_file = File.join ENV['HOME'], '.drc', 'drupalcluster.conf'
+  ##
+  # A password will be asked twice on command line, with noecho,
+  # until the repetition coincides the previous one.
+  def get_password for_what="DB"
+    matching = false
+    while not matching do
+      pwd = STDIN.getpass "Type a password for #{for_what}: " 
+      pwd2 = STDIN.getpass "Repeat it: "
+      matching = (pwd == pwd2)
+    end
+    puts
+    pwd.rstrip
+  end
+  
+  ##
+  # Reads the configuration file
+  def read_conf_file
+    if not File.exist? @@conf_file
+      FileUtils::mkdir_p(File.dirname @@conf_file)
+      FileUtils::copy @@conf_default, @@conf_file
+    end
+    begin 
+      @conf = IniFile.load File.new @@conf_file
+    rescue SystemCallError => e
+      puts e
+    end
+  end
+
+  ##
+  # Display the creation outputs (basically any hash)
+  # by  '<key>: <value>'  lines
+  def display_outputs( stack_info )
+    stack_info.each_pair do |key, value|
+      puts "#{key}: #{value}"
+    end
+  end
+
+  ##
+  # Gets either the first comment from the specified source file,
+  # if +cmd+ is not defined. or the comment above the method
+  # named +cmd+. If comment/cmd is not found, returns "No help found".
+  def get_comment_above cmd=nil, file
+    # RDoc's parse is not too user friendly, so..
+    content = File.new(file).read
+    regex_str = '##\s*\n((\s*#(| .*)\n)+)'
+    regex_str += '\s*def\s+'+cmd+'\b'  if cmd
+    regexp = Regexp.new regex_str
+    if content =~ regexp
+      comment_section = $1
+      comment_section.gsub /^\s*#( |$)/, ''
+    else
+      "No help found for #{cmd}."
+    end
+  end
+
+end

data/lib/netting.rb

@@ -0,0 +1,45 @@
+require 'net/http'
+
+##
+#
+# A wrapper around Net::HTTP::Post and Get methods.
+#
+class Netting
+  @@Timeout = 4 #sec
+
+  ##
+  # A full URL has to be given, starting with http[s]:,
+  # ending in the port (if port is not the default)
+  def initialize url
+    @url = url
+  end
+  
+  ##
+  # Sends HTTP POST, data as json
+  def post *stuff
+    send_req Net::HTTP::Post, *stuff
+  end
+  
+  ##
+  # Sends HTTP GET and returns the answer
+  def get *stuff
+    send_req Net::HTTP::Get, *stuff
+  end
+
+  private
+  ##
+  # Sends either a POST or a GET http message.
+  def send_req(req_type, action, data=nil)
+    uri = URI(@url + action)
+    req = req_type.new(uri, 'Content-Type' => 'application/json')
+    req.body = data
+    begin
+      response = Net::HTTP.start(uri.hostname, uri.port, {open_timeout: @@Timeout}) { |http|
+        http.request(req)
+      }
+      response
+    rescue Exception => e
+      puts " *** #{e.message}"
+    end
+  end
+end

data/readme.md

@@ -0,0 +1,24 @@
++drupalcluster+  is a command line tool to quickly
+deploy a Drupal hosting cluster of a scalable amount [2..5]
+of virtual webservers.
+
+!! AWS identity is required for this script !!
+Your AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY should be either
+environment variables, or set in ~/.aws/credentials.
+
+The configuration file contains additional details for the cluster
+   /etc/drupalcluster/drupalcluster.conf
+
+This is a demo version only, builds Drupal on HTTP connection.
+Don't use it seriously. 
+Especially, don't post personal/sensitive data on your Drupal site.
+
+==== Commands
+
+  create <name>     -- Creates a Drupal hosting cluster
+  check [<name>]    -- Checks the status of creation/deletion 
+  delete <name>     -- Deletes permanently the given cluster
+  test <name|url>   -- Sends a simple HTTP GET to the URL (of the given cluster)
+  attack <instance> -- Permanently terminates the given server instance
+  list              -- Lists the recently created/deleted clusters.
+

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: drupalcluster
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Bertalan Pecsi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-11-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: inifile
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.8'
+description: "+drupalcluster+  is a command line tool to quickly\ndeploy a Drupal
+  hosting cluster of a scalable amount [2..5]\nof virtual webservers.\n\n!! AWS identity
+  is required for this script !!\nYour AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY should
+  be either\nenvironment variables, or set in ~/.aws/credentials.\n\nThe configuration
+  file contains additional details for the cluster\n   /etc/drupalcluster/drupalcluster.conf\n\nThis
+  is a demo version only, builds Drupal on HTTP connection.\nDon't use it seriously.
+  \nEspecially, don't post personal/sensitive data on your Drupal site.\n\n==== Commands\n\n
+  \ create <name>     -- Creates a Drupal hosting cluster\n  check [<name>]    --
+  Checks the status of creation/deletion \n  delete <name>     -- Deletes permanently
+  the given cluster\n  test <name|url>   -- Sends a simple HTTP GET to the URL (of
+  the given cluster)\n  attack <instance> -- Permanently terminates the given server
+  instance\n  list              -- Lists the recently created/deleted clusters.\n\n"
+email: zellerede@gmail.com
+executables:
+- drupalcluster
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/drupalcluster
+- conf/drupalcluster.conf
+- drupalcluster.gemspec
+- lib/aws/drupal_aws.rb
+- lib/cli_framework.rb
+- lib/etc/stacks_json.rb
+- lib/etc/utilities.rb
+- lib/netting.rb
+- readme.md
+homepage: https://github.com/zellerede/drupal
+licenses:
+- Nonstandard
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- bin
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Create/delete/test a multiserver Drupal site in Amazon cloud.
+test_files: []