fly-rails 0.3.5

data/lib/generators/fly/terraform_generator.rb

@@ -0,0 +1,36 @@
+require 'fly-rails/actions'
+
+module Fly::Generators
+class TerraformGenerator < Rails::Generators::Base
+  include FlyIoRails::Utils
+
+  class_option :name, type: :string, required: false
+  class_option :org, type: :string, default: 'personal'
+  class_option :region, type: :array, repeatable: true, default: []
+
+  class_option :litefs, type: :boolean, default: false
+  class_option :passenger, type: :boolean, default: false
+  class_option :serverless, type: :boolean, default: false
+
+  def terraform
+    source_paths.push File.expand_path('../templates', __dir__)
+
+    create_app(**options.symbolize_keys)
+
+    action = Fly::Actions.new(@app, options)
+    
+    action.generate_toml
+    action.generate_dockerfile
+    action.generate_dockerignore
+    action.generate_nginx_conf
+    action.generate_terraform
+    action.generate_raketask
+    action.generate_procfile
+    action.generate_patches
+
+    action.generate_key
+
+    tee 'terraform init'
+  end
+end
+end

data/lib/generators/templates/Dockerfile.erb

@@ -0,0 +1,270 @@
+# syntax = docker/dockerfile:1
+
+FROM <%= @image %> as base
+LABEL fly_launch_runtime="rails"
+
+ENV RAILS_ENV=production
+<% if @anycable or not @passenger -%>
+ENV RAILS_LOG_TO_STDOUT true
+<% end -%>
+<% unless @passenger -%>
+ENV RAILS_SERVE_STATIC_FILES true
+<% end -%>
+ENV PORT 8080
+
+RUN mkdir /app
+WORKDIR /app
+
+<% if @node -%>
+RUN curl https://get.volta.sh | bash
+ENV VOLTA_HOME /root/.volta
+ENV PATH $VOLTA_HOME/bin:/usr/local/bin:$PATH
+RUN volta install node@<%= @node_version %> yarn@<%= @yarn_version %> && \
+    gem update --system --no-document && \
+    gem install --no-document bundler --version <%= @bundler_version %>
+
+<% else -%>
+RUN gem update --system --no-document && \
+    gem install --no-document bundler --version <%= @bundler_version %>
+
+<% end -%>
+#######################################################################
+
+# install packages only needed at build time
+
+FROM base as build_deps
+
+<% 
+  @build_packages = %w(git build-essential wget curl gzip xz-utils)
+  @build_packages << 'libpq-dev' if @postgresql
+  @build_packages << 'libsqlite3-dev' if @sqlite3
+  @build_packages << 'default-libmysqlclient-dev' if @mysql
+  @build_packages += %w[pkg-config libmagickwand-dev] if @rmagick
+-%>
+RUN --mount=type=cache,id=dev-apt-cache,sharing=locked,target=/var/cache/apt \
+    --mount=type=cache,id=dev-apt-lib,sharing=locked,target=/var/lib/apt \
+    apt-get update -qq && \
+    apt-get install --no-install-recommends --yes \
+    <%= @build_packages.join(' ') %>
+
+#######################################################################
+
+# install gems
+
+FROM build_deps as gems
+
+COPY Gemfile* ./
+RUN --mount=type=cache,id=dev-gem-cache,sharing=locked,target=/srv/vendor \
+    bundle config set app_config .bundle && \
+    bundle config set without 'development test' && \
+    bundle lock --add-platform x86_64-linux && \
+    bundle config set path /srv/vendor && \
+    bundle install && \
+    mkdir -p vendor && \
+    bundle config set path vendor && \
+    cp -ar /srv/vendor .
+
+<% if @node -%>
+#######################################################################
+
+# install node modules
+
+FROM build_deps as node_modules
+
+<% if @puppeteer -%>
+ENV PUPPETEER_SKIP_CHROMIUM_DOWNLOAD true
+
+<% end -%>
+COPY package*json ./
+<% if @yarn -%>
+COPY yarn.* ./
+RUN yarn install
+<% else -%>
+RUN npm install
+<% end -%>
+
+<% end -%>
+#######################################################################
+<% if @litefs -%>
+
+# Fetch the LiteFS binary
+FROM flyio/litefs:pr-109 AS litefs
+
+#######################################################################
+<% end -%>
+<% if @anycable -%>
+
+# Build anycable
+FROM golang:1.18 as go
+RUN GOBIN=/usr/local/bin/ go install github.com/anycable/anycable-go/cmd/anycable-go@latest
+
+#######################################################################
+<% end -%>
+
+# install deployment packages
+
+FROM base
+
+<% if @passenger -%>
+# add passenger repository
+RUN apt-get install -y dirmngr gnupg apt-transport-https ca-certificates curl && \
+  curl https://oss-binaries.phusionpassenger.com/auto-software-signing-gpg-key.txt | \
+    gpg --dearmor > /etc/apt/trusted.gpg.d/phusion.gpg && \
+  sh -c 'echo deb https://oss-binaries.phusionpassenger.com/apt/passenger $(sed -n 's/VERSION_CODENAME=\(.*\)$/\1/p' /etc/os-release) main > /etc/apt/sources.list.d/passenger.list'
+
+<% end -%>
+<% if @puppeteer -%>
+# add google chrome repository
+RUN wget -q -O - https://dl-ssl.google.com/linux/linux_signing_key.pub | apt-key add - \
+ && echo "deb http://dl.google.com/linux/chrome/deb/ stable main" >> /etc/apt/sources.list.d/google-chrome.list
+
+<% end -%>
+<% if @postgresql -%>
+# add postgres repository
+RUN curl -sSL https://www.postgresql.org/media/keys/ACCC4CF8.asc | apt-key add - \
+  && echo "deb http://apt.postgresql.org/pub/repos/apt/ $(sed -n 's/VERSION_CODENAME=\(.*\)$/\1/p' /etc/os-release)-pgdg main" 14 > /etc/apt/sources.list.d/pgdg.list
+<% end -%>
+# nginx: <%= @nginx.inspect %>
+<%
+  @deploy_packages = []
+  @deploy_packages << 'nginx' if @nginx
+  @deploy_packages += %w(passenger libnginx-mod-http-passenger) if @passenger
+  @deploy_packages << 'postgresql-client-14' if @postgresql
+  @deploy_packages << 'libsqlite3-0' if @sqlite3
+  @deploy_packages << 'default-mysql-client' if @mysql
+  @deploy_packages << 'google-chrome-stable' if @puppeteer
+  @deploy_packages << 'imagemagick' if @rmagick
+  @deploy_packages << 'libvips42' if @image_processing
+  @deploy_packages << 'nodejs' if not @node and @bootstrap
+  @deploy_packages << 'fuse' if @litefs
+  @deploy_packages << 'ruby-foreman' if @procs.length > 1
+  @deploy_packages << 'redis-server' if @redis == :internal
+  @deploy_packages << 'gettext-base' if @nats
+  @deploy_packages += %w(avahi-daemon avahi-utils libnss-mdns) if @avahi
+-%>
+RUN --mount=type=cache,id=prod-apt-cache,sharing=locked,target=/var/cache/apt \
+    --mount=type=cache,id=prod-apt-lib,sharing=locked,target=/var/lib/apt \
+    apt-get update -qq && \
+    apt-get install --no-install-recommends --yes \
+    <%= @deploy_packages.join(' ') %>
+
+<% if @redis == :internal -%>
+# configure redis
+RUN sed -i 's/^daemonize yes/daemonize no/' /etc/redis/redis.conf &&\
+  sed -i 's/^bind/# bind/' /etc/redis/redis.conf &&\
+  sed -i 's/^protected-mode yes/protected-mode no/' /etc/redis/redis.conf &&\
+  sed -i 's/^logfile/# logfile/' /etc/redis/redis.conf 
+
+<% end -%>
+# copy installed gems
+COPY --from=gems /app /app
+COPY --from=gems /usr/lib/fullstaq-ruby/versions /usr/lib/fullstaq-ruby/versions
+COPY --from=gems /usr/local/bundle /usr/local/bundle
+
+<% if @node -%>
+# copy installed node modules
+COPY --from=node_modules /app/node_modules /app/node_modules
+
+<% end -%>
+<% if @anycable -%>
+# copy anycable-go
+COPY --from=go /usr/local/bin/anycable-go /usr/local/bin/anycable-go
+
+<% end -%>
+<% if @litefs -%>
+# copy litefs binary
+COPY --from=litefs /usr/local/bin/litefs /usr/local/bin/litefs
+
+# Copy our LiteFS configuration.
+ADD config/litefs.yml /etc/litefs.yml
+
+# Create mount point
+RUN mkdir /data
+
+<% end -%>
+<% if @nats -%>
+# install nats
+RUN mkdir /etc/nats
+COPY --from=nats:latest /nats-server /usr/local/bin/nats-server
+COPY --from=nats:latest /nats-server.conf /etc/nats/nats-server.conf
+
+<% end -%>
+#######################################################################
+<% if @avahi -%>
+
+# configure avahi for ipv6
+RUN sed -i 's/mdns4_minimal/mdns_minimal/' /etc/nsswitch.conf
+<% end -%>
+<% if @nginx -%>
+<% if @passenger -%>
+
+# configure nginx/passenger
+<% if @passenger -%>
+<% unless @avahi or @nats -%>
+COPY config/nginx.conf /etc/nginx/sites-available/rails.conf
+<% end -%>
+RUN rm /etc/nginx/sites-enabled/default && \
+    ln -s /etc/nginx/sites-available/rails.conf /etc/nginx/sites-enabled/ && \
+    sed -i 's/user .*;/user root;/' /etc/nginx/nginx.conf && \
+    sed -i '/^include/i include /etc/nginx/main.d/*.conf;' /etc/nginx/nginx.conf && \
+    mkdir /etc/nginx/main.d && \
+    echo 'env RAILS_MASTER_KEY;' >> /etc/nginx/main.d/env.conf &&\
+<% if @redis -%>
+    echo 'env REDIS_URL;' >> /etc/nginx/main.d/env.conf &&\
+<% end -%>
+<% if @anycable -%>
+    echo 'env ANYCABLE_RPC_HOST;' >> /etc/nginx/main.d/env.conf &&\
+    echo 'env CABLE_URL;' >> /etc/nginx/main.d/env.conf &&\
+<% end -%>
+    echo 'env RAILS_LOG_TO_STDOUT;' >> /etc/nginx/main.d/env.conf
+<% if @serverless -%>
+COPY config/hook_detached_process /etc/nginx/
+<% end -%>
+<% end -%>
+<% else -%>
+
+# configure nginx/passenger
+COPY <<-"EOF" /etc/nginx/sites-available/rails.conf
+<%= render 'nginx.conf.erb' %>
+EOF
+RUN rm /etc/nginx/sites-enabled/default && \
+    ln -s /etc/nginx/sites-available/rails.conf /etc/nginx/sites-enabled/
+<% end -%>
+<% end -%>
+
+<% if @procs.length > 1 and not @eject -%>
+# Define processes
+COPY <<-"EOF" ./Procfile.fly
+<%= render 'Procfile.fly.erb' %>
+EOF
+
+<% end -%>
+<% unless @eject -%>
+# Define tasks
+COPY <<-"EOF" ./lib/tasks/fly.rake
+<%= render 'fly.rake.erb' %>
+EOF
+
+<% end -%>
+# Deploy your application
+COPY . .
+<% if @bundle_add -%>
+COPY --from=gems /app/Gemfile* ./
+<% end -%>
+
+# Adjust binstubs to run on Linux and set current working directory
+RUN chmod +x /app/bin/* && \
+    sed -i 's/ruby.exe/ruby\r*/' /app/bin/* && \
+    sed -i '/^#!/aDir.chdir File.expand_path("..", __dir__)' /app/bin/*
+
+# Run build task defined in config/fly.rb
+RUN SECRET_KEY_BASE=1 bin/rails fly:build
+
+# Start server
+<% if @litefs
+    @server_command="litefs"
+  else
+    @server_command="bin/rails fly:server"
+  end
+-%>
+CMD <%= @server_command.split(' ').inspect %>

data/lib/generators/templates/Procfile.fly.erb

@@ -0,0 +1,3 @@
+<% @procs.each do |type, command| -%>
+<%= type %>: <%= command %>
+<% end -%>

data/lib/generators/templates/dockerignore.erb

@@ -0,0 +1,16 @@
+.git
+tmp
+!tmp/pids
+log
+public/assets
+public/packs
+.bundle
+
+db/*.sqlite3
+db/*.sqlite3-*
+
+storage
+config/master.key
+config/credentials/*.key
+
+node_modules

data/lib/generators/templates/fly.rake.erb

@@ -0,0 +1,101 @@
+# commands used to deploy a Rails application
+namespace :fly do
+  # BUILD step:
+  #  - changes to the filesystem made here DO get deployed
+  #  - NO access to secrets, volumes, databases
+  #  - Failures here prevent deployment
+  task :build => 'assets:precompile'
+
+<% unless @litefs -%>
+  # RELEASE step:
+  #  - changes to the filesystem made here are DISCARDED
+  #  - full access to secrets, databases
+  #  - failures here prevent deployment
+  <%- if @sqlite3 -%>
+  task :release
+  <%- else -%>
+  task :release => 'db:migrate'
+  <%- end -%>
+
+<% end -%>
+<% if @avahi or @nats -%>
+  task :env do
+<% if @redis -%>
+    if ENV['NATS_SERVER']
+      redis_host = "#{ENV['FLY_REGION']}-redis.local"
+    else
+      redis_host = 'localhost'
+    end
+
+    ENV['REDIS_URL'] = "redis://#{redis_host}:6379/1"
+<% end -%>
+<% if @anycable -%>
+    ENV['ANYCABLE_GO_RPC_HOST'] = "#{ENV['FLY_REGION']}-anycable-rpc.local:50051"
+<% end -%>
+  end
+
+<% end -%>
+  # SERVER step:
+  #  - changes to the filesystem made here are deployed
+  #  - full access to secrets, databases
+  #  - failures here result in VM being stated, shutdown, and rolled back
+  #    to last successful deploy (if any).
+  <%= begin
+    deps = [:swapfile]
+    deps << 'db:migrate' if @sqlite3
+    deps = deps.first if deps.length == 1
+
+    if @procs.length > 1 and (@avahi or @nats)
+      "task :server, [:formation] => #{deps.inspect} do |task, args|"
+    else
+      "task :server => #{deps.inspect} do"
+    end
+  end %>
+  rm_f 'tmp/pids/server.pid' if File.exist? 'tmp/pids/server.pid'
+  <%- if @procs.length > 1 -%>
+    <%- if @avahi or @nats -%>
+    <%- if @passenger -%>
+    sh 'envsubst < config/nginx.conf > /etc/nginx/sites-available/rails.conf'
+    <%- end -%>
+    formation = args[:formation].gsub!(';', ',')
+    <%- if @avahi -%>
+    Rake::Task['fly:avahi_publish'].invoke(formation)
+    <%- end -%>
+    <%- if @nats -%>
+    Rake::Task['fly:nats_publish'].invoke(formation) if ENV['NATS_SERVER']
+    <%- end -%>
+    Bundler.with_original_env do
+      Rake::Task['fly:env'].invoke
+      sh "foreman start --procfile=Procfile.fly --formation=#{formation}"
+    end
+    <%- else -%>
+    Bundler.with_original_env do
+      sh "foreman start --procfile=Procfile.fly"
+    end
+    <%- end -%>
+  <%- else -%>
+    sh <%= @procs.values.first.inspect %>
+  <%- end -%>
+  end
+
+  # optional SWAPFILE task:
+  #  - adjust fallocate size as needed
+  #  - performance critical applications should scale memory to the
+  #    point where swap is rarely used.  'fly scale help' for details.
+  #  - disable by removing dependency on the :server task, thus:
+  <%- if @sqlite3 -%>
+  #        task :server => 'db:migrate' do
+  <%- else -%>
+  #        task :server do
+  <%- end -%>
+  task :swapfile do
+    sh 'fallocate -l 512M /swapfile'
+    sh 'chmod 0600 /swapfile'
+    sh 'mkswap /swapfile'
+    sh 'echo 10 > /proc/sys/vm/swappiness'
+    sh 'swapon /swapfile'
+<% if @redis == :internal -%>
+    sh 'echo 1 > /proc/sys/vm/overcommit_memory'
+<% end -%>
+  end
+end

data/lib/generators/templates/fly.rb.erb

@@ -0,0 +1,27 @@
+image <%= @image.inspect %>
+
+machine do
+  cpus 1
+  cpu_kind 'shared'
+  memory_mb 256
+end
+<% if @sqlite3 -%>
+
+sqlite3 do
+  size 3
+end
+<% end -%>
+<% if @postgresql -%>
+
+postgres do
+  vm_size 'shared-cpu-1x'
+  volume_size 1
+  initial_cluster_size 1
+end
+<% end -%>
+<% if @redis -%>
+
+redis do
+  plan "Free"
+end
+<% end -%>

data/lib/generators/templates/fly.toml.erb

@@ -0,0 +1,81 @@
+app = "<%= @app %>"
+<% if @nomad -%>
+kill_signal = "SIGINT"
+kill_timeout = 5
+<% unless @avahi or @nats -%>
+processes = []
+<% end -%>
+
+[build]
+  [build.args]
+    BUILD_COMMAND = "bin/rails fly:build"
+<% if @litefs -%>
+    SERVER_COMMAND = "litefs"
+<% else -%>
+    SERVER_COMMAND = "bin/rails fly:server"
+
+[deploy]
+  release_command = "bin/rails fly:release"
+<% end -%>
+
+[env]
+  PORT = "8080"
+<% if @sqlite3 -%>
+<% if @litefs -%>
+  DATABASE_URL = "sqlite3:///data/production.sqlite3"
+<% else -%>
+  DATABASE_URL = "sqlite3:///mnt/volume/production.sqlite3"
+<% end -%>
+<% if @avahi or @nats -%>
+
+[processes]
+  app = "bin/rails fly:server[<%= @procs.keys.map {|key| "#{key}=1"}.join(';') %>]"
+<% end -%>
+
+[mounts]
+  source = <%= "#{app.gsub('-', '_')}_volume".inspect %>
+  destination = "/mnt/volume"
+<% end -%>
+
+[experimental]
+  allowed_public_ports = []
+  auto_rollback = true
+<% if @litefs -%>
+  enable_consul = true
+<% end  -%>
+
+[[services]]
+  http_checks = []
+  internal_port = 8080
+  processes = ["app"]
+  protocol = "tcp"
+  script_checks = []
+  [services.concurrency]
+<% if @cable -%>
+    hard_limit = 2500
+    soft_limit = 2000
+<% else -%>
+    hard_limit = 25
+    soft_limit = 20
+<% end -%>
+    type = "connections"
+
+  [[services.ports]]
+    force_https = true
+    handlers = ["http"]
+    port = 80
+
+  [[services.ports]]
+    handlers = ["tls", "http"]
+    port = 443
+
+  [[services.tcp_checks]]
+    grace_period = "1s"
+    interval = "15s"
+    restart_limit = 0
+    timeout = "2s"
+
+[[statics]]
+  guest_path = "/app/public"
+  url_prefix = "/"
+<% end -%>

data/lib/generators/templates/hook_detached_process.erb

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+status = `passenger-status`
+
+processes = status[/^Processes\s*:\s*(\d*)/, 1].to_i
+
+system 'nginx -s stop' if processes == 0

data/lib/generators/templates/litefs.yml.erb

@@ -0,0 +1,14 @@
+# The path to where the SQLite database will be accessed.
+mount-dir: "/data"
+
+# The path to where the underlying volume mount is.
+data-dir: "/mnt/volume"
+
+# Execute this subprocess once LiteFS connects to the cluster. 
+exec: "bin/rails fly:server"
+
+# These environment variables will be available in your Fly.io application.
+# You must specify "experiement.enable_consul" for FLY_CONSUL_URL to be available.
+consul:
+  url: "${FLY_CONSUL_URL}"
+  advertise-url: "http://${HOSTNAME}.vm.${FLY_APP_NAME}.internal:20202"

data/lib/generators/templates/main.tf.erb

@@ -0,0 +1,101 @@
+terraform {
+  required_providers {
+    fly = {
+      source = "fly-apps/fly"
+      version = "0.0.20"
+    }
+  }
+}
+
+variable "image_ref" {
+  type        = string
+  description = "docker images containing the application"
+}
+
+/* uncomment if you want an internal tunnel
+provider "fly" {
+  useinternaltunnel    = true
+  internaltunnelorg    = <%= (@org || "personal").inspect %>
+  internaltunnelregion = <%= (@regions.first || 'iad').inspect %>
+}
+*/
+
+# Allocate an IPv4 address
+resource "fly_ip" "<%= @appName %>Ipv4" {
+  app        = <%= @app.inspect %>
+  type       = "v4"
+}
+
+# Allocate an IPv6 address
+resource "fly_ip" "<%= @appName %>Ipv6" {
+  app        = <%= @app.inspect %>
+  type       = "v6"
+}
+
+<% unless @sqlite3 -%>
+/* Uncomment this if you want a volume
+<% end -%>
+resource "fly_volume" "<%= @appName %>Volume" {
+  for_each = toset(<%= @regions.inspect %>)
+  region = each.value
+
+  name       = "<%= @appName %>Volume"
+  app        = <%= @app.inspect %>
+  size       = 3
+}
+<% unless @sqlite3 -%>
+*/
+<% end -%>
+
+# Start a fly machine
+resource "fly_machine" "<%= @appName %>Machine" {
+  for_each = toset(<%= @regions.inspect %>)
+  region = each.value
+
+  app    = <%= @app.inspect %>
+  name   = "<%= @app %>-${each.value}"
+  image  = var.image_ref
+
+  # Scale application resources
+  cpus     = 1
+  cputype  = "shared"
+  memorymb = 256
+
+  # map http[s] external ports 443 and 80 to internal port 8080
+  services = [
+    {
+      ports = [
+        {
+          port     = 443
+          handlers = ["tls", "http"]
+        },
+        {
+          port     = 80
+          handlers = ["http"]
+        }
+      ]
+
+      protocol = "tcp"
+      internal_port = 8080
+    }
+  ]
+
+  <%- if @sqlite3 -%>
+  env = {
+    DATABASE_URL = "sqlite3:///mnt/db/production.sqlite3"
+  }
+
+  mounts = [
+    {
+      volume  = "<%= @appName %>Volume"
+      path    = "/mnt/db"
+    }
+  ]
+
+  depends_on = [fly_volume.<%= @appName %>Volume]
+  <%- else -%>
+  /* Uncomment this if you want a volume
+  depends_on = [fly_volume.<%= @appName %>Volume]
+  */
+  <%- end -%>
+}