DockerfileのARGとFROMの順序と変数のスコープ
Dockerfileの中のFROMとARGコマンドの位置関係について、ちょっとハマることがあったのでまとめておきます。
このあたりは、英語でも日本語でも直接的にはっきり書いてあるドキュメントがほとんどないので調べるのに時間がかかりました。
なお、実験は MacOS上の Docker version 19.03.8, build afacb8b で行っています
問題
まず、以下の例を見てみます。
# Dockerfile
ARG UBUNTU_VER
FROM ubuntu:${UBUNTU_VER}
RUN echo UBUNTU_VER=$UBUNTU_VER
$ docker build . --build-arg UBUNTU_VER=18.04 --no-cache Sending build context to Docker daemon 2.048kB Step 1/3 : ARG UBUNTU_VER Step 2/3 : FROM ubuntu:${UBUNTU_VER} ---> 4e5021d210f6 Step 3/3 : RUN echo UBUNTU_VER=$UBUNTU_VER ---> Running in b1db86ff5314 UBUNTU_VER= Removing intermediate container b1db86ff5314 ---> 212d057cc765 Successfully built 212d057cc765
冒頭に ARG で定義した UBUNTU_VER という変数を、コマンドラインから --build-arg を使って代入しています。ここで、FROM の行では正しく値が設定されて ubuntu:18.04 というイメージが使われているのに対し、３行目の RUN コマンドの行では値が代入されていません。
どういうことでしょうか？ ARG は、FROMより前に書いてはいけないのでしょうか？しかし、FROMコマンドで変数を使うためには、FROMより前にARGを書く必要があります。そもそも、FROMでは変数を使うことができているのに、その後のRUNでは空（未定義）なのはなぜでしょうか？
理由の説明
これには理由があります。まず、 FROM コマンドは、新しいステージ（build stage）を作成し、その次の行から スコープ を形成します。普通のプログラムで言う変数のスコープと同じです。また FROM より前に出現する ARG は、グローバルスコープ（globally-scoped ARG）となります。同様に、普通の関数でいうグローバル変数のようなものです。
次に、グローバルスコープの ARG は、それぞれの FROM スコープへは自動的には引き継がれません。スコープ毎に ARG コマンドを使って宣言する必要があります。また、その際にデフォルト値を変更することもできます。
ということで、それを実験するために以下のようなDockerfileをビルドしてみます。
# Dockerfile
# グローバルスコープのARG
ARG VER=18.04
FROM ubuntu:${VER} as base1
# (1) ローカルスコープARG宣言無し
RUN echo 1 VER=${VER}
FROM ubuntu:${VER} as base2
# (2) ローカルスコープのARG宣言（デフォルト値なし）
ARG VER
RUN echo 2 VER=${VER}
FROM ubuntu:${VER} as base3
# (3) ローカルスコープのARG宣言（デフォルト値あり）
ARG VER="In 3rd FROM"
RUN echo 3 VER=${VER}
FROM ubuntu:${VER} as base4
# (4) ローカルスコープのARG宣言（再びデフォルト値なし）
ARG VER
RUN echo 4 VER=${VER}
このDockerfileをビルドすると、下のようになります。（不要な部分を省略済）
Sending build context to Docker daemon 3.584kB
Step 1/12 : ARG VER=18.04
Step 2/12 : FROM ubuntu:${VER} as base1 # <-- (0)
---> 4e5021d210f6
Step 3/12 : RUN echo 1 VER=${VER}
---> Running in a954660d91fd
1 VER= # <-- (1)
Step 6/12 : RUN echo 2 VER=${VER}
---> Running in a8ac09e221dc
2 VER=18.04 # <-- (2)
Step 9/12 : RUN echo 3 VER=${VER}
---> Running in 79466895adae
3 VER=In 3rd FROM # <-- (3)
Step 12/12 : RUN echo 4 VER=${VER}
---> Running in 5ebfe419e434
4 VER=18.04 # <-- (4)
Successfully built c32c9a07c503
ここで起こっていることを整理してみます。
- まず、Dockerfileの冒頭でグローバルスコープの
VERを定義します。これにより、FROMコマンドで変数VERが使えるようになります（出力の(0)）。以降のすべてのFROMコマンドでVERが使えます。 - 次に、
FROMで作成されたスコープの中で変数宣言なしでVERを使ってみると、中身は空です（出力の(1)）。 - 新しく作った別のスコープで、デフォルト値無しで
VERを宣言します。すると、VER変数が有効になり、値はグローバルスコープの定義を引き継ぎます（出力の(2)）。 - さらに新しく作った別のスコープでデフォルト値付きで変数宣言をすると、
VERは宣言された値に設定されます（出力の `(3)）。 - また新しくスコープを作り、再び「デフォルト値なしの
ARG宣言」をしてみると、値はグローバルスコープのものになります。つまり、直前のスコープで設定した値は破棄されます。
まとめ
Dockerfileの中で FROM コマンドは新しいスコープを作り、その中で宣言された ARG は、そのローカルスコープの中のみで有効です。最初の FROM より前に宣言した ARG はグローバルスコープとなり、 FROMコマンド自体の中で使うことができますが、ローカルスコープの中では継承されません。ローカルスコープの中で変数を使いたい場合は、グローバルスコープの宣言があったとしても、再度 ARG で宣言する必要があります。また、ローカルスコープで設定した値は、他のローカルスコープには引き継がれません。
