moonbase_alpha 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 199aa19a27e389795884b46af93cdcb99c0ec72acf1c6b422b9a6e09fc750974
+  data.tar.gz: 9a33751590d6eb5868480545ef1526ae584b38852331eeadbd6a1a8885d43a3f
+SHA512:
+  metadata.gz: 71ad7c41ecf34069aa854f71a42421854237cfc888ab0b37bdf3192e02afd5d8435c7c968295ead9ef5e589c1ef87e9580b829f5438b978d81b4e1d5f1be64f7
+  data.tar.gz: ec59d43e90afeb1eff77a8e9249bc8fea78046b0acc91a7c4f942ff9f5a668a894c4943943f5f19b4e2c33e9c9266013ada4f68dfa165339e37c34218c9e11c1

data/README.md

@@ -0,0 +1,72 @@
+# MoonbaseAlpha
+
+Moonbase Alpha rolls up everything you need to build a Rails app into a docker image ready to deploy on AWS Lambda. It is based heavily on (and uses) [Lamby](http://lamby.custominktech.com), which requires even fewer steps to launch a project, but unlike Lamby, Moonbase Alpha does not use any of AWS' SAM tooling. Moonbase Alpha is ideal for cases where you want more control over orchestration or to integrate with other tools. 
+
+Using Moonbase Alpha, a blank rails app builds into a ~120MB docker image, and the final image is constructed in stages to minimize the build tools that leak into the production environment. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'moonbase_alpha'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install moonbase_alpha
+
+Then use the generator to create the configuration files and `app.rb` entrypoint: 
+
+    $ bin/rails g moonbase
+
+## Usage
+
+You must set at least one value in `moonbase_alpha.yml` prior to building your project, the docker repository, such as: 
+
+    # Repository for the build. A build number will be set as the version
+    repository: 134567895209.dkr.ecr.us-west-2.amazonaws.com/dockertest
+
+You can control which Alpine Linux packages are available at build time (both gems and assets) and at run time. The defaults should be sufficient to build a basic Rails app. 
+
+To build an image, run `bin/rails moonbase_alpha:build`. Moonbase Alpha includes rake tasks that output the last build tag and the full repository name. To push the current image, for example, invoke: 
+
+    $ docker push `bin/rails moonbase_alpha:latest_image`
+    The push refers to repository [134567895209.dkr.ecr.us-west-2.amazonaws.com/dockertest]
+    5d6180898fe9: Pushed
+    9d6fac557487: Pushed
+    4b60b0d829a4: Pushed
+    ae7119e06cea: Pushed
+    84cbece2f061: Pushed
+    745332470db1: Pushed
+    93a2bfafa84f: Pushed
+    54f362ba164c: Pushed
+    c4b1ff92c516: Pushed
+    446d8e2016ac: Pushed
+    50644c29ef5a: Pushed
+    build-2021-01-30-12-22-22: digest: sha256:41c633b81b41d107fdc15740d1e68e3f8cfcfbf4dfb8d54428fe07e748427f42 size: 2618
+
+
+## Development
+
+This is a relatively simple project I put together mostly to accelerate my own workflows. It is missing some functionality and patches are welcome. The following items are outstanding: 
+
+* Setup automated testing
+* Definitively handle asset compilation (more or less stubbed out right now because my use case is as an API project only)
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/loganb/moonbase_alpha. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/loganb/moonbase_alpha/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the MoonbaseAlpha project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/loganb/moonbase_alpha/blob/master/CODE_OF_CONDUCT.md).

data/lib/generators/moonbase/moonbase_generator.rb

@@ -0,0 +1,31 @@
+
+class MoonbaseGenerator < Rails::Generators::Base
+  desc "Install basic moonbase files"
+  def add_configuration
+    create_file "config/moonbase_alpha.yml", <<-EOF
+# This configuration is technically specified on a per-environment basis, but 
+# moonbase doesn't currently use that
+shared: 
+  # Repository for the build. A build number will be set as the version
+  repository: 
+  # These packages will be available only while installing gems and precompiling assets
+  build_packages: 
+    - tzdata
+    - postgresql-dev
+    - sqlite-dev
+  # These pckages will be available only at runtime in the final build image
+  run_packages: 
+    - postgresql-libs
+    - tzdata
+    - sqlite-libs
+  # If true, moonbase will run `rake assets:precompile` (not suitable for API projects)
+  compile_assets: false    
+EOF
+
+    environment do 
+      "config.moonbase_alpha = config_for(:moonbase_alpha)"
+    end
+
+    create_file "app.rb", File.read(File.expand_path(__dir__ + "/../../../templates/app.rb"))
+  end
+end

data/lib/moonbase_alpha.rb

@@ -0,0 +1,8 @@
+require "moonbase_alpha/version"
+
+require 'moonbase_alpha/railtie' if defined? ::Rails::Railtie
+
+module MoonbaseAlpha
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/lib/moonbase_alpha/railtie.rb

@@ -0,0 +1,10 @@
+require 'rails'
+
+class MoonbaseAlpha::Railtie < Rails::Railtie
+  railtie_name :moonbase_alpha
+
+  rake_tasks do
+    path = File.expand_path(__dir__)
+    Dir.glob("#{path}/../tasks/**/*.rake").each { |f| load f }
+  end
+end

data/lib/moonbase_alpha/rake_helper.rb

@@ -0,0 +1,69 @@
+module LambdaLayerCake
+  class RakeHelper
+    include Rake::DSL
+
+    attr_reader :root
+    
+    def initialize(root)
+      @root = root
+    end
+
+    def docker_build_definitions!
+      desc "Build Docker Image"
+      task :build do
+        dockerfile_path = File.expand_path(__dir__ + "/../../templates/Dockerfile")
+
+        raise "Must specify a repository in moonbase_alpha.yml" if repository.blank?
+
+        tag = "#{repository}:#{build_version}"
+
+        cmd = %W{docker build -f #{dockerfile_path} 
+          --build-arg RUNTIME_VERSION=#{RUBY_VERSION} 
+          --build-arg BLDTIME_PKGS=#{config.build_packages.join(" ")}
+          --build-arg COMPILE_ASSETS=#{config.compile_assets.to_s}
+          -t #{tag}
+          #{root}}
+        system(*cmd) or raise 
+      end
+
+      desc "Output the last version built"
+      task :latest_tag do
+        puts latest_tag
+      end
+
+      desc "Output the image name for the latest build"
+      task :latest_image do
+        puts "#{repository}:#{latest_tag}"
+      end
+    end
+
+    def config
+      Rails.configuration.moonbase_alpha
+    end
+
+    def repository
+      config.repository
+    end
+    
+    def build_version
+      @build_version ||= begin
+        t = Time.now
+        "build-#{t.strftime("%Y-%m-%d-%H-%M-%S")}"
+      end
+    end
+
+    def latest_tag
+      @latest_tag ||= begin
+        cmd = %W{ 
+          docker image list
+          --format {{.Tag}}
+          #{repository}
+        }
+
+        IO.popen(cmd) do |versions|
+          versions.readlines.select {|v| v =~ /\Abuild-/ }.sort.last
+        end
+      end
+    end
+  end
+end

data/lib/moonbase_alpha/version.rb

@@ -0,0 +1,3 @@
+module MoonbaseAlpha
+  VERSION = "0.1.0"
+end

data/lib/tasks/moonbase_alpha.rake

@@ -0,0 +1,16 @@
+require 'digest'
+require 'fileutils'
+
+require 'rake/packagetask'
+
+require 'moonbase_alpha/rake_helper'
+
+
+
+namespace :moonbase_alpha do
+
+  LambdaLayerCake::RakeHelper.new(Rails.root).tap do |rh| 
+    rh.docker_build_definitions!
+  end
+  
+end

data/templates/Dockerfile

@@ -0,0 +1,103 @@
+# Define global args
+ARG FUNCTION_DIR="/function"
+ARG RUNTIME_VERSION="2.7.2"
+ARG DISTRO_VERSION="3.12"
+ARG BLDTIME_PKGS=""
+ARG RUNTIME_PKGS=""
+ARG COMPILE_ASSETS
+
+# Stage 1 - bundle base image + runtime
+# Grab a fresh copy of the image and install GCC
+FROM ruby:${RUNTIME_VERSION}-alpine${DISTRO_VERSION} AS base
+# Include global args in this stage of the build
+ARG FUNCTION_DIR
+ARG RUNTIME_VERSION
+
+# Install GCC (Alpine uses musl but we compile and link dependencies with GCC)
+RUN apk add --no-cache \
+    libstdc++
+
+# Create function directory
+RUN mkdir -p ${FUNCTION_DIR}
+WORKDIR ${FUNCTION_DIR}
+
+# Needed for the lambda runtime
+RUN ln -s /tmp tmp
+
+# Configure bundler for deployment mode
+RUN bundle config --local deployment 'true' && \
+    bundle config --local system_bindir ${FUNCTION_DIR}/bin && \
+    bundle config --local path vendor/bundle
+
+RUN bundle config
+
+
+
+# Stage 2 - build function and dependencies
+FROM base AS build-image
+# Install aws-lambda-cpp build dependencies
+RUN apk add --no-cache \
+    build-base \
+    libtool \
+    autoconf \
+    automake \
+    libexecinfo-dev \
+    make \
+    cmake \
+    libcurl
+
+# Include global args in this stage of the build
+ARG FUNCTION_DIR
+ARG RUNTIME_VERSION
+
+ARG BLDTIME_PKGS
+ARG COMPILE_ASSETS
+
+# TODO make this work
+# Blank packages by default just in case there aren't any
+# RUN touch system-packages.txt
+
+# Copy list of system packages to install
+# COPY system-packages.txt ${FUNCTION_DIR}/
+
+# Install system packages
+# RUN xargs apk add < system-packages.txt
+# TODO make this config driven
+RUN apk add ${BLDTIME_PKGS}
+
+# Copy Gemfile spec
+COPY Gemfile Gemfile.lock ${FUNCTION_DIR}/
+COPY vendor ${FUNCTION_DIR}/vendor
+
+# RUN bundle config
+
+# Install the gems for the project
+RUN bundle install --jobs=4 && rm -Rf vendor/bundle/ruby/*/cache vendor/bundle/ruby/*/gems/*/test
+
+
+# Copy over rest of project
+COPY . ${FUNCTION_DIR}/
+
+
+
+# Compile the assets
+RUN if [[ "${COMPILE_ASSETS}" = "true" ]] ; then bin/rails assets:precompile ; fi
+
+# Stage 3 - final runtime image
+# Grab a fresh copy of the base image
+FROM base
+
+# Include global arg in this stage of the build
+ARG FUNCTION_DIR
+ARG RUNTIME_PKGS
+
+# Set working directory to function root directory
+WORKDIR ${FUNCTION_DIR}
+
+RUN apk add ${RUNTIME_PKGS}
+
+# Copy in the built dependencies
+COPY --from=build-image ${FUNCTION_DIR} ${FUNCTION_DIR}
+
+ENTRYPOINT ["/usr/local/bin/bundle", "exec", "bin/aws_lambda_ric"]
+CMD ["app.handler"]

data/templates/app.rb

@@ -0,0 +1,27 @@
+require_relative 'config/boot'
+
+require 'lamby'
+require 'lamby/ssm_parameter_store'
+
+#Loads any configuration given in ParameterStore (typically passwords)
+path = "/config/#{ENV['RAILS_ENV']}/#{ENV['SERVICE_NAME']}/env"
+$envs = Lamby::SsmParameterStore.new path
+$envs.get!
+$envs.to_env
+
+require_relative 'config/application'
+require_relative 'config/environment'
+
+$app = Rack::Builder.new { run Rails.application }.to_app
+
+def handler(event:, context:)
+  
+  if(event["source"] == 'aws.events')
+    Rails.logger.info("Processing a cron event")
+    ActiveRecord::Base.connection.query_cache.clear
+    # Event coming from Cloudwatch Events
+  else
+    # Lamby's standard path
+    Lamby.handler $app, event, context, rack: :api
+  end
+end

data/test/moonbase_alpha_test.rb

@@ -0,0 +1,11 @@
+require "test_helper"
+
+class MoonbaseAlphaTest < Minitest::Test
+  def test_that_it_has_a_version_number
+    refute_nil ::MoonbaseAlpha::VERSION
+  end
+
+  def test_it_does_something_useful
+    assert true
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
+require "moonbase_alpha"
+
+require "minitest/autorun"

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: moonbase_alpha
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Logan Bowers
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-01-30 00:00:00.000000000 Z
+dependencies: []
+description: Builds an AWS Lambda-ready Docker image for a rails app
+email:
+- logan@datacurrent.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/generators/moonbase/moonbase_generator.rb
+- lib/moonbase_alpha.rb
+- lib/moonbase_alpha/railtie.rb
+- lib/moonbase_alpha/rake_helper.rb
+- lib/moonbase_alpha/version.rb
+- lib/tasks/moonbase_alpha.rake
+- templates/Dockerfile
+- templates/app.rb
+- test/moonbase_alpha_test.rb
+- test/test_helper.rb
+homepage: https://github.com/loganb/moonbase_alpha
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/loganb/moonbase_alpha
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: Builds an AWS Lambda-ready Docker image for a rails app
+test_files:
+- test/moonbase_alpha_test.rb
+- test/test_helper.rb