結論
今回ご紹介するスクリプトは以下の3つの条件の掛け合わせでDockerの開発環境を作成可能です。もちろん、起動も可能です。
環境構築実行例
Rails5.2.2, MySQL, Ruby2.5
$ ./build.sh 5.2.2 mysql 2.5
Rails5.0.0, MySQL, Ruby2.5
$ ./build.sh 5.0.0 mysql 2.5
Rails6.1.2, MySQL, Ruby3.0
$ ./build.sh 6.1.2 mysql 3.0
Rails5.2.2, PostgreSQL, Ruby2.5
$ ./build.sh 5.2.2 postgres 2.5
※MySQLの時と同じ画面ですが、PostgreSQLで起動した時のキャプチャを貼ってます
とにかく最初からやり直したい時
Dockerは階層型のキャッシュを利用して処理を効率化する仕組みになっているのですが、そのトレードオフとしてイメージが中途半端な状態だと場合によってはエラー対応に追われることになります。
その過程でよくわからない状態になってしまった場合、全部消えてもいいので最初からやり直したい時は、下記のコマンドを実行してください。
※このスクリプトで作成する以外のDocker環境が既にある場合は、安易に実行しないでください。内部でdocker image prune -fとか実行しているので。
$ ./clean.sh
スクリプトのリポジトリ
スクリプトはGitHubで公開しているので、下記のリポジトリからクローンをお願いします。
上記の情報以外の詳細はREADMEをご覧ください。
注意事項
Dockerデーモン起動およびDocker Composeを利用できる環境を前提としているので、Docker Desktop等からインストールしておいて下さい。
FreeBSDをベースとしたOS(macOS)を前提条件としていますが、sedのパラメータ指定がGNU系と違うくらいの差だと思うのでそこの処理さえ変えれば他のOSでも動くと思います。
Railsのバージョン5.0以上であれば動作可能であることのテストはできていますが、4系で動かす場合はひと手間必要です。ただ、The State of Developer Ecosystem 2020のRubyの現状から4系対応の処理を入れ込むメリットはないように思えているので、今のところ入れていません。
経緯
- プログラミング初学者がプログラミングそのものに集中できるようにしたい
- Dockerの環境操作におけるCLIのインターフェースを極力統一したい
プログラミング初学者がプログラミングそのものに集中できるようにしたい
個人的な理由ですが、新規の環境でRailsを使ったアプリケーション開発に関わることになったので、予習をする為にRailsの環境作成を行いました。
Rails公式サイト内でのGetting Started with Railsで一般的なOSでのインストール方法のガイドが掲載されていましたが、僕は何かしらの仮想環境で環境構築を行いたいので最初はVirtualBox内のUbuntuを使ってRailsの環境構築を行いました。
そして、DRY原則やCoC原則に規定されたRailsのアーキテクチャに感心しながら楽しく学習を進めることができました。
そのうちDockerでのRails環境を構築して検証を進めてみたくなったので、Dockerが提供しているドキュメントQuickstart: Compose and Railsを参考に環境構築を進めました。
僕の場合は、現場の環境にきっちり固定したRailsのバージョンをいくつか試してみたかったのと、DBはPostgreSQLではなくMySQLを使いたかったので上記通りではなく少し変更して環境を作成しました。
※現場の環境にバージョンを固定して検証したいっていうニーズ自体は結構あると思っています。
ここまでやってふと思ったのが、「Railsはプログラミング初学者が最初に選択することが多いフレームワークだと思っているけど、RailsのDocker環境構築は初学者には結構ハードル高くないか？」ということです。
Railsはプログラミング初学者が最初に選択することが多いフレームワークだと思っているけど、RailsのDocker環境構築は初学者にはきつい作業だなと思った。
— 親方 (@tajima_taso) February 13, 2021
なので、初学者がプログラミングの勉強だけに集中できるように何も考えず一発で環境構築できるコマンド作ったので共有することにする😇
Dockerはサービスの提供基盤としても主流になっていると思うので、初学者といえどもエンジニアを生業にすることを目指すならDocker環境上での開発に慣れておいた方が良いです。しかしながら、環境構築でのトライアンドエラーはとにかくプログラミングできるようになりたい初学者にとっては苦痛でしかないと思います。
もちろん、いずれはこういった工程を経て自力で問題を解決していくエンジニアにならなければならない局面が訪れると思いますが、初学者の今はその時ではないはずです。
※ちなみに僕はこういった調査とトライアンドエラーを繰り返す作業が大好物です😇
ただ、本当は「初学者の為」というのは後付で、自分が個人的に必要で作って使ってみたけど、他の人の助けになるかもしれないと思って公開したので一石二鳥です。
Dockerの環境操作におけるCLIのインターフェースを極力統一したい
公開するしない以前に、僕が最初にスクリプト化しようと思った動機はこれです。
極力互換性を保ってくれてはいますが、Dockerはコマンドが新規追加されたり今まで使っていたコマンドやオプションが廃止ないし非推奨になったり、新たなユーティリティが登場したりで他のツールよりインターフェースの変化が激しいと個人的には思っています。
ただ、それは悪いことではなく、アジャイルソフトウェア開発の流儀で述べられているように、ソフトウェア開発は変化が激しくて当たり前の世界なのでエンジニアはそれらに嘆くことなく追随していく手法を確立する義務があります。
そのようなケースに対応する僕なりの解の一つが今回のスクリプトでした。今後も何か変化があったらなるべく対応していこうと思います。
その場合も、このスクリプトのインターフェースは変わらずにキープしていくつもりです。
もしスクリプトへの機能追加やバグの指摘等あれば、プルリクでも何でも良いので頂けると嬉しいです。
Docker自体を詳しく知りたい方へ
Docker自体について詳しく知りたい方は拙文ですが原理原則で理解するDockerもあわせてご覧頂くと良いかもしれません。※内容が古くなってきているので新しい記事も書きたいですが 😅
まとめ
何度も自由に壊したり作ったりできるオモチャのような環境を手に入れるというのは、エンジニアの経験値を効率的に上げてくれる修行場のようなものなので、今後も壊しては作っては繰り返してレベルアップしていきたいと思います。