使用 Docker Compose 将 Ruby on Rails 应用程序容器化以进行开发

简介如果您正在积极开发应用程序,使用Docker可以简化您的工作流程以及将应用程序部署到生产的过程。在开发中使用容器具有以下好处: 环境是一致的,这意味着你可以为你的项目选择你想要的语言和依赖项,而不用担心系统冲突。环境被隔离,更容易解决问题和加入新的团队成员。环境是可移植的,允许您打包并与他人共享您的代码。本教程将向您展示如何使用 Docker 为Ruby on Rails应用程序设置开

weixin_0010034

64人浏览 · 2022-08-05 18:38:07

weixin_0010034 · 2022-08-05 18:38:07 发布

简介

如果您正在积极开发应用程序,使用Docker可以简化您的工作流程以及将应用程序部署到生产的过程。在开发中使用容器具有以下好处:

环境是一致的,这意味着你可以为你的项目选择你想要的语言和依赖项,而不用担心系统冲突。
环境被隔离,更容易解决问题和加入新的团队成员。
环境是可移植的,允许您打包并与他人共享您的代码。

本教程将向您展示如何使用 Docker 为Ruby on Rails应用程序设置开发环境。您将为应用程序本身、PostgreSQL数据库、Redis和Sidekiq服务创建多个容器 - 使用Docker Compose。该设置将执行以下操作:

将宿主机上的应用程序代码与容器内的代码同步,方便开发过程中的更改。
在容器重新启动之间保留应用程序数据。
配置 Sidekiq 工作人员以按预期处理作业。

在本教程结束时,您将拥有一个在 Docker 容器上运行的鲨鱼信息应用程序:

Sidekiq 应用主页

先决条件

要遵循本教程,您将需要:

运行 Ubuntu 18.04 的本地开发机器或服务器,以及具有sudo权限和活动防火墙的非 root 用户。有关如何设置这些设置的指导,请参阅此初始服务器设置指南。
Docker 安装在您的本地机器或服务器上,按照如何在 Ubuntu 18.04上安装和使用 Docker 的步骤 1 和 2。
Docker Compose 安装在您的本地计算机或服务器上,按照如何在 Ubuntu 18.04上安装 Docker Compose 的第 1 步。

第 1 步 - 克隆项目并添加依赖项

我们的第一步是从DigitalOcean 社区 GitHub 帐户克隆rails-sidekiq存储库。此存储库包含如何将 Sidekiq 和 Redis 添加到 Ruby on Rails 应用程序中描述的设置中的代码,其中解释了如何将 Sidekiq 添加到现有的 Rails 5 项目中。

将存储库克隆到名为rails-docker的目录中:

git clone https://github.com/do-community/rails-sidekiq.git rails-docker

导航到rails-docker目录:

cd rails-docker

在本教程中,我们将使用 PostgreSQL 作为数据库。为了使用 PostgreSQL 而不是 SQLite 3,您需要将pggem添加到项目的依赖项中,这些依赖项在其 Gemfile 中列出。使用nano或您喜欢的编辑器打开该文件进行编辑:

nano Gemfile

在主项目依赖项(在开发依赖项之上)的任何位置添加 gem:

~/rails-docker/Gemfile

. . . 
# Reduces boot times through caching; required in config/boot.rb
gem 'bootsnap', '>= 1.1.0', require: false
gem 'sidekiq', '~>6.0.0'
gem 'pg', '~>1.1.3'

group :development, :test do
. . .

我们也可以注释掉sqlitegem,因为我们不会再使用它了:

~/rails-docker/Gemfile

. . . 
# Use sqlite3 as the database for Active Record
# gem 'sqlite3'
. . .

最后把development下面的spring-watcher-listengem注释掉:

~/rails-docker/Gemfile

. . . 
gem 'spring'
# gem 'spring-watcher-listen', '~> 2.0.0'
. . .

如果我们不禁用这个 gem,我们将在访问 Rails 控制台时看到持续的错误消息。这些错误消息源于这个 gem 有 Rails 使用listen来监视开发中的变化,而不是轮询文件系统的变化。因为这个 gem 监视项目的根目录,包括node_modules目录,所以它会抛出有关正在监视哪些目录的错误消息,从而使控制台混乱。但是,如果您担心节省 CPU 资源,则禁用此 gem 可能对您不起作用。在这种情况下,将 Rails 应用程序升级到 Rails 6 可能是个好主意。

完成编辑后保存并关闭文件。

准备好项目存储库,将pggem 添加到 Gemfile 并注释掉spring-watcher-listengem,您就可以配置应用程序以使用 PostgreSQL。

第 2 步 - 配置应用程序以使用 PostgreSQL 和 Redis

要在开发中使用 PostgreSQL 和 Redis,我们需要执行以下操作:

将应用程序配置为使用 PostgreSQL 作为默认适配器。
使用我们的数据库用户名和密码以及 Redis 主机将.env文件添加到项目中。
创建init.sql脚本为数据库创建sammy用户。
为 Sidekiq 添加一个初始化程序以便它可以与我们的容器化redis服务一起使用。
将.env文件和其他相关文件添加到项目的gitignore和dockerignore文件中。
创建数据库种子,以便我们的应用程序在启动时有一些记录供我们使用。

首先,打开位于config/database.yml的数据库配置文件:

nano config/database.yml

目前,该文件包括以下default个设置,这些设置在没有其他设置的情况下应用:

~/rails-docker/config/database.yml

default: &default
  adapter: sqlite3
  pool: <%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %>
  timeout: 5000

我们需要更改这些以反映我们将使用postgresql适配器这一事实,因为我们将使用 Docker Compose 创建一个 PostgreSQL 服务来保存我们的应用程序数据。

删除将 SQLite 设置为适配器的代码并将其替换为以下设置,这将适当地设置适配器以及连接所需的其他变量:

~/rails-docker/config/database.yml

default: &default
  adapter: postgresql
  encoding: unicode
  database: <%= ENV['DATABASE_NAME'] %>
  username: <%= ENV['DATABASE_USER'] %>
  password: <%= ENV['DATABASE_PASSWORD'] %>
  port: <%= ENV['DATABASE_PORT'] || '5432' %>
  host: <%= ENV['DATABASE_HOST'] %>
  pool: <%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %>
  timeout: 5000
. . .

接下来,我们将修改development环境的设置,因为这是我们在此设置中使用的环境。

删除现有的 SQLite 数据库配置,使该部分如下所示:

~/rails-docker/config/database.yml

. . . 
development:
  <<: *default
. . .

最后,删除production和test环境的database设置:

~/rails-docker/config/database.yml

. . . 
test:
  <<: *default
  
production:
  <<: *default
. . .

这些对我们默认数据库设置的修改将允许我们使用.env文件中定义的环境变量动态设置我们的数据库信息,这些文件不会提交给版本控制。

完成编辑后保存并关闭文件。

请注意,如果您从头开始创建 Rails 项目,您可以使用rails new命令设置适配器,如步骤 3ofHow To Use PostgreSQL with Your Ruby on Rails Application on Ubuntu 18.04中所述。这会将您的适配器设置为config/database.yml并自动将pggem 添加到项目中。

现在我们已经引用了环境变量,我们可以使用我们的首选设置为它们创建一个文件。以这种方式提取配置设置是应用程序开发的12 因素方法的一部分,该方法定义了分布式环境中应用程序弹性的最佳实践。现在,当我们将来设置生产和测试环境时,配置我们的数据库设置将涉及创建额外的.env文件并在我们的 Docker Compose 文件中引用适当的文件。

打开一个.env文件:

nano .env

将以下值添加到文件中:

~/rails-docker/.env

DATABASE_NAME=rails_development
DATABASE_USER=sammy
DATABASE_PASSWORD=shark
DATABASE_HOST=database
REDIS_HOST=redis

除了设置我们的数据库名称、用户和密码之外,我们还为DATABASE_HOST设置了一个值。值database是指我们将使用 Docker Compose 创建的databasePostgreSQL 服务。我们还设置了一个REDIS_HOST来指定我们的redis服务。

完成编辑后保存并关闭文件。

要创建sammy数据库用户,我们可以编写一个init.sql脚本,然后我们可以在数据库容器启动时将其挂载到数据库容器中。

打开脚本文件:

nano init.sql

添加以下代码以创建具有管理权限的sammy用户:

~/rails-docker/init.sql

CREATE USER sammy;
ALTER USER sammy WITH SUPERUSER;

该脚本将在数据库上创建适当的用户并授予该用户管理权限。

在脚本上设置适当的权限:

chmod +x init.sql

接下来,我们将配置 Sidekiq 以使用我们的容器化redis服务。我们可以在config/initializers目录中添加一个初始化程序,一旦加载了框架和插件,Rails 就会在其中查找配置设置,从而为 Redis 主机设置一个值。

打开sidekiq.rb文件以指定以下设置:

nano config/initializers/sidekiq.rb

将以下代码添加到文件中以指定REDIS_HOST和REDIS_PORT的值:

~/rails-docker/config/initializers/sidekiq.rb

Sidekiq.configure_server do |config|
  config.redis = {
    host: ENV['REDIS_HOST'],
    port: ENV['REDIS_PORT'] || '6379'
  }
end

Sidekiq.configure_client do |config|
  config.redis = {
    host: ENV['REDIS_HOST'],
    port: ENV['REDIS_PORT'] || '6379'
  }
end

与我们的数据库配置设置非常相似,这些设置使我们能够动态设置主机和端口参数,允许我们在运行时替换适当的值,而无需修改应用程序代码本身。除了REDIS_HOST之外,我们还为REDIS_PORT设置了默认值,以防其他地方没有设置。

完成编辑后保存并关闭文件。

接下来,为了确保我们的应用程序的敏感数据不会被复制到版本控制中,我们可以将.env添加到我们项目的.gitignore文件中,它告诉 Git 在我们的项目中要忽略哪些文件。打开文件进行编辑:

nano .gitignore

在文件的底部,为.env添加一个条目:

~/rails-docker/.gitignore

yarn-debug.log*
.yarn-integrity
.env

完成编辑后保存并关闭文件。

接下来,我们将创建一个.dockerignore文件来设置不应复制到容器中的内容。打开文件进行编辑:

.dockerignore

将以下代码添加到文件中,这会告诉 Docker 忽略一些我们不需要复制到容器中的内容:

~/rails-docker/.dockerignore

.DS_Store
.bin
.git
.gitignore
.bundleignore
.bundle
.byebug_history
.rspec
tmp
log
test
config/deploy
public/packs
public/packs-test
node_modules
yarn-error.log
coverage/

将.env也添加到该文件的底部:

~/rails-docker/.dockerignore

. . .
yarn-error.log
coverage/
.env

完成编辑后保存并关闭文件。

作为最后一步,我们将创建一些种子数据,以便我们的应用程序在启动时有一些记录。

在db目录中为种子数据打开一个文件:

nano db/seeds.rb

将以下代码添加到文件中以创建四个演示鲨鱼和一个示例帖子:

~/rails-docker/db/seeds.rb

# Adding demo sharks
sharks = Shark.create([{ name: 'Great White', facts: 'Scary' }, { name: 'Megalodon', facts: 'Ancient' }, { name: 'Hammerhead', facts: 'Hammer-like' }, { name: 'Speartooth', facts: 'Endangered' }])
Post.create(body: 'These sharks are misunderstood', shark: sharks.first)

该种子数据将创建四条鲨鱼和一个与第一条鲨鱼相关联的帖子。

完成编辑后保存并关闭文件。

将您的应用程序配置为使用 PostgreSQL 并创建环境变量后,您就可以编写应用程序 Dockerfile。

第 3 步 — 编写 Dockerfile 和入口点脚本

您的 Dockerfile 指定创建应用程序容器时将包含的内容。使用 Dockerfile 可以定义容器环境并避免依赖项或运行时版本的差异。

遵循这些关于构建优化容器的指南,我们将通过使用Alpine base并尝试总体上最小化我们的镜像层来使我们的镜像尽可能高效。

在当前目录中打开一个 Dockerfile:

nano Dockerfile

Docker 镜像是使用一系列相互构建的分层镜像创建的。我们的第一步是为我们的应用程序添加_base image_,这将构成应用程序构建的起点。

将以下代码添加到文件中以添加Ruby alpine 映像作为基础:

~/rails-docker/Dockerfile

FROM ruby:2.5.1-alpine

alpine镜像源自 Alpine Linux 项目,将帮助我们减小镜像大小。有关alpine映像是否适合您的项目的更多信息,请参阅Docker Hub Ruby 映像页面的 Image Variants 部分下的完整讨论。

在开发中使用alpine时需要考虑的一些因素:

减小图像大小将减少页面和资源加载时间,特别是如果您还将卷保持在最低限度。这有助于使您在开发中的用户体验快速且接近于您在非容器化环境中本地工作时的体验。
开发和生产映像之间的平等有助于成功部署。由于团队经常选择在生产中使用 Alpine 图像以获得速度优势,因此使用 Alpine 基础进行开发有助于在转移到生产时解决问题。

接下来,设置一个环境变量,指定Bundler版本:

~/rails-docker/Dockerfile

. . .
ENV BUNDLER_VERSION=2.0.2

这是我们为避免环境中可用的默认bundler版本与需要 Bundler 2.0.2 的应用程序代码之间的版本冲突而采取的步骤之一。

接下来,将与应用程序一起使用所需的包添加到 Dockerfile:

~/rails-docker/Dockerfile

. . . 
RUN apk add --update --no-cache \
      binutils-gold \
      build-base \
      curl \
      file \
      g++ \
      gcc \
      git \
      less \
      libstdc++ \
      libffi-dev \
      libc-dev \ 
      linux-headers \
      libxml2-dev \
      libxslt-dev \
      libgcrypt-dev \
      make \
      netcat-openbsd \
      nodejs \
      openssl \
      pkgconfig \
      postgresql-dev \
      python \
      tzdata \
      yarn

这些包包括nodejs和yarn等。由于我们的应用程序使用 webpack为资产提供服务,因此我们需要包含Node.js和Yarn才能使应用程序按预期工作。

请记住,alpine映像非常小:此处列出的包并未详尽说明您在容器化自己的应用程序时可能想要或需要的内容。

接下来,安装相应的bundler版本:

~/rails-docker/Dockerfile

. . . 
RUN gem install bundler -v 2.0.2

此步骤将保证我们的容器化环境与该项目的Gemfile.lock文件中的规范之间的一致性。

现在为容器上的应用程序设置工作目录:

~/rails-docker/Dockerfile

. . .
WORKDIR /app

复制您的Gemfile和Gemfile.lock:

~/rails-docker/Dockerfile

. . .
COPY Gemfile Gemfile.lock ./

将这些文件作为一个独立步骤复制,后跟bundle install,这意味着每次更改应用程序代码时都不需要重新构建项目 gem。这将与我们将包含在 Compose 文件中的 gem 卷一起使用,在重新创建服务但项目 gem 保持不变的情况下,它将把 gem 挂载到您的应用程序容器中。

接下来,设置nokogirigem 构建的配置选项:

~/rails-docker/Dockerfile

. . . 
RUN bundle config build.nokogiri --use-system-libraries
. . .

此步骤使用我们在上面的RUN apk add…步骤中添加到应用程序容器的libxml2和libxslt库版本](https://nokogiri.org/tutorials/installing_nokogiri.html#install-with-system-libraries)构建nokigiri[。

接下来,安装项目 gem:

~/rails-docker/Dockerfile

. . . 
RUN bundle check || bundle install

该指令在安装之前检查 gem 是否尚未安装。

接下来,我们将使用我们的 JavaScript 包和依赖项重复我们对 gems 使用的相同过程。首先我们将复制包元数据,然后我们将安装依赖项,最后我们将应用程序代码复制到容器映像中。

要开始使用 Dockerfile 的 Javascript 部分,请将主机上当前项目目录中的package.json和yarn.lock复制到容器中:

~/rails-docker/Dockerfile

. . . 
COPY package.json yarn.lock ./

然后用yarn install安装所需的包:

~/rails-docker/Dockerfile

. . . 
RUN yarn install --check-files

该指令包含一个带有yarn命令的--check-files标志,该功能可确保未删除任何以前安装的文件。与我们的 gems 一样,当我们编写 Compose 文件时,我们将使用一个卷来管理node_modules目录中的包的持久性。

最后,复制其余的应用程序代码并使用入口点脚本启动应用程序:

~/rails-docker/Dockerfile

. . . 
COPY . ./ 

ENTRYPOINT ["./entrypoints/docker-entrypoint.sh"]

使用入口点脚本允许我们将容器作为可执行文件运行。

最终的 Dockerfile 将如下所示:

~/rails-docker/Dockerfile

FROM ruby:2.5.1-alpine

ENV BUNDLER_VERSION=2.0.2

RUN apk add --update --no-cache \
      binutils-gold \
      build-base \
      curl \
      file \
      g++ \
      gcc \
      git \
      less \
      libstdc++ \
      libffi-dev \
      libc-dev \ 
      linux-headers \
      libxml2-dev \
      libxslt-dev \
      libgcrypt-dev \
      make \
      netcat-openbsd \
      nodejs \
      openssl \
      pkgconfig \
      postgresql-dev \
      python \
      tzdata \
      yarn 

RUN gem install bundler -v 2.0.2

WORKDIR /app

COPY Gemfile Gemfile.lock ./

RUN bundle config build.nokogiri --use-system-libraries

RUN bundle check || bundle install 

COPY package.json yarn.lock ./

RUN yarn install --check-files

COPY . ./ 

ENTRYPOINT ["./entrypoints/docker-entrypoint.sh"]

完成编辑后保存并关闭文件。

接下来,为入口点脚本创建一个名为entrypoints的目录:

mkdir entrypoints

该目录将包括我们的主入口点脚本和 Sidekiq 服务的脚本。

打开应用程序入口点脚本的文件:

nano entrypoints/docker-entrypoint.sh

将以下代码添加到文件中:

rails-docker/entrypoints/docker-entrypoint.sh

#!/bin/sh

set -e

if [ -f tmp/pids/server.pid ]; then
  rm tmp/pids/server.pid
fi

bundle exec rails s -b 0.0.0.0

第一个重要的行是set -e,它告诉运行脚本的/bin/shshell 快速失败,如果脚本后面有任何问题。接下来,脚本会检查tmp/pids/server.pid是否不存在,以确保在我们启动应用程序时不会发生服务器冲突。最后,脚本使用bundle exec rails s命令启动 Rails 服务器。我们在此命令中使用-b选项将服务器绑定到所有 IP 地址,而不是默认的localhost。此调用使 Rails 服务器将传入请求路由到容器 IP,而不是默认的localhost。

完成编辑后保存并关闭文件。

使脚本可执行:

chmod +x entrypoints/docker-entrypoint.sh

接下来,我们将创建一个脚本来启动我们的sidekiq服务,该服务将处理我们的 Sidekiq 作业。有关此应用程序如何使用 Sidekiq 的更多信息,请参阅如何将 Sidekiq 和 Redis 添加到 Ruby on Rails 应用程序。

为 Sidekiq 入口点脚本打开一个文件:

nano entrypoints/sidekiq-entrypoint.sh

将以下代码添加到文件中以启动 Sidekiq:

~/rails-docker/entrypoints/sidekiq-entrypoint.sh

#!/bin/sh

set -e

if [ -f tmp/pids/server.pid ]; then
  rm tmp/pids/server.pid
fi
 
bundle exec sidekiq

该脚本在我们的应用程序包的上下文中启动 Sidekiq。

完成编辑后保存并关闭文件。使其可执行:

chmod +x entrypoints/sidekiq-entrypoint.sh

有了入口点脚本和 Dockerfile,您就可以在 Compose 文件中定义服务了。

第 4 步 — 使用 Docker Compose 定义服务

使用 Docker Compose,我们将能够运行我们的设置所需的多个容器。我们将在主文件docker-compose.yml中定义 Compose services。 Compose 中的服务是一个正在运行的容器,并且服务定义(您将包含在docker-compose.yml文件中)包含有关每个容器映像将如何运行的信息。 Compose 工具允许您定义多个服务来构建多容器应用程序。

我们的应用程序设置将包括以下服务:

应用程序本身
PostgreSQL 数据库
雷迪斯
西底家

我们还将绑定挂载作为我们设置的一部分,以便我们在开发期间所做的任何代码更改都将立即与需要访问此代码的容器同步。

请注意,我们_不_定义test服务,因为测试超出了本教程和系列的范围,但您可以按照我们在此处使用的sidekiq服务的先例来进行。

打开docker-compose.yml文件:

nano docker-compose.yml

首先,添加应用服务定义: