同じリポジトリから複数の Dev Containers 環境を並行起動する(コンテナ名とポートの衝突を避ける)
前提環境
- VS Code + Dev Containers(旧 Remote - Containers でも同じ考え方)
- docker compose(v2 系)
- WSL2 上で作業
リポジトリを、以下のように 2 つのフォルダに clone した想定です。
# 1つ目の環境
git clone xxxxxxxxxxxxxxxxxxxxx.git devc_rhel
# 2つ目の環境
git clone xxxxxxxxxxxxxxxxxxxxx.git devc_rhel_2
結論だけ先に
同じリポジトリを 別フォルダに git clone して devcontainer 環境を2つ起動
したい場合でも、次の2点だけ守れば同時起動できます。
- docker-compose.yml に container_name: を書かない(=デフォルト命名のままにする)
- ports: で公開している ホスト側ポートだけ ずらす(例: 8000 → 8001)
補足)
1.について、もし、docker-compose.yml に container_name:を書いてる場合は、
複数環境で重複しないように、コンテナ名をずらしていってください
同一PC内で重複しないように調整すれば、問題ないです
同一PC内で重複しないようにするというのは、他の開発案件の分も含めて
重複しないようにということです。( docker compose down で削除してる分は考慮不要 )
ですので、docker-compose.yml に container_name:書かなければ
後述のデフォルトの命名規則で重複が発生しにくい状況となるため
そのほうが楽です。
2.については、ports:のところに、8000:80 などの記述があった場合
この場合、: の左側の8000がホスト側のポート
: の右側がコンテナ側のポート
dockerコンテナは、Linuxのnamespace技術で完全に独立した隔離環境なので
コンテナ間で、コンテナ側のポートが重複していても問題ありません
ホスト側のポートは開発PCの中で重複があると、後から起動するほうがうまく起動しない問題が
あるため開発PC内で重複しないように調整する必要があります
これだけで、
- フォルダA: devc_rhel
- フォルダB: devc_rhel_2
を同時に動作可能です
コンテナ名、ホスト側のポートの2つが重複しなければ、複数同時に動作可能です。
この話は、
Dev Containers
旧 Remote - Containers
ともに共通です。
docker-compose.yml に container_name: を書かない場合の デフォルト命名 とは何か
docker-compose.yml で、
container_name を省略すると、Docker Compose はコンテナ名を
<プロジェクト名>_<サービス名>_<番号>
という形式で自動生成します。
ここで、
<プロジェクト名>は通常、docker-compose.yml が置かれているディレクトリ名
のことである
devc_rhelフォルダに、docker-compose.ymlがあれば
プロジェクト名は、devc_rhel
devc_rhel_2フォルダに、docker-compose.ymlがあれば
プロジェクト名は、devc_rhel_2
補足)
環境変数 COMPOSE_PROJECT_NAME を使って、プロジェクト名
をその値にすることもできるようだが、あまり使わない。
あんまり複数同時起動環境には向いてない
一応、やり方を示すと
export COMPOSE_PROJECT_NAME=foo
docker compose up -d
もしくは、
COMPOSE_PROJECT_NAME=foo docker compose up -d
のようなやり方
<サービス名>は、docker-compose.ymlのservicesに記載の各サービス名
services:
app:
のような記述のサービスは、サービス名が app です。
<番号> は同じサービスのコンテナごとに 1, 2, ... と付く連番です。
docker-compose.ymlには、同じサービス名を複数書くことはできないため
通常は <番号> の部分は1固定になります
たとえば、devc_rhel、devc_rhel_2フォルダで2つの環境を作り、両方起動すれば
devc_rhel_app_1
devc_rhel_2_app_1
のコンテナができます
ただし、マニアックなコンテナの起動方法として
docker compose up -d --scale app=2
のようにすると
devc_rhel_app_1
devc_rhel_app_2
のコンテナが起動することになります
このようなことをしない通常の場合は、
<番号>は1固定と考えて問題ありません
.devcontainer/devcontainer.jsonのnameも変更がオススメ
複数起動可能の条件としては、必須ではありませんが
.devcontainer/devcontainer.jsonのnameも環境ごとに値を変えておくことをオススメします。
devc_rhel フォルダ側の .devcontainer/devcontainer.json
{
"name": "devc_rhel",
devc_rhel_2 フォルダ側の .devcontainer/devcontainer.json
{
"name": "devc_rhel_2",
このような状況にしておくと
devc_rhel 環境でDevcontainersにログインした
状況のVS Codeは、左上に大文字で DEVC_RHEL の文言が表示されました
devc_rhel_2 環境でDevcontainersにログインした
状況のVS Codeは、左上に大文字で DEVC_RHEL_2 の文言が表示されました
Dev Containers の公式仕様にも、devcontainer.json の nameプロパティは、
「UI に表示される dev コンテナの名前」と記述があります
複数環境でのVS Codeを同時に複数起動して開発作業をする場合に
例として、プログラム改修後の動作環境と、改修前の動作環境を
同時に2つ起動して、結果を比較して差分が期待通りであるかをテストする場合など
もしくは、1つ目の環境は、とあるfeatureブランチでプルリクしてレビュー待ち
2つ目の環境は、次のタスクの開発を先行してやってる
そのとき、プルリクのレビュー中のもののレビューの指摘対応をする必要があるときは、
1つ目の環境で続行すればよい。終わったら、また、2つ目の環境で
次のタスク開発の続きをやればよい
これが環境が一つだと、いちいち、今、先行開発中のものをローカルで、
コミットまたは、gitスタッシュで、未ステージング/ステージングが無しの状態にして
ブランチを切り替えて、云々みたいなメンドイことを毎度しなければならない
複数環境つくっといて状況にあわせて、開発作業するフォルダを切り替えたほうが
gitでごにょごにょする手間が軽減されて楽ですよね
そういうところで、楽するために、複数環境作るのが私の考え方です
該当のVS Codeがどちらの環境のものなのかが区別がつきにくいですが
.devcontainer/devcontainer.jsonのnameプロパティの値を
環境ごとに変えておくと、VS Codeの表示が異なる形になるため、区別がつきやすいです。
実際にやったローカル変更
gitのリモートのリポジトリは、devc_rhel側に適合する形にしているため
devc_rhel_2側だけ、ローカルだけで変更 (コミット/プッシュしない)
補足)
このように起点となる1つをgitのリポジトリ
2つ目以降はローカルだけで変更(コミット/プッシュしない)
の方針で各自がローカルで必要ならば、複数環境構築の考え方としました。
.devcontainer/devcontainer.json の "name"
devcontainer.json の "name" は、VS Code 上の表示名です。
ここを変更しても Docker のプロジェクト名やコンテナ名には影響しませんが、
複数環境を開いたときに区別しやすくするために
だけの目的で変えておくと便利です。
{
"name": "devc_rhel_2",
"dockerComposeFile": "../docker-compose.yml",
"service": "app",
docker-compose.yml のホスト側のポートをずらす
下記の例では、
devc_rhelでは、
"127.0.0.1:8000:8000" の値を
devc_rhel_2では、
"127.0.0.1:8001:8000" の値に変更してます
services:
app:
・
・
(中略)
・
・
# ループバックのみ公開(外部露出を避ける)
ports:
- "127.0.0.1:8001:8000
「:」記号の
左側がホスト側ポート、右側がコンテナ側ポートです。
ホスト側: 127.0.0.1:8001
コンテナ側: 8000
コンテナ側ポートは、変更しなくても問題ありません
名前付きネットワーク、名前付きボリュームの名前もずらす必要あり
★★★★★★★★★★★★★★★★★★★★★★★★
★ 追記
★★★★★★★★★★★★★★★★★★★★★★★★
名前付きネットワーク
名前付きボリューム
を使ってる場合は、それらの名前も、別名にずらしていく必要あります。
( 複数環境同時並列実行するための条件としてです )
services:
app:
・
・
<中略>
・
・
depends_on:
- db
networks:
- example_network
db:
image: mysql:8.0
・
・
<中略>
・
・
volumes:
- example_mysql_data:/var/lib/mysql
- ./docker/mysql/init:/docker-entrypoint-initdb.d
networks:
- example_network
・
・
<中略>
・
・
# ボリューム
volumes:
example_mysql_data:
driver: local
# ネットワーク
networks:
example_network:
driver: bridge
のものがあった場合に、

図の左側が元の1つ目の環境
図の右側が2つ目の環境で
名前付きボリューム「example_mysql_data」を「example_mysql_data_2」に、
名前付きネットワーク「example_network」を「example_network_2」に、
ずらした形にする必要がある。
補足)
volumes:
- example_mysql_data:/var/lib/mysql
- ./docker/mysql/init:/docker-entrypoint-initdb.d
の
- example_mysql_data:/var/lib/mysql
で、「:」の左側の example_mysql_data のように、
./ まはた、 / から始まっていないものは、ボリュームマウントである。
docker compose down
では、ボリューム自体は残り、次に
docker compose build
docker compose up -d
しても、ボリュームの中のDBデータなどは、残ってる
docker compose down -v
で、「- v」オプション付きで、downした場合は、
ボリュームの中のDBデータなどは、消えて
docker compose build
docker compose up -d
したときに、消えてることが確認できる
Dockerの環境は、環境がトラブったり、して、Docker Desktopや、Rancher Desktopでの
全部削除や、prumeと呼ばれるキーワードを指定したような、お掃除系のコマンドでの全消し
で、環境トラブルを解消しなければならないことがよくあると思います
そのとき、ボリュームマウントでの環境だとDBのデータなどが全部消えてしまいますので
個人的には、DBデータも、バインドマウントにして、ホスト側に保存してくほうが、
取り扱いしやすいのではないかと考えています。
Docker環境のトラブルでの全消しでの解消操作の影響受けず、DBデータなど消えずに残せるからです。
- ./docker/mysql/init:/docker-entrypoint-initdb.d
で、「:」の左側の ./docker/mysql/init のように、
./ まはた、 / から始まっているものは、バインドマウンドといって、
ホスト側のWSL2のUbuntuのext4ファイルシステムや、Macのaplfsファイルシステム
へのバインドマウントで、コンテナ側からはホスト側のその領域へのバインドマウントである。
★★★★★★★★★★★★★★★★★★★★★★★★
もしも、docker-compose.yml に container_name: を書いてる場合
開発プロジェクトによっては、docker-compose.yml に container_name: を書いてる環境もあります
下記は、今回とは異なるプロジェクトの docker-compose.ymlですが
元々、docker-compose.yml に container_name: を書いてる状況のため
デフォルトの命名が働かず、書いてるコンテナ名になります
そのため、自分で container_name: の値を重複が発生しないようにずらしていかなければ
複数環境同時起動ができません。
下記の図のような要領で変更調整していく必要があります。


なぜ、container_name:を書いてる開発プロジェクトがあるのでしょうか?
理由として挙げられるのが2点あります
1点目の理由
設定ファイルに通信の設定を書く時に
通常は、ipアドレスまたは、ホスト名を書く値に
docker compose環境の場合は、代わりに、コンテナ名を書くことで
うまく動作できたりするわけです。
そのときに、もし、コンテナ名がデフォルトの命名でのコンテナ名だった場合
各自がgit cloneしたフォルダ名でのコンテナ名が変動しちゃうわけです
container_name:で固定的な値指定しておけば、
設定ファイルに書き込むコンテナ名も固定的な値を指定した形で環境構築できるわけです。
たとえば、
データベースの接続情報を設定ファイルなどに記載するときに、
dbのコンテナ名を設定ファイルに記載する必要があった
なども理由が考えられます
container_name:を書いてる開発プロジェクトの場合、
複数環境構築時に、コンテナ名を変更調整する必要がありますが、
設定ファイルに、dbの接続先としてコンテナ名を書いてる箇所があれば、
そこも、変更調整したコンテナ名に変えていくこと必要があるでしょう。
また、
フロントエンド側のコンテナと、バックエンド側のコンテナが
同一のdocker compose内にあり、
フロントエンド、バックエンド間で通信する場合に、
相手側のipアドレスや、ホスト名の代わりとして
相手のコンテナ名を指定して、通信してる場合もあります。
container_name:を書いてる開発プロジェクトの場合、
複数環境構築時に、コンテナ名を変更調整する場合は、
そのフロントエンドと、バックエンド間の通信の相手のコンテナ名の記述も
変更調整していく必要があるでしょう
2点目の理由
docker exec -it laravel_app bash
というコマンドで、コンテナにログインしていた理由
これは、
docker exec -it コンテナ名 bash
ではなく
docker compose exec -it サービス名 bash
を使えば、解決できます
docker exec -it コンテナ名 bash
を利用していると、
laravel_app、wk_laravel_appのようにコンテナ名の調整で複数環境構築時に
2つ目の環境で、wk_laravel_appを意識して開発してる状況で、
docker exec -it wk_laravel_app bash
とすべきところを、誤って
docker exec -it laravel_app bash
としてしまうと誤って、1つ目の環境で意図しない変更作業などしてしまうなど混乱のもとです
laravel_app、wk_laravel_appのようなコンテナ名は、グローバル領域であり、
docker execは、docker composeでなく通常のdockerコマンドで、グローバル領域を
対象にしているため、
このような間違え方しても、エラーにならず、別環境のコンテナに入れてしまいますので
混乱の元です。
docker compose exec -it サービス名 bash
の方式の場合、コマンドをたたいてる位置で一番近い
docker-coompose.ymlのフォルダ位置の支配下で動く、docker composeのコマンドであるため
同じサービス名でも、docker-coompose.ymlのフォルダ位置の支配下で動く
対応するコンテナにログインできます。
なので、この場合は、
docker compose exec -it app bash
としていたほうが、間違い(誤って複数環境の別環境に入って作業してしまったと言う間違い)
が発生しにくいです
例を挙げます
$ docker compose -p devc_rhel ps
NAME IMAGE COMMAND SERVICE CREATED STATUS PORTS
devc_rhel-app-1 vsc-devc_rhel-f0b46f855e1c247e0542c02ad6af824d-uid "/opt/entrypoint.sh …" app 9 days ago Up 24 hours 127.0.0.1:8000->8000/tcp
このとき、上記のコンテナは、
コンテナ名 devc_rhel-app-1
サービス名 app
となってるコンテナ名であります
ですので、
docker exec -it devc_rhel-app-1 bash
でもログインできるのですが、
docker compose exec -it app bash
を使ってログインしたほうがよりよいですよ
という意味です。
加えて、
devc_rhel_2 側で
$ docker compose -p devc_rhel_2 ps
NAME IMAGE COMMAND SERVICE CREATED STATUS PORTS
devc_rhel_2-app-1 vsc-devc_rhel_2-b7774e36c659e0a6f8c01d8461fbe92a-uid "/opt/entrypoint.sh …" app 6 hours ago Up 6 hours 127.0.0.1:8100->8000/tcp
コンテナ名 devc_rhel-app-2
サービス名 app
となってるコンテナ名が表示されます
このときも、devc_rhel_2 フォルダ配下で
docker compose exec -it app bash
を使ってログインすれば、
devc_rhel_2側の devc_rhel-app-2 のコンテナにログインすることができるのです
だから、今、作業してるフォルダがどこなのか、さえ意識していれば、
docker compose exec -it サービス名 bash
のやり方のほうが間違い(誤って別環境にログインして変更作業してしまう間違い)
がなくせるのため、よりよいのです。
追加の話(その1)
さらに、Devcontainer環境では、ホストとコンテナの所有権違いによる権限問題を回避するため
下記のようにすることをMicrosoftが推奨してます。
理由は、Linuxや、WSL2で一番最初に作る初期の作業ユーザの
UID,GID=1000:1000となることが多いからです。
ですから、そのユーザでコンテナで作業するように
VS Codeが自動ログインするようにDevcontainerの設定をしておくのです。
- UID,GIDがともに、1000:1000のユーザをコンテナに作成
- sudoコマンドが使える環境構築をする
- そのユーザをコンテナ側でsudersにパスワードなしで登録し、パスワードなしでsudoが使えるようにすること
もし、Dockerfile自体がrootユーザのみでログインする構成になっていても、
devcontainer.jsonにて、
公式で準備している
ghcr.io/devcontainers/features/common-utils
のfeatureを記述すれば、簡単に上記のような状況に追加的に環境を変更してくれます
Macユーザは、初期ユーザが500番代で作成されるとのことですが
元々、Docker for Macでは、バインドマウント時に
コンテナ側に作ったファイルや、フォルダの所有者が
rootや、UID,GID=1000:1000だろうが、なんだろうが
ホスト側で見たときに、今作業している500番代の所有者として見えるため
どっちにしろ所有権違いによる、パーミッションエラーの問題がおきないため
上記の構成でもMacユーザは困ることがありません
上記の構成だと、Linuxユーザも、WSL2ユーザも、Macユーザも誰も
困ることがないため、Microsoftは上記の構成を推奨しているのです。
追加の話(その2)
VS Codeは、Devcontainers環境で
UID,GID=1000:1000でコンテナ側に自動ログインできるように調整できますが
WSL2のUbuntuのターミナル上で、その環境に入りたい場合は、
-p プロジェクト名 を指定してログインします
たとえば、当記事の devc_rhel フォルダの環境ならば
docker compose -p devc_rhel exec --user 1000:1000 app bash -l
とします。
--user 1000:1000
は、UID,GID=1000:1000のユーザでログインするという意味です
bash -l
とすると、
コンテナ側のUID,GID=1000:1000のユーザ
これは通常、vscodeというユーザ名にすることが多いのですが
コンテナ側の /home/vscode/.bashrc など
他にも複数あったと思いますが、bashのログイン時のシェルを一通り起動してから
ログインするという意味になります
docker compose -p devc_rhel exec --user 1000:1000 app bash -l
は、長いため
devc_rhel フォルダの直下に、
login1000.sh のシェルスクリプトを作成し、
中身を
#!/bin/bash
docker compose -p devc_rhel exec --user 1000:1000 app bash -l
としておき、 ./login1000.sh と打ち込むだけで、コンテナに入れるようにしてました
ということなので、
今回、devc_rhel_2 の環境を作ったときに、
この devc_rhel_2 の環境の
login1000.sh も下記のように変更しました
#!/bin/bash
docker compose -p devc_rhel_2 exec --user 1000:1000 app bash -l
Discussion
助かりました!
自分はcloneしてきたディレクトリの名前を変えたら並列実行できました!