Упрощенное руководство по «докеразии» Ruby и Rails с помощью внешнего приложения React

Докеризация вашего Ruby on Rails с помощью внешнего приложения React может значительно улучшить ваш рабочий процесс разработки и процесс развертывания. Создавая стандартизированную среду для своего приложения, вы обеспечиваете единообразное поведение на разных этапах разработки, тестирования, производства и даже в разных системах. Фактически, он предназначен для минимизации проблем, связанных с системными различиями. Это руководство проведет вас через основные шаги, чтобы обеспечить бесперебойную работу вашего приложения Rails и React в контейнерах Docker. Зачем докеризовать приложение? : Согласованность в разных средах Docker гарантирует, что приложение работает одинаково независимо от того, где оно развернуто: на компьютере разработчика, в среде тестирования или на рабочем сервере. Эта согласованность достигается за счет контейнеризации всех зависимостей и конфигураций. : Управление зависимостями Контейнеры Docker включают все необходимые зависимости для запуска приложения. Это означает, что вариации в системных библиотеках или отсутствие зависимостей от разных систем не влияют на функциональность приложения. : Изоляция Контейнеры Docker работают изолированно друг от друга и от хост-системы. Эта изоляция предотвращает конфликты между различными приложениями и их зависимостью от одной системы. : Портативность Контейнеры Docker можно легко перемещать и запускать в любой системе, поддерживающей Docker, будь то локальный компьютер, облачная служба или выделенный сервер. Это делает приложение очень портативным и гибким с точки зрения развертывания. Примечание. Требуется знание синтаксиса Docker. Докеризация включает в себя две ключевые концепции: образы и контейнеры. Образы служат образцами контейнеров и содержат всю необходимую информацию для создания контейнера, включая зависимости и конфигурации развертывания. Контейнер — это экземпляр образа во время выполнения, включающий само изображение, среду выполнения и инструкции времени выполнения. Docker в целом устанавливает стандарт для поставки программного обеспечения. Чтобы объяснить Docker простой аналогией: подумайте о контейнерах как о транспортных контейнерах на складе, об изображениях как о предметах, помещенных внутри этих контейнеров, а о транспортном судне как о системе, в которой работают контейнеры. Всякий раз, когда вы настраиваете и создаете свое приложение, необходимы определенные конфигурации среды. Например, вы не можете запустить приложение Rails без установленной в вашей системе среды Ruby. Аналогично, вы не можете запустить приложение React без и не можете установить пакеты React без менеджера пакетов Node, такого как или и т. д. Node.js npm Yarn Поскольку контейнер работает изолированно от системы пользователя, мы собираемся сделать все эти пакеты доступными в нашем контейнере так же, как если бы мы собирали его непосредственно в нашей системе, таким образом, контейнер будет действовать в нем как система. собственный, как виртуальная машина. Существуют различия между докером и виртуальной машиной, но этот пример предназначен только для дальнейшего объяснения. Теперь давайте продолжим и докеризуем приложение Rails. Для этого нам понадобятся три файла в нашем приложении Rails: , и . Давайте рассмотрим каждый из этих файлов подробно. Dockerfile docker-compose.yml bin/docker-entrypoint Примечание. Требуется знание синтаксиса Docker. Докерфайл — это схема создания контейнера Docker. Он содержит ряд инструкций, которые Docker использует для создания образа, который затем можно использовать для запуска контейнеров. Давайте разберем для приложения Ruby on Rails и React: Dockerfile Dockerfile . Базовое изображение ARG RUBY_VERSION=3.1.4 FROM ruby:$RUBY_VERSION : определяет аргумент сборки с именем со значением по умолчанию . Это можно переопределить во время сборки. ARG RUBY_VERSION=3.1.4 RUBY_VERSION 3.1.4 : использует базовый образ с версией, указанной в . Это настраивает контейнер со средой выполнения Ruby. Как я уже упоминал ранее, для запуска приложения Rails вам необходимо установить Ruby. FROM ruby:$RUBY_VERSION ruby RUBY_VERSION 2. Установите зависимости RUN apt-get update -qq && \ apt-get install -y build-essential libvips bash bash-completion libffi-dev tzdata postgresql curl && \ apt-get clean && \ rm -rf /var/lib/apt/lists/* /usr/share/doc /usr/share/man : обновляет список пакетов из репозиториев, используя для тихого вывода. apt-get update -qq -qq : устанавливает различные пакеты: apt-get install -y ... : необходимые пакеты для сборки программного обеспечения (например, GCC). build-essential : библиотека для обработки изображений. libvips , : оболочка Bash и ее автодополнение. bash bash-completion : библиотека интерфейса внешних функций. libffi-dev : данные о часовом поясе. tzdata : клиент базы данных PostgreSQL. postgresql : инструмент для передачи данных с URL-адресов. curl : очищает локальный репозиторий полученных файлов пакетов. apt-get clean : удаляет списки пакетов и документацию, чтобы уменьшить размер образа. rm -rf /var/lib/apt/lists/ /usr/share/doc /usr/share/man 3. Установите Node.js и Yarn. RUN curl -fsSL https://deb.nodesource.com/setup_current.x | bash - && \ apt-get install -y nodejs && \ curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | apt-key add - && \ echo "deb https://dl.yarnpkg.com/debian/ stable main" | tee /etc/apt/sources.list.d/yarn.list && \ apt-get update && \ apt-get install -y yarn : загружает и запускает сценарий установки NodeSource для установки Node.js. curl -fsSL https://deb.nodesource.com/setup_current.x | bash - : устанавливает Node.js. apt-get install -y nodejs добавляет ключ Yarn GPG для проверки пакетов. curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | apt-key add - : добавляет репозиторий Yarn в список источников. echo "deb https://dl.yarnpkg.com/debian/ stable main" | tee /etc/apt/sources.list.d/yarn.list : обновляет список пакетов и устанавливает Yarn. apt-get update && apt-get install -y yarn 4. Переменные среды ENV NODE_OPTIONS=--openssl-legacy-provider : устанавливает переменную среды для включения устаревшей поддержки OpenSSL для Node.js. ENV NODE_OPTIONS=--openssl-legacy-provider 5. Установите рабочий каталог. WORKDIR /rails : устанавливает рабочий каталог для последующих инструкций в . WORKDIR /rails /rails 6. Создайте аргументы и переменные среды ARG RAILS_ENV ENV RAILS_ENV=$RAILS_ENV : определяет аргумент сборки с именем для указания среды Rails (например, , , ). ARG RAILS_ENV RAILS_ENV development test production : устанавливает для переменной среды значение аргумента сборки. ENV RAILS_ENV=$RAILS_ENV RAILS_ENV 7. Установите Gems приложений COPY Gemfile Gemfile.lock ./ RUN bundle install : копирует и в рабочий каталог. COPY Gemfile Gemfile.lock ./ Gemfile Gemfile.lock : Устанавливает драгоценные камни Ruby, указанные в . RUN bundle install Gemfile 8. Установите внешние зависимости COPY package.json yarn.lock ./ RUN yarn install --frozen-lockfile : копирует и в рабочий каталог. COPY package.json yarn.lock ./ package.json yarn.lock : Устанавливает внешние зависимости с помощью Yarn, гарантируя использование точных версий в . RUN yarn install --frozen-lockfile yarn.lock 9. Скопируйте код приложения COPY . . : копирует весь код приложения в рабочий каталог. COPY . . 10. Предварительная компиляция кода Bootsnap RUN bundle exec bootsnap precompile --gemfile app/ lib/ : Предварительно компилирует кэш Bootsnap для ускорения загрузки приложения Rails. Bootsnap — это драгоценный камень, который ускоряет загрузку Ruby и Rails за счет кэширования дорогостоящих вычислений. RUN bundle exec bootsnap precompile --gemfile app/ lib/ 11. Предварительная компиляция ресурсов для производства RUN if [ "$RAILS_ENV" = "production" ]; then \ SECRET_KEY_BASE=1 bin/rails assets:precompile; \ fi : Условно запускает предварительную компиляцию ресурсов, только если для установлено значение . Этот шаг имеет решающее значение для подготовки ресурсов к производственной среде. RUN if [ "$RAILS_ENV" = "production" ]; then ... RAILS_ENV production 12. Скрипт точки входа COPY bin/docker-entrypoint /rails/bin/ RUN chmod +x /rails/bin/docker-entrypoint : копирует сценарий пользовательской точки входа в контейнер. COPY bin/docker-entrypoint /rails/bin/ : делает скрипт точки входа исполняемым. RUN chmod +x /rails/bin/docker-entrypoint 13. Определите точку входа и команду ENTRYPOINT ["/rails/bin/docker-entrypoint"] EXPOSE 5000 // you can use any port of your choice CMD ["./bin/rails", "server"] : устанавливает сценарий точки входа, который будет запускаться при запуске контейнера. Этот сценарий обычно настраивает среду, подготавливает базу данных и запускает приложение. ENTRYPOINT ["/rails/bin/docker-entrypoint"] : указывает, что контейнер прослушивает порт 5000. Это функция документации, и порт не публикуется. EXPOSE 5000 : определяет команду по умолчанию, запускаемую при запуске контейнера, то есть запуск сервера Rails. CMD ["./bin/rails", "server"] docker-compose.yml Файл используется для определения и запуска многоконтейнерных приложений Docker. Он позволяет вам настраивать службы, сети и тома вашего приложения в одном файле. В данном случае мы собираемся использовать два сервиса. Вот файл для приложения Rails: docker-compose.yml docker-compose.yml 1. ) Служба базы данных ( db codedb: image: postgres:14.2-alpine container_name: demo-postgres-14.2 volumes: - postgres_data:/var/lib/postgresql/data command: "postgres -c 'max_connections=500'" environment: POSTGRES_DB: ${POSTGRES_DB} POSTGRES_USER: ${POSTGRES_USER} POSTGRES_PASSWORD: ${POSTGRES_PASSWORD} ports: - "5432:5432" : указывает образ Docker, который будет использоваться для этого сервиса. В данном случае это образ PostgreSQL 14.2, основанный на дистрибутиве Alpine Linux. Альпийские изображения известны своим небольшим размером, что позволяет уменьшить общий размер изображения. image: postgres:14.2-alpine : называет контейнер . Это имя используется для ссылки на контейнер в командах и журналах. container_name: demo-postgres-14.2 demo-postgres-14.2 volumes : монтирует именованный том в внутри контейнера. В этом каталоге PostgreSQL хранит свои данные, гарантируя сохранение данных базы данных между перезапусками контейнера. postgres_data:/var/lib/postgresql/data: postgres_data /var/lib/postgresql/data : переопределяет команду по умолчанию для образа PostgreSQL. Он запускает PostgreSQL с опцией конфигурации, позволяющей увеличить максимальное количество подключений до 500. command: "postgres -c 'max_connections=500'" environment : : устанавливает имя создаваемой базы данных по умолчанию, используя переменную среды . POSTGRES_DB: ${POSTGRES_DB} POSTGRES_DB : устанавливает имя пользователя по умолчанию для доступа к базе данных PostgreSQL с использованием переменной среды . POSTGRES_USER: ${POSTGRES_USER} POSTGRES_USER : устанавливает пароль для пользователя по умолчанию, используя переменную среды . POSTGRES_PASSWORD: ${POSTGRES_PASSWORD} POSTGRES_PASSWORD ports : : сопоставляет порт 5432 на хосте с портом 5432 в контейнере. Это позволяет получить доступ к PostgreSQL на хост-компьютере через порт 5432. "5432:5432" 2. ) Служба веб-приложений ( demo-web codedemo-web: build: context: . args: - RAILS_ENV=${RAILS_ENV} command: "./bin/rails server -b 0.0.0.0" environment: - RAILS_ENV=${RAILS_ENV} - POSTGRES_HOST=${POSTGRES_HOST} - POSTGRES_DB=${POSTGRES_DB} - POSTGRES_USER=${POSTGRES_USER} - POSTGRES_PASSWORD=${POSTGRES_PASSWORD} - RAILS_MASTER_KEY=${RAILS_MASTER_KEY} volumes: - .:/rails - app-storage:/rails/storage depends_on: - db ports: - "3000:3000" build: : указывает контекст сборки для образа Docker. В этом случае, ссылается на текущий каталог. Это означает, что Docker будет использовать Dockerfile в текущем каталоге для создания образа. context: . . args : : передает аргумент сборки в процесс сборки Docker, позволяя вам указать среду Rails (например, , или ). RAILS_ENV=${RAILS_ENV} RAILS_ENV development test production : переопределяет команду по умолчанию для образа Docker. Запускает сервер Rails и привязывает его ко всем сетевым интерфейсам ( ), что необходимо для доступности сервиса извне контейнера. command: "./bin/rails server -b 0.0.0.0" 0.0.0.0 environment: : устанавливает среду Rails внутри контейнера с помощью переменной среды . RAILS_ENV=${RAILS_ENV} RAILS_ENV : устанавливает адрес хоста PostgreSQL. POSTGRES_HOST=${POSTGRES_HOST} : устанавливает имя базы данных. POSTGRES_DB=${POSTGRES_DB} : устанавливает пользователя PostgreSQL. POSTGRES_USER=${POSTGRES_USER} : устанавливает пароль пользователя PostgreSQL. POSTGRES_PASSWORD=${POSTGRES_PASSWORD} : Устанавливает главный ключ Rails, который используется для шифрования учетных данных и других секретов. RAILS_MASTER_KEY=${RAILS_MASTER_KEY} volumes : : монтирует текущий каталог (где находится файл ) в внутри контейнера. Это позволяет вам редактировать файлы на вашем хосте и отражать эти изменения внутри контейнера. .:/rails docker-compose.yml /rails : монтирует именованный том в внутри контейнера. Обычно это используется для хранения файлов, специфичных для Rails, таких как журналы, загрузки и кэшированные файлы. app-storage:/rails/storage app-storage /rails/storage depends_on : : гарантирует, что служба ожидает готовности службы перед запуском. Docker Compose управляет порядком запуска служб на основе этого параметра. db demo-web db ports: : сопоставляет порт 3000 на хосте с портом 3000 в контейнере. Это позволяет вам получить доступ к приложению Rails на хост-компьютере через порт 3000. "3000:3000" Объемы codevolumes: postgres_data: app-storage: : определяет именованный том используемый службой для сохранения данных PostgreSQL. postgres_data postgres_data db : определяет именованный том , используемый службой для хранения данных, специфичных для приложения, таких как загрузки и журналы. app-storage app-storage demo-web bin/docker-точка входа Сценарий является важной частью настройки Docker. Он выполняется при запуске контейнера и обычно отвечает за настройку среды, подготовку базы данных и другие задачи инициализации, необходимые перед запуском основного приложения. Вот пример сценария и подробное объяснение каждой части: bin/docker-entrypoint bin/docker-entrypoint Шебанг и выход при ошибке bashCopy code#!/bin/bash set -e : эта строка указывает, что сценарий следует запускать с использованием оболочки Bash. #!/bin/bash : указывает сценарию немедленно завершить работу, если какая-либо команда возвращает ненулевой код выхода. Это помогает гарантировать, что в случае сбоя какого-либо шага выполнение сценария прекратится, что может предотвратить выполнение последующих шагов в недопустимом состоянии. set -e Условное создание или миграция базы данных # If running the rails server then create or migrate existing database if [ "${*}" == "./bin/rails server" ]; then ./bin/rails db:create ./bin/rails db:prepare fi : Этот условный оператор проверяет, является ли команда, переданная сценарию ( ), . — это специальный параметр, который содержит все позиционные параметры, передаваемые в скрипт. if [ "${*}" == "./bin/rails server" ]; then ... fi "${*}" ./bin/rails server * ./bin/rails БД : Если условие выполнено, эта команда попытается создать базу данных. Это эквивалентно запуску , который настраивает базу данных, как определено в файле конфигурации базы данных ( ). rails db:create config/database.yml ./bin/rails БД : Эта команда запустит , что обеспечит настройку и миграцию базы данных. Он создаст базу данных, если она не существует, и выполнит миграцию, если база данных уже создана. Это комбинация и . rails db:prepare rails db:create rails db:migrate Выполнение основного процесса bashCopy codeexec "${@}" : заменяет текущий процесс оболочки командой, переданной в качестве аргументов сценарию. Символ содержит все позиционные параметры, передаваемые в скрипт. Например, если сценарий вызывается с помощью , эта строка фактически запускает как основной процесс контейнера. exec "${@}" @ ./bin/rails server ./bin/rails server Заключение Хорошо продуманный необходим для создания надежной и согласованной среды для вашего приложения Ruby on Rails и React. Определив базовый образ, задав переменные среды и установив зависимости, вы гарантируете, что ваше приложение будет бесперебойно работать в различных средах. Dockerfile Docker не только оптимизирует процесс разработки, но и повышает надежность вашего приложения в рабочей среде. Есть области оптимизации, но это всего лишь общий обзор того, как докеризовать приложение Rails. Полный сценарий для результирующего , и Dockerfile docker-compose.yml bin/docker-entrypoint ARG RUBY_VERSION=3.1.4 FROM ruby:$RUBY_VERSION # Install dependencies RUN apt-get update -qq && \ apt-get install -y build-essential libvips bash bash-completion libffi-dev tzdata postgresql curl && \ apt-get clean && \ rm -rf /var/lib/apt/lists/* /usr/share/doc /usr/share/man # Install Node.js and Yarn RUN curl -fsSL https://deb.nodesource.com/setup_current.x | bash - && \ apt-get install -y nodejs && \ curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | apt-key add - && \ echo "deb https://dl.yarnpkg.com/debian/ stable main" | tee /etc/apt/sources.list.d/yarn.list && \ apt-get update && \ apt-get install -y yarn # Set environment variable to enable legacy OpenSSL support ENV NODE_OPTIONS=--openssl-legacy-provider # Rails app lives here WORKDIR /rails # Set environment variable for the build ARG RAILS_ENV ENV RAILS_ENV=$RAILS_ENV # Install application gems COPY Gemfile Gemfile.lock ./ RUN bundle install # Install frontend dependencies COPY package.json yarn.lock ./ RUN yarn install --frozen-lockfile # Copy application code COPY . . # Precompile bootsnap code for faster boot times RUN bundle exec bootsnap precompile --gemfile app/ lib/ # Precompiling assets for production without requiring secret RAILS_MASTER_KEY RUN if [ "$RAILS_ENV" = "production" ]; then \ SECRET_KEY_BASE=1 bin/rails assets:precompile; \ fi # Entrypoint prepares the database. COPY bin/docker-entrypoint /rails/bin/ RUN chmod +x /rails/bin/docker-entrypoint # Use an absolute path for the entry point script ENTRYPOINT ["/rails/bin/docker-entrypoint"] # Start the server by default, this can be overwritten at runtime EXPOSE 5000 CMD ["./bin/rails", "server"] services: db: image: postgres:14.2-alpine container_name: demo-postgres-14.2 volumes: - postgres_data:/var/lib/postgresql/data command: "postgres -c 'max_connections=500'" environment: POSTGRES_DB: ${POSTGRES_DB} POSTGRES_USER: ${POSTGRES_USER} POSTGRES_PASSWORD: ${POSTGRES_PASSWORD} ports: - "5432:5432" demo-web: build: context: . args: - RAILS_ENV=${RAILS_ENV} command: "./bin/rails server -b 0.0.0.0" environment: - RAILS_ENV=${RAILS_ENV} - POSTGRES_HOST=${POSTGRES_HOST} - POSTGRES_DB=${POSTGRES_DB} - POSTGRES_USER=${POSTGRES_USER} - POSTGRES_PASSWORD=${POSTGRES_PASSWORD} - RAILS_MASTER_KEY=${RAILS_MASTER_KEY} volumes: - .:/rails - app-storage:/rails/storage depends_on: - db ports: - "3000:3000" volumes: postgres_data: app-storage: #!/bin/bash set -e # If running the rails server then create or migrate existing database if [ "${*}" == "./bin/rails server" ]; then ./bin/rails db:create ./bin/rails db:prepare fi exec "${@}"