aws-rails-provisioner 0.0.0.rc1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c9de388b6ca4097bd72598adc6fc56011f777731
+  data.tar.gz: 9a63b6307132b657f956eeac9e809b481694bfd4
+SHA512:
+  metadata.gz: 82b592d28b3182f7801f103a148b4b321312b6eb7f2a273fcec03cce23f4aa081a3f518e07904fef48e1266a7812bb3cf52cd4924088eedb0bd87c87eed404b7
+  data.tar.gz: 78b9222a2d4448a89994d1fb47ad52df52603c2f3abfcfe7b1c6737fbd3876004d31ae282f4ebeabee8bf71724092e6b965025305244d795ab40221c086f0b0d

data/bin/aws-rails-provisioner

@@ -0,0 +1,132 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'optparse'
+require 'fileutils'
+
+# load the `aws-rails-provisioner` gem
+$LOAD_PATH.unshift(File.expand_path('../../lib', __FILE__))
+require 'aws-rails-provisioner'
+
+# setup default options
+options = {
+  file_path: 'aws-rails-provisioner.yml'
+}
+options[ARGV[0].to_sym] = {}
+
+OptionParser.new do |opts|
+
+  opts.banner = "Usage: aws-rails-provisioner [command] [options]"
+  opts.separator("")
+  opts.separator("Commands:")
+  opts.separator("    build: generate CDK stacks from aws-rails-provisioner.yml")
+  opts.separator("    deploy: deploy generated CDK stacks")
+  opts.separator("")
+  opts.separator("Options:")
+
+  svc_name_msg = 'Service name. Changes apply to all services '\
+    'configured under :services if not provided'
+  opts.on('-s', '--service SERVICE_NAME', svc_name_msg) do |name|
+    options[:service_name] = name.to_sym
+  end
+
+  opts.on('-p', '--profile AWS_PROFILE_NAME', 'Used the indicated AWS profile') do |profile|
+    options[:profile] = profile
+  end
+
+  file_path_msg = 'File path to `aws-rails-provisioner.yml`, default to `aws-rails-provisioner.yml`'\
+    ' at current directory'
+  opts.on('-f', '--file YAML_FILE_PATH', file_path_msg) do |path|
+    options[:file_path] = path
+  end
+
+  dir_msg = "Directory where generated code lives, defaults to `cdk-sample`"
+  opts.on('-d', '--cdk-directory DIR_PATH', dir_msg) do |dir|
+    options[:cdk_dir] = dir
+  end
+
+  # Build
+  cicd_msg = "Enable CICD stack generation, use with `build`"
+  opts.on('--with-cicd', cicd_msg) do
+    if options[:build].nil?
+      raise Aws::RailsProvisioner::Errors::InvalidCommandOption.new('build', '--with-cicd')
+    end
+    options[:build][:enable_cicd] = true
+  end
+
+  # need to consider scenarios for dryrun
+  #opts.on('--dryrun') do
+    #options[:dryrun] = true
+  #end
+
+  # Deploy
+  init_msg = "Deploy the stack that creates VPC and ECS cluster"
+  opts.on('--init', init_msg) do
+    if options[:deploy].nil?
+      raise Aws::RailsProvisioner::Errors::InvalidCommandOption.new('deploy', '--init')
+    end
+    options[:deploy][:init] = true
+  end
+
+  fargate_msg = "Deploy the stack that creates Fargate service and DBCluster (if specificed)"
+  opts.on('--fargate', fargate_msg) do
+    if options[:deploy].nil?
+      raise Aws::RailsProvisioner::Errors::InvalidCommandOption.new('deploy', '--fargate')
+    end
+    options[:deploy][:fargate] = true
+  end
+
+  cicd_deploy_msg = "Deploy the stack that builds CICD flow"
+  opts.on('--cicd', cicd_deploy_msg) do
+    if options[:deploy].nil?
+      raise Aws::RailsProvisioner::Errors::InvalidCommandOption.new('deploy', '--cicd')
+    end
+    options[:deploy][:cicd] = true
+  end
+
+  opts.on('-h', '--help', 'Show help') do
+    puts opts
+    exit
+  end
+
+end.parse!
+
+config = Aws::RailsProvisioner::Utils.parse(options[:file_path])
+cdk_dir = options[:cdk_dir] || config[:cdk_dir] || 'cdk-sample'
+config[:cdk_dir] = cdk_dir
+
+# prepare codebuilder params
+if options[:build]
+  options[:build][:profile] = options[:profile]
+  options[:build][:file_path] = options[:file_path]
+  if svc_name = options[:service_name]
+    config[:services][svc_name].merge!(options[:build])
+  else
+    config[:services].each do |_, svc|
+      svc.merge!(options[:build])
+    end
+  end
+end
+code_builder = Aws::RailsProvisioner::CDKCodeBuilder.new(config)
+
+if options[:build]
+  Aws::RailsProvisioner::CDKBuilder.new(
+    cdk_dir: cdk_dir,
+    source_files: code_builder.source_files,
+    default_stack: code_builder.default_stack,
+    services: code_builder.services
+  ).run
+elsif options[:deploy]
+  deploy_params = {
+    cdk_dir: cdk_dir,
+    services: code_builder.services,
+    stack_prefix: code_builder.stack_prefix,
+    service_name: options[:service_name]
+  }
+  if options[:profile]
+    deploy_params[:profile] = profile
+  end
+  deploy_params.merge!(options[:deploy])
+  deployer = Aws::RailsProvisioner::CDKDeployer.new(deploy_params)
+  deployer.run
+end

data/lib/aws-rails-provisioner.rb

@@ -0,0 +1,42 @@
+# services
+require 'aws-sdk-rds'
+
+# code gen helpers
+require_relative 'aws-rails-provisioner/cdk_builder'
+require_relative 'aws-rails-provisioner/cdk_deployer'
+require_relative 'aws-rails-provisioner/cdk_code_builder'
+
+# utils
+require_relative 'aws-rails-provisioner/services'
+require_relative 'aws-rails-provisioner/service'
+require_relative 'aws-rails-provisioner/utils'
+require_relative 'aws-rails-provisioner/errors'
+
+# init stack
+require_relative 'aws-rails-provisioner/vpc'
+require_relative 'aws-rails-provisioner/subnet_selection'
+
+# CICD stack
+require_relative 'aws-rails-provisioner/code_build'
+require_relative 'aws-rails-provisioner/build'
+require_relative 'aws-rails-provisioner/migration'
+
+# fargate stack
+require_relative 'aws-rails-provisioner/db_cluster'
+require_relative 'aws-rails-provisioner/fargate'
+require_relative 'aws-rails-provisioner/scaling'
+
+# views
+require_relative 'aws-rails-provisioner/view'
+require_relative 'aws-rails-provisioner/views/init_stack'
+require_relative 'aws-rails-provisioner/views/fargate_stack'
+require_relative 'aws-rails-provisioner/views/pipeline_stack'
+require_relative 'aws-rails-provisioner/views/project'
+
+# version
+require_relative 'aws-rails-provisioner/version'
+
+module Aws
+  module RailsProvisioner
+  end
+end

data/lib/aws-rails-provisioner/build.rb

@@ -0,0 +1,43 @@
+module Aws::RailsProvisioner
+  class Build < Aws::RailsProvisioner::CodeBuild
+
+    # An AWS CodeBuild Project that build, tag and
+    # push image to AWS ECR Repo
+    #
+    # configuration for :build
+    #
+    # @param [Hash] options
+    #
+    # @option options [String] :project_name name for
+    #   the CodeBuild project, default to 'RailsProvisionerImageBuild'
+    #
+    # @option options [String] :description description for this
+    #   CodeBuild project, default to 'build, tag and push image to ECR'
+    #
+    # @option options [String] :buildspec buildspec.yml file path, default
+    #   to `buildspec-ecr.yml` under root directory, using template
+    #   under `buildspecs/`
+    #
+    # @option options [String] :build_image default to codebuild `ubuntu_14_04_docker_18_09_0`
+    #   full list of supported images see:
+    #   https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-codebuild.LinuxBuildImage.html
+    #
+    # @option options [Integer] :timeout number of minutes after which
+    #   CodeBuild stops the build if it’s not complete
+    #
+    def initialize(options = {})
+      unless options[:description]
+        options[:description] = 'build, tag and push image to ECR'
+      end
+      unless options[:buildspec]
+        options[:buildspec] = 'buildspec-ecr.yml'
+      end
+      unless options[:build_image]
+        options[:build_image] = 'ubuntu_14_04_docker_18_09_0'
+      end
+      super(options)
+    end
+
+  end
+end
+

data/lib/aws-rails-provisioner/cdk_builder.rb

@@ -0,0 +1,68 @@
+module Aws::RailsProvisioner
+  class CDKBuilder
+
+    def initialize(options = {})
+      @source_files = options[:source_files]
+      @default_stack = options[:default_stack]
+      @cdk_dir = options[:cdk_dir]
+      @services = options[:services]
+    end
+
+    def run
+      _init_cdk
+      # code to files
+      files = @source_files
+      files.each do |path, code|
+        if File.exists?(path)
+          puts "replacing #{path}"
+        else
+          puts "creating #{path}"
+        end
+        FileUtils.mkdir_p(File.dirname(path))
+        File.open(path, 'w') do |f|
+          f.write(code)
+        end
+      end
+      _install_dependencies
+      _npm_build
+    end
+
+    private
+
+    def _init_cdk
+      unless Dir.exist?(@cdk_dir)
+        FileUtils.mkdir_p(@cdk_dir)
+        unless @dryrun
+          Dir.chdir(@cdk_dir) do
+            `npm i -g aws-cdk`
+            `cdk init app --language=typescript`
+          end
+
+          if File.exists?(@default_stack)
+            FileUtils.rm_f(@default_stack)
+          end
+        end
+      end
+    end
+
+    def _install_dependencies
+      pkgs = @services.inject(Set.new) do |set, svc|
+        set.merge(svc.packages)
+        set
+      end
+      Dir.chdir(@cdk_dir) do
+        pkgs.each do |pkg|
+          `npm install #{pkg}`
+        end
+      end
+    end
+
+    def _npm_build
+      Dir.chdir(@cdk_dir) do
+        puts "running npm run build ..."
+        `npm run build`
+      end
+    end
+
+  end
+end

data/lib/aws-rails-provisioner/cdk_code_builder.rb

@@ -0,0 +1,140 @@
+require 'set'
+
+module Aws::RailsProvisioner
+  class CDKCodeBuilder
+
+    # Generates CDK projects with separate stacks:
+    #
+    #  * InitStack - VPC and Fargate Cluster
+    #  * FargetStack - Fargate Service, AutoScaling, ALB
+    #  * PipelineStack - CICD CodePipline (when enabled) that:
+    #       * Source: CodeCommit Repository when host rails applications
+    #       * Build : CodeBuild Project that takes care of image build, tag(commit id) and push to ECR
+    #       * Migration: CodeBuild Project that run migration inside DB subnet (optional)
+    #       * Deploy: CodeDeploy that deploys tagged(commit id) image from ECR to Fargate service
+    #
+    # @param [Hash] options
+    #
+    # @option options [String] :cdk_dir Directory path for
+    #   generated CDK code, defaults to "cdk-sample"
+    #
+    # @option options [Hash] :vpc VPC configurations 
+    #   @see {Aws::RailsProvisioner::Vpc}
+    #
+    # @option options [Hash] :services
+    #
+    # @option options [Hash] :db_cluster DB cluster configurations
+    #   @see {Aws::RailsProvisioner::DBCluster}
+    #
+    # @option options [required, String] :source_path path to the directory containing
+    #   Rails Application source
+    #
+    # @option options [Hash] :fargate Fargate service configurations
+    #   @example: at `aws-rails-provisioner.yml`
+    #     fargate:
+    #       desired_count: 5
+    #       task:
+    #         environment:
+    #           RAILS_LOG_TO_STDOUT: true
+    #   @see {Aws::RailsProvisioner::Fargate}
+    #
+    # @option options [Hash] :scaling Scaling definitions for the Fargate service
+    #   @example: at `aws-rails-provisioner.yml`
+    #     scaling:
+    #       max_capacity: 7
+    #       on_cpu:
+    #         target_util_percent: 40
+    #       on_request:
+    #         requests_per_target: 20000
+    #   @see {Aws::RailsProvisioner::Scaling}
+    #
+    # @option options [Hash] :loadbalancer Application Loadbalancer that front
+    #   the Fargate service
+    #   @example: at `aws-rails-provisioner.yml`
+    #     loadbalancer:
+    #       internet_facing: true
+    #   @see {Aws::RailsProvisioner::LoadBalancer}
+    #
+    # @option options [Hash] :cicd configurations for CICD that covers:
+    #   source, build, database migration with code pipline
+    #   @see {Aws::RailsProvisioner::Pipeline}
+    #
+    def initialize(options = {})
+      @cdk_dir = options[:cdk_dir] || "cdk-sample"
+      @stack_prefix = _stack_prefix
+
+      # init, vpc & fargate cluster
+      @vpc = options[:vpc] || {}
+
+      # fargate services defs
+      # including related db, alb, scaling, cicd etc.
+      @services = Aws::RailsProvisioner::ServiceEnumerator.new(options[:services] || {})
+
+      # npm cdk service packages need to be installed
+      @packages = Set.new
+    end
+
+    # @return [Enumerable]
+    attr_reader :services
+
+    # @return [Set]
+    attr_reader :packages
+
+    # @return [String]
+    attr_reader :cdk_dir
+
+    # @api private
+    # @return [String]
+    attr_reader :stack_prefix
+
+    def source_files
+      Enumerator.new do |y|
+        y.yield("#{@cdk_dir}/lib/#{@cdk_dir}-init-stack.ts", init_stack)
+        @services.each do |svc|
+          y.yield("#{@cdk_dir}/lib/#{svc.path_prefix}-fargate-stack.ts",
+            svc.fargate_stack)
+          y.yield("#{@cdk_dir}/lib/#{svc.path_prefix}-pipeline-stack.ts",
+            svc.pipeline_stack) if svc.enable_cicd
+          @packages.merge(svc.packages)
+        end
+
+        y.yield("#{@cdk_dir}/bin/#{@cdk_dir}.ts", project)
+      end
+    end
+
+    def default_stack
+      # CDK init cmd default empty stack
+      "#{@cdk_dir}/lib/#{@cdk_dir}-stack.ts"
+    end
+
+    # @api private
+    def project
+      Aws::RailsProvisioner::Views::Project.new(
+        stack_prefix: @stack_prefix,
+        path_prefix: @cdk_dir,
+        services: @services
+      ).render
+    end
+
+    # @api private
+    def init_stack
+      init = Aws::RailsProvisioner::Views::InitStack.new(
+        vpc: @vpc,
+        stack_prefix: @stack_prefix
+      )
+      @packages.merge(init.packages)
+      init.render
+    end
+
+    private
+
+    def _stack_prefix
+      dir = @cdk_dir.dup
+      dir.split('-').map do |part|
+        part[0] = part[0].upcase
+        part
+      end.join
+    end
+
+  end
+end

data/lib/aws-rails-provisioner/cdk_deployer.rb

@@ -0,0 +1,62 @@
+require 'open3'
+
+module Aws::RailsProvisioner
+  class CDKDeployer
+
+    def initialize(options = {})
+      @cdk_dir = options[:cdk_dir]
+      @services = options[:services]
+      @stack_prefix = options[:stack_prefix]
+
+      both = options[:fargate].nil? && options[:cicd].nil?
+      @fargate_stack = both || !!options[:fargate]
+      @pipeline_stack = both || !!options[:cicd]
+
+      @init_stack_only = !!options[:init]
+
+      @svc_name = options[:service_name]
+      @profile = options[:profile]
+    end
+
+    def run
+      Dir.chdir(@cdk_dir) do
+        deploy_init_stack
+        unless @init_stack_only
+          if @svc_name
+            deploy_svc(@services[@svc_name].stack_prefix)
+          else
+            @services.each do |svc|
+              deploy_svc(svc.stack_prefix)
+            end
+          end
+        end
+      end
+    end
+
+    private
+
+    def deploy_init_stack
+      opts = @profile ? " --profile #{@profile}" : ''
+      # disable prompts in deploy command
+      opts += " --require-approval never"
+      cmd = "cdk deploy #{@stack_prefix}InitStack#{opts}"
+      Open3.popen3(cmd) do |_, stdout, stderr, _|
+        puts stdout.read
+        puts stderr.read
+      end
+    end
+
+    def deploy_svc(stack_prefix)
+      opts = @profile ? " --profile #{@profile}" : ''
+      # disable prompts in deploy command
+      opts += " --require-approval never"
+      if @fargate_stack
+        `cdk deploy #{stack_prefix}FargateStack#{opts}`
+      end
+      if @pipeline_stack
+        `cdk deploy #{stack_prefix}PipelineStack#{opts}`
+      end
+    end
+
+  end
+end