はじめに
背景
一次ソース(に出来るだけ近い情報)を参照しながら学習を進める訓練をしています。
また、これまでスルーしがちだった基礎用語や概念を深掘りする学習も始めました。
今回は、下記のチュートリアルを対象にします。
クィックスタート: Compose と Rails | Docker ドキュメント
Dockerfileとシェルスクリプトファイル(entrypoint.sh)についてまとめた時点で文量が多くなってしまったため、これら以外の内容については次回の投稿にまとめます。
英文はまずDeepLの機械翻訳文を読んでから解釈を試みています。
注意
本稿は、Dockerについて理解の無い私がメモとして記している物です。
単なる個人的な感想も多く、また、解釈文であっても間違いがある可能性があります。
本稿を勉強目的でご覧になる場合は、この本文ではなく参照リンク先の方をご覧いただければと思います。
(リンク集としては少しは役に立てるかも...)
また、常識的なITの基礎用語であっても、とにかく私自身が知らなかったものには反応しているため、冗長であったり、本筋から脱線したような内容が多くなっています。
本編
クィックスタート: Compose と Rails | Docker ドキュメント
こちらのチュートリアルを読み進めていきます。
Dockerfile全体
FROM ruby:2.5
RUN apt-get update -qq && apt-get install -y nodejs postgresql-client
RUN mkdir /myapp
WORKDIR /myapp
COPY Gemfile /myapp/Gemfile
COPY Gemfile.lock /myapp/Gemfile.lock
RUN bundle install
COPY . /myapp
# コンテナー起動時に毎回実行されるスクリプトを追加
COPY entrypoint.sh /usr/bin/
RUN chmod +x /usr/bin/entrypoint.sh
ENTRYPOINT ["entrypoint.sh"]
EXPOSE 3000
# メインプロセスの起動
CMD ["rails", "server", "-b", "0.0.0.0"]
1行目 : FROM ruby:2.5
FROM ruby:2.5
FROM
FROM | Docker ドキュメント日本語化プロジェクト >> Docs
FROM命令の役割は、処理ステージの初期化と、ベースイメージの設定
まだ、現状の自分には概念理解が難しいと感じました。
とりあえず後日参考にしそうなリンクだけ...
- ベース・イメージ（base image） | Docker ドキュメント日本語化プロジェクト >> Docs
- 親イメージ（parent image） | Docker ドキュメント日本語化プロジェクト >> Docs
- Dockerイメージの理解を目指すチュートリアル - Qiita
今回はこのコンテナのベースイメージとして、RubyのDockerイメージを設定するということのようです。
ruby - Docker Hub
２行目 : RUN apt-get ...
RUN apt-get update -qq && apt-get install -y nodejs postgresql-client
RUN
RUN | Docker ドキュメント日本語化プロジェクト >> Docs
コマンドの実行
apt-getコマンドについて
- apt-get(8) - Debian Manpages
- apt-get - パッケージの操作・管理 - Linuxコマンド | Webkaru - Webプログラミング入門
- Linux豆知識 102 APT | LPI-Japan
APT(Application Packaging Tool)は、もともとDebian向けのパーケージ管理システムのことで、Debian系以外のディストリビューションでもそのコマンドを使用できる場合もあるようです。
Debianというのは、あるフリーのOSであって、apt-getはDebian系のOS上でパッケージを操作するためのコマンドのようです。
Debian は、現在 Linux カーネルか FreeBSD カーネルを利用しています。
Linux カーネル?
About Linux Kernel | The Linux Kernel Archives
If you're new to Linux, you don't want to download the kernel, which is just a component in a working Linux system. Instead, you want what is called a distribution of Linux, which is a complete Linux system.
カーネルはあくまでLinuxシステムの様々な機能を担うコンポーネント(部品のような存在)であって、完全なLinuxシステムを手元で扱うのならば、出来合いのOSとして配布(或いは販売)されているDistribution of Linux（Linuxディストリビューション）が必要ということでしょうか。
https://mirrors.kernel.org/
このサイトで、代表的なディストリビューションのミラーが提供されているようです。
The Debian Linux distributionが提供されていることも確認できます。
Linuxディストリビューション | Wikipedia
Linuxカーネル | Wikipedia
公式版のカーネルは、ディストリビューションのベンダーにて独自にカスタマイズされていることもあるようです。
Linux豆知識 028 カーネル（kernel） | LPI-Japan
これはよく言われることですが、厳密には「Linux」と言った場合、このLinux kernelのことを指します（最近では、後述する「Linuxディストリビューション」をLinuxと呼ぶケースも増えてきています）。
"Linux"と記載されている場合でも、文脈によってLinuxカーネルだったり、ディストリビューションの事を指していたりするってことか。慣れていくしかなさそうです。
ここでapt-getコマンドの話に戻りますが、このコマンドが使用できるということは、RubyのDockerイメージは、Debian系のLinuxディストリビューションをベースにしているのでしょうか？
ruby - Docker Hub
Image Variants 項にて ruby:＜version＞について
This tag is based off of buildpack-deps. buildpack-deps is designed for the average user of Docker who has many images on their system. It, by design, has a large number of extremely common Debian packages. This reduces the number of packages that images that derive from it need to install, thus reducing the overall size of all images on your system.
Rubyの標準Dockerイメージのベースとなっている***buildpack-deps***は、ごく一般的なDebianのパッケージを大量に含んでいるらしく、この説明文から、RubyのDockerイメージ環境下でのパッケージ操作のためにapt-getコマンドを使用できそうな気はしてきます。
(上記引用文で言及されているDebianの一般的なパッケージ群？ -> buildpack-deps/Dockerfile.template)
ただ、使用するOSについての直接的な記述を見たいです。
Stack Overflowで質問を調べてみると、同様の疑問に関する質疑がありました。
node.js - Docker Hub - Node Repo - What OS is this running? - Stack Overflow
ベスト解答では、Dockerfileのベースイメージを辿れば答えに行き着くことが説明されています。
同様に探ってみます。
今回のベースイメージは、ruby:2.5なので、まずはそのバージョンのディレクトリへ。
https://github.com/docker-library/ruby/tree/master/2.5
/2.5以下の構成は、alpine3.11, alpine3.12, buster, stretchの4種類があり、alpineはLinuxディストリビューションのひとつである、Alpine Linux projectを指します。
ruby - Docker Hubにも記載の通り、busterやstretchは、Debianのスイート名です。
("スイート"という用語は今回が初見で、個々についてはスイートを成す派生品群のひとつという解釈をしています。間違えていたらすみません。 参照：アプリケーションスイートとは 「ソフトウェアスイート, スイート」 (application suite)： - IT用語辞典バイナリ)
ruby - Docker Hub > Supported tags and respective Dockerfile linksの項より、今回のようなタグなし(ruby:2.5)の場合は、buster用のDockerfileにサポートされているようなので、その内容を見ていきます。
https://github.com/docker-library/ruby/blob/master/2.5/buster/Dockerfile
FROM buildpack-deps:buster
ベースイメージとして、buildpack-deps:busterを指定しているようです。同様に辿ってベースイメージの記述を見ていきます。
https://github.com/docker-library/buildpack-deps/blob/master/debian/buster/Dockerfile
FROM buildpack-deps:buster-scm
最終的に以下に行き着きました。
https://github.com/docker-library/buildpack-deps/blob/master/debian/buster/curl/Dockerfile
FROM debian:buster
これで、RubyのデフォルトのDockerイメージ上で稼働するOSがDebian系であることは確認できたので、apt-getコマンドが使用可能であることは腑に落ちました。
apt-get update -qq
apt-get(8) - Debian Manpages
update : 利用可能なパッケージの一覧を更新するようです。
-qq:進捗のログを省略し、また、含まれた-yによってプロンプトへ自動で'yes'を応答して進めるというもののようです。
下記の質疑によると、-qqオプションのみで実行してしまうと、システムに予期せぬ影響を及ぼす変更がある場合に、ログが出力されないために気づけないということが起こりうるので、安全管理面で使用には注意が必要なようです。
software installation - Why shouldn't I use apt-get install --qq without a no-action modifier? - Ask Ubuntu
apt-get install -y nodejs postgresql-client
開発の都合によっては、ここでYarnなども追記してインストールします。
Getting Started with Rails — Ruby on Rails Guides
3~8行目
RUN mkdir /myapp
WORKDIR /myapp
WORKDIR
WORKDIR | Docker ドキュメント日本語化プロジェクト >> Docs
ワークディレクトリを設定する。
Railsアプリケーションを置くフォルダを生成して、ワーキングディレクトリとして設定しています。
COPY Gemfile /myapp/Gemfile
COPY Gemfile.lock /myapp/Gemfile.lock
RUN bundle install
COPY . /myapp
COPY
COPY | Docker ドキュメント日本語化プロジェクト >> Docs
ファイルやディレクトリを新たにコピーして、対象のパスに追加する。
チュートリアルの手順として、ローカルにGemfileとGemfile.lockを生成するので、それらをコンテナ内のRailsアプリケーションを置くパスにコピーしています。
entrypoint.sh (シェルスクリプトファイル)
このチュートリアルではentrypoint.shというシェルスクリプトファイルを生成して使用します。
そもそも、シェルスクリプトの概念を知らなかったので、もまともに調べたのが今回初めてとなりました。
Bash - GNU Project - Free Software Foundation
The GNU Bourne-Again Shell
Bash Reference Manual
/bin/bashとは｜「分かりそう」で「分からない」でも「分かった」気になれるIT用語辞典
今回扱うシェルスクリプトファイルの内容は以下の通りです。
#!/bin/bash
set -e
# Rails に対応したファイル server.pid が存在しているかもしれないので削除する。
rm -f /myapp/tmp/pids/server.pid
# コンテナーのプロセスを実行する。（Dockerfile 内の CMD に設定されているもの。）
exec "$@"
#!/bin/bash
１行目の#!/bin/bashについてはマニュアルに下記の説明があります。
3.8 Shell Scripts - Bash Reference Manual
If the first line of a script begins with the two characters ‘#!’, the remainder of the line specifies an interpreter for the program.
また、
Bash scripts often begin with #! /bin/bash (assuming that Bash has been installed in /bin), since this ensures that Bash will be used to interpret the script, even if it is executed under another shell.
つまり、#!/bin/bashはコメント文ではなく、#!によってインタプリタを/bin/bashに指定して、そのOSで使用されるシェルの系統に関わらずスクリプトを/bin/bashとして解釈し、処理を進めるという意味があるようです。
次行に処理のコードが続きます。
set -e
[4.3.1 The Set Builtin - Bash Reference Manual]
(https://tiswww.case.edu/php/chet/bash/bashref.html#The-Set-Builtin)
Bashの内部コマンドで、シェルのオプション値を変更したり、位置パラメータを設定する。
-eオプションの説明項
Exit immediately if a pipeline (see Pipelines), which may consist of a single simple command (see Simple Commands), a list (see Lists), or a compound command (see Compound Commands) returns a non-zero status.
上記解説で言うと、今回はどれも"a single simple command"なのでしょうか...?
また、ステータスがゼロの時と、ゼロでない時とは、それぞれ具体的にどのようなときを指すのでしょうか。
3.2.1 Simple Commands - Bash Reference Manual
It’s just a sequence of words separated by blanks, terminated by one of the shell’s control operators (see Definitions).
空白で区切られる場合や、制御演算子で終了する場合のこと。
2 Definitions - Bash Reference Manual
制御演算子の項に"改行"も含まれているので、entrypoint.shでset -e以降のコードは、それぞれSimple Commands(単純なコマンド？)に分類できると判断しました。
3.7.5 Exit Status - Bash Reference Manual
For the shell’s purposes, a command which exits with a zero exit status has succeeded. A non-zero exit status indicates failure.
上記引用のset -eの終了条件とは、終了ステータス
成功：0,
失敗：0以外
ということでしょうか。
set -eについて、実際の挙動を解説する動画もありました。(英語は分かりませんが...)
Learn about scripts, functions, chmod and set -e | #2 Practical Bash - YouTube
5:22~あたりからset -e或いはset +eの挙動が実演されています。
set +e以降はステータスが0の場合に直ちに終了
set -e以降はステータスが1(0以外)の場合に直ちに終了
動画では関数内でreturnによってステータスの値を渡しています。
entrypoint.sh内では、いずれかのコマンドが失敗すれば、直ちにプロセスを終了するために先頭で呼ばれているようです。
rm -f /myapp/tmp/pids/server.pid
マニュアルのページは下記
rm(1) — Linux manual page
削除対象のPIDファイルについて
pidfile - What are pid and lock files for? - Unix & Linux Stack Exchange
起動中のプロセスIDを記録して、それが実行中であることを判断するために生成されているもののようです。
従って、実行状態の判断をPIDファイルに依存している場合は、サーバーの終了方法によってはPIDファイルが削除されずに残る場合があるため、今回はこのスクリプトファイル内で削除する一文を加えることで、コンテナサーバー起動前に毎回PIDファイルを削除するようにしているようです。
-fオプションによって、対象ファイルが存在しなかった場合もエラーは返しません。
後日参照したい
- linux - What is a .pid file and what does it contain? - Stack Overflow
- rack/server.rb at master · rack/rack
- Prevent exception caused by a race condition on multi-threaded servers #1080
exec "$@"
4.1 Bourne Shell Builtins
execはBourne Shellから継承されてBashでも使用できるコマンドのひとつです。
@ - 3.4.2 Special Parameters - Bash Reference Manual
現時点では解説を読んでも理解し難かったので、手元で実行して比較しました。
- ２番目の位置パラメータを指定($2)
#!/bin/bash
echo "$2"
$ ./hoge.sh a b c d e
#=> b
配列のインデックスなどと違って、位置パラメータは数え番そのままの数値であることは注意したいです。
- 位置パラメータを展開($@)
#!/bin/bash
echo "$@"
$ ./hoge.sh a b c d e
#=> a b c d e
ここでの結論として、entrypoint.sh内で最後の行のコードexec "$@"の役割は、entrypoint.sh自体の親プロセスを展開したそれぞれの引数の実行結果に置き換えてコマンドラインへ出力し、entrypoint.shの実行以降の処理に進ませることであると思われます。
その他参考
-
linux - What does
exec "$@"do? - Unix & Linux Stack Exchange -
位置パラメーターの一括展開 $* $@ "$*" "$@" の違いを知れ!! - Shell Script Advent Calendar 2016 - ダメ出し Blog
こちらは奥が深そうなので、また個別に勉強します。 -
shell - What does set -e and exec "$@" do for docker entrypoint scripts? - Stack Overflow
脱線：manコマンド(macOSの場合)
調べる過程でmanページのことを初めて知りました。
macのターミナルで$ man rmを実行したらman7.orgにあったものと同様のものを読めました。
setやexecについては、manが適用できないのかと思いましたが、ふざけて実行すると、いずれもBUILTIN(1) - BSD General Commands Manualの内容が呼ばれました。
なんか違うOSの名前出てきた！と思ったらmacOSはFBDの血筋を引いている説明を見つけました。(BSD #BSDの主な子孫 - Wikipedia)
macでDarwinのバージョンを調べるコマンドがあったので確認してみました。
$ uname -v
Darwin Kernel Version 19.5.0: Tue May 26 20:41:44 PDT 2020; root:xnu-6153.121.2~2/RELEASE_X86_64
Darwin7.0からデフォルトのシェルをBashに変更したとあるので、manコマンドでBashのコマンドのマニュアル呼ぼうとしたらBSDのコマンドマニュアルが呼ばれるのも、そのあたりの関係性によるものなのでしょうか。
頭が付いていかないので、今回はこのあたりにしておきます。
10~17行目 コンテナの起動時
# コンテナー起動時に毎回実行されるスクリプトを追加
COPY entrypoint.sh /usr/bin/
RUN chmod +x /usr/bin/entrypoint.sh
ENTRYPOINT ["entrypoint.sh"]
EXPOSE 3000
# メインプロセスの起動
CMD ["rails", "server", "-b", "0.0.0.0"]
COPY entrypoint.sh /usr/bin/
チュートリアルの手順にて、ローカルで作成していたentrypoint.shをコンテナルート下/usr/bin/へコピーしています。
RUN chmod +x /usr/bin/entrypoint.sh
CHMOD(1) - BSD General Commands Manual
chmod - Wikipedia
全クラスに対して、(x)実行権限を(+)付与する
つまり、ユーザーに関わらず/usr/bin/entrypoint.shに実行権限を付与して、シェルスクリプトファイルを実行可能としています。
ENTRYPOINT ["entrypoint.sh"]
ENTRYPOINT
ENTRYPOINT | Docker ドキュメント日本語化プロジェクト >> Docs
今回では、exec形式にてデフォルトで実行するコマンドライン引数としてentrypoint.shを指定しています。
EXPOSE 3000
EXPOSE
EXPOSE | Docker ドキュメント日本語化プロジェクト >> Docs
コンテナの実行時にリッスンする、ネットワーク上のポートを指定します。今回は"3000"。
CMD ["rails", "server", "-b", "0.0.0.0"]
CMD
CMD | Docker ドキュメント日本語化プロジェクト >> Docs
CMD 命令の主目的は、コンテナの実行時のデフォルト処理を設定することです。
Dockerfileの命令で既にポートが3000に指定されているので、Railsのアプリケーションサーバーはポート3000で稼働します。
知りませんでしたが、"0.0.0.0"には、「特定のアドレスを指定しない」という意味があるようです。
下記リンクを参照しましたが、上記の解釈以上のことは難しくて分かりませんでした。それはまた後日。
127.0.0.1とlocalhostと0.0.0.0の違い - Qiita
What is the Difference Between 127.0.0.1 and 0.0.0.0? - How-To Geek
Dockerfileの内容についてはここで終わりです。
引き続きチュートリアルのその他の内容について、次回分にメモしていきます。