convox_installer 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4aa7edf7f211c8c4fabf9f11c189b8634e16f6345771aa84ea3d68a94171474e
+  data.tar.gz: 188957c8d8471ba8d9cb39356cd5ef1f051b4f515a0b7de955a092edfe0b2188
+SHA512:
+  metadata.gz: 1fb7fe4c0522649b7b4850f5270d58c6eb2e7df7e27919e27f4d5b4e51a0869a3406096ae1ebe4e44cfc69047c9b12c64e86a7ad5ef77b82ce0bb5b6bd1dab31
+  data.tar.gz: 136b4634a4be218eb349f07d3dc04ff868d09e1da3fda18b35effd277ec1e256cdd35ddd49628f1436d904796e325f25517e1666e7e64cd9c0e94e74bb175ea6

data/.bundle/config

@@ -0,0 +1,2 @@
+---
+BUNDLE_JOBS: "8"

data/.gitignore

@@ -0,0 +1,5 @@
+mkmf.log
+log
+convox.yml
+.convox
+convox_installer-*.gem

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,41 @@
+require: rubocop-rspec
+TargetRubyVersion: "2.3"
+
+Metrics/LineLength:
+  Max: 100
+
+Style/StringLiterals:
+  EnforcedStyle: single_quotes
+
+Style/Documentation:
+  Enabled: false
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/BlockNesting:
+  Max: 7

data/.vscode/settings.json

@@ -0,0 +1,4 @@
+{
+  "editor.formatOnSave": true,
+  "editor.formatOnSaveTimeout": 5000
+}

data/Gemfile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec
+
+group :test do
+  gem 'pry'
+  gem 'pry-byebug'
+  gem 'rspec'
+  gem 'rubocop'
+  gem 'rubocop-rspec'
+  gem 'vcr'
+  gem 'webmock'
+end

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2019 Form Applications, Inc.
+
+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,23 @@
+# Convox Installer
+
+[Convox](https://convox.com/) is an awesome open source PaaS, which is like Heroku for your own AWS account. [`convox/rack`](https://github.com/convox/rack) is completely open source and free to use, but you can also sign up for a free or paid account to use the hosted service on convox.com.
+
+`convox_installer` is a Ruby gem that makes it much easier to build an installation script for `convox/rack` (the open source PaaS). The Convox CLI is awesome, but it's missing a nice way to script a full deployment. I originally wrote a bash script that made API calls and used [`jq`](https://stedolan.github.io/jq/) and `sed`, but this was very error-prone and it did not have good cross-platform support.
+
+I've rewritten this installation script in Ruby, which provides very good cross-platform support, and also allows me to write tests.
+
+# Usage
+
+You should create a new git repo for your own installation script, and then use the provided classes and methods to build your own installation workflow. You must also include a `convox.yml`.
+
+You can see an example in [`examples/full_installation.rb`](./examples/full_installation.rb).
+(This Ruby file uses `bundler/inline`, so it will download and install the `convox_installer` gem before running the script.)
+
+# Config
+
+Config is loaded from ENV vars, or from saved JSON data at
+`~/.convox/installer_config`.
+
+### License
+
+[MIT](./LICENSE)

data/convox_installer.gemspec

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.push File.expand_path("lib", __dir__)
+require "convox_installer/version"
+
+Gem::Specification.new do |s|
+  s.name = "convox_installer"
+  s.version = ConvoxInstaller::VERSION
+  s.platform = Gem::Platform::RUBY
+  s.authors = ["Form Applications Inc."]
+  s.email = ["support@formapi.io"]
+  s.homepage = "https://github.com/FormAPI/convox_installer"
+  s.summary = "Build a Convox installation workflow"
+  s.description = "Build a Convox installation workflow"
+  s.license = "MIT"
+  s.required_ruby_version = ">= 2.3"
+
+  s.add_runtime_dependency "highline", ">= 1.7.10"
+  s.add_runtime_dependency "json", ">= 2.2.0"
+  s.add_runtime_dependency "os", ">= 1.0.1"
+  s.add_runtime_dependency "httparty", ">= 0.17.0"
+  s.add_runtime_dependency "activesupport", ">= 5.2.3"
+
+  s.files = `git ls-files`.split("\n").uniq.sort.reject(&:empty?) - ["Gemfile.lock"]
+  s.test_files = `git ls-files spec test`.split("\n")
+  s.executables = []
+  s.require_paths = ["lib"]
+end

data/examples/full_installation.rb

@@ -0,0 +1,182 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Use Bundler inline for your real installation script
+# require "bundler/inline"
+
+# gemfile do
+#   source "https://rubygems.org"
+#   gem "convox_installer"
+# end
+
+$LOAD_PATH << File.expand_path("../../lib", __FILE__)
+require "pry-byebug"
+
+require "convox_installer"
+include ConvoxInstaller
+
+@log_level = Logger::DEBUG
+
+MINIMAL_HEALTH_CHECK_PATH = "/health/site"
+COMPLETE_HEALTH_CHECK_PATH = "/health"
+
+S3_BUCKET_CORS_POLICY = <<-JSON
+{
+  "CORSRules": [
+    {
+      "AllowedOrigins": ["*"],
+      "AllowedHeaders": ["Authorization", "cache-control", "x-requested-with"],
+      "AllowedMethods": ["PUT", "POST", "GET"],
+      "MaxAgeSeconds": 3000
+    }
+  ]
+}
+JSON
+
+@prompts = ConvoxInstaller::Config::DEFAULT_PROMPTS + [
+  {
+    section: "ECR Authentication",
+    info: "You should have received authentication details for the Docker Registry\n" \
+    "via email. If not, please contact support@example.com",
+  },
+  {
+    key: :docker_registry_url,
+    title: "Docker Registry URL",
+    value: "691950705664.dkr.ecr.us-east-1.amazonaws.com",
+  },
+  {
+    key: :docker_registry_username,
+    title: "Docker Registry Username",
+  },
+  {
+    key: :docker_registry_password,
+    title: "Docker Registry Password",
+  },
+  {
+    key: :convox_app_name,
+    title: "Convox App Name",
+    value: "convox-app",
+  },
+  {
+    key: :default_service,
+    title: "Default Convox Service (for domain)",
+    value: "web",
+    hidden: true,
+  },
+  {
+    key: :admin_email,
+    title: "Admin User Email",
+    prompt: "Please enter the email address you would like to use " \
+    "for the default admin user",
+    default: "admin@example.com",
+  },
+  {
+    key: :admin_password,
+    title: "Admin User Password",
+    value: -> () { SecureRandom.hex(8) },
+  },
+  {
+    key: :s3_bucket_name,
+    title: "S3 Bucket for Uploads",
+    value: -> () { "app-uploads-#{SecureRandom.hex(4)}" },
+  },
+  {
+    key: :s3_bucket_cors_policy,
+    value: S3_BUCKET_CORS_POLICY,
+    hidden: true,
+  },
+]
+
+ensure_requirements!
+config = prompt_for_config
+
+backup_convox_host_and_rack
+install_convox
+
+validate_convox_auth_and_set_host!
+validate_convox_rack!
+
+create_convox_app!
+set_default_app_for_directory!
+add_docker_registry!
+create_s3_bucket!
+
+puts "=> Generating secret keys for authentication sessions and encryption..."
+secret_key_base = SecureRandom.hex(64)
+data_encryption_key = SecureRandom.hex(32)
+
+puts "======> Default domain: #{default_service_domain_name}"
+puts "        You can use this as a CNAME record after configuring a domain in convox.yml"
+puts "        (Note: SSL will be configured automatically.)"
+
+puts "=> Setting environment variables to configure the application..."
+
+env = {
+  "HEALTH_CHECK_PATH" => MINIMAL_HEALTH_CHECK_PATH,
+  "DOMAIN_NAME" => default_service_domain_name,
+  "AWS_ACCESS_KEY_ID" => config.fetch(:aws_access_key_id),
+  "AWS_ACCESS_KEY_SECRET" => config.fetch(:aws_secret_access_key),
+  "AWS_UPLOADS_S3_BUCKET" => s3_bucket_details.fetch(:name),
+  "AWS_UPLOADS_S3_REGION" => config.fetch(:aws_region),
+  "SECRET_KEY_BASE" => secret_key_base,
+  "DATA_ENCRYPTION_KEY" => data_encryption_key,
+  "ADMIN_NAME" => "Admin",
+  "ADMIN_EMAIL" => config.fetch(:admin_email),
+  "ADMIN_PASSWORD" => config.fetch(:admin_password),
+}
+
+env_command_params = env.map { |k, v| "#{k}=\"#{v}\"" }.join(" ")
+run_convox_command! "env set #{env_command_params}"
+
+puts "=> Initial deploy..."
+puts "-----> Documentation: https://docs.convox.com/deployment/builds"
+run_convox_command! "deploy --wait"
+
+puts "=> Setting up the database..."
+run_convox_command! "run web rake db:create db:migrate db:seed"
+
+puts "=> Updating the health check path to include database tests..."
+run_convox_command! "env set --promote --wait HEALTH_CHECK_PATH=#{COMPLETE_HEALTH_CHECK_PATH}"
+
+puts
+puts "All done!"
+puts
+puts "You can now visit #{default_service_domain_name} and sign in with:"
+puts
+puts "    Email:    #{config.fetch(:admin_email)}"
+puts "    Password: #{config.fetch(:admin_password)}"
+puts
+puts "You can configure a custom domain name, auto-scaling, and other options in convox.yml."
+puts "To deploy your changes, run: convox deploy --wait"
+puts
+puts "IMPORTANT: You should be very careful with the 'resources' section in convox.yml."
+puts "If you remove, rename, or change these resources, then Convox will delete"
+puts "your database. This will result in downtime and a loss of data."
+puts "To prevent this from happening, you can sign into your AWS account,"
+puts "visit the RDS and ElastiCache services, and enable \"Termination Protection\""
+puts "for your database resources."
+puts
+puts "To learn more about the convox CLI, run: convox --help"
+puts
+puts "  * View the Convox documentation:  https://docs.convox.com/"
+puts
+puts
+puts "To completely uninstall Convox from your AWS account,"
+puts "run the following steps (in this order):"
+puts
+puts " 1) Disable \"Termination Protection\" for any resource where it was enabled."
+puts
+puts " 2) Delete all files from the #{config.fetch(:s3_bucket_name)} S3 bucket:"
+puts
+puts "    export AWS_ACCESS_KEY_ID=#{config.fetch(:aws_access_key_id)}"
+puts "    export AWS_SECRET_ACCESS_KEY=#{config.fetch(:aws_secret_access_key)}"
+puts "    aws s3 rm s3://#{s3_bucket_details.fetch(:name)} --recursive"
+puts
+puts " 3) Delete the #{config.fetch(:s3_bucket_name)} S3 bucket:"
+puts
+puts "    convox rack resources delete #{config.fetch(:s3_bucket_name)} --wait"
+puts
+puts " 4) Uninstall Convox (deletes all CloudFormation stacks and AWS resources):"
+puts
+puts "    convox rack uninstall aws #{config.fetch(:stack_name)}"
+puts