docker-compose.yamlのentrypoint/commandフィールドで環境変数を使いたい

Tue, 18 Apr 2023 08:30:45 +0900

はじめに

docker-compose.yaml 内で環境変数を記述する際には、その展開時期に注意しましょう。 entrypoint や command フィールドに環境変数を記述する場合には、environment フィールドでの環境変数定義を参照できないため、別途工夫が必要です。また、docker-compose up 実行時に、環境変数が「置換」される挙動については、使い方次第では不便な場合もあるため、注意が必要です。

問題点について、具体的なコードをあげて説明した後、対処法を紹介します。

検証環境

1
2
3
4
5


$ uname -moi
arm64 unknown Darwin

$ docker-compose --version
Docker Compose version v2.15.1

`docker-compose.yaml` に環境変数 `$VAR` を記述した時の挙動

docker-compose.yaml には $VAR あるいは ${VAR} の形式で環境変数を記述できます。

環境変数の展開の挙動を確認しておきます。

以下のような docker-compose.yaml ファイルを用意します。

1
2
3
4
5
6
7


version: "3"
services:
 app:
 image: bash
 environment:
 "Z": genzouw
 entrypoint: echo "$X",'$Y',"$Z"

YAML ファイルを配置しているディレクトリで、以下のコマンドを実行することで Docker Compose 内に記述されているイメージを使ってコンテナが立ち上がります。

YAMLの重複記述を減らしDRYを保つためにエイリアス機能を使う

Sat, 19 Jun 2021 08:26:26 +0900

はじめに

僕が YAML ファイルを触りだしたのは、Ansible を使い始めてからでした。

そこから Docker Composes 、 Kubernetes ともはや YAML を触ることがないシステムはない状況となりました。

AWS や GCP 、 Azure といったクラウド環境でも YAML ファイルで設定するリソースは非常に多いですし、Rest API のインターフェイス定義として OpenAPI を YAML で記述します。

YAML ファイルの重要性が高まるにつれて、ファイルの内容はどんどん肥大化する傾向にあります。同時に 1 つの YAML ファイルの中に記述する内容が重複することも多く（Kubernetes マニフェストのラベル名など）、なんとか DRY に記述できないかと悩むことがあります。

重複記述を回避するために “エイリアス” を使う

そこで有効なのが YAML の標準機能として提供されている エイリアス 機能です。

現在担当してるシステムのローカル開発環境は Docker Compose を使って構築していますが、エイリアス機能を使って docker-compose.yaml ファイルの簡素化を行っています。

それでは、エイリアス機能について見ていきましょう。

エイリアス(別名)機能とは？

YAML のエイリアス機能とは、 単一の値 か ブロック(YAML のツリー構造) のどちらかに名前をつけて、あとから参照するための仕組みになります。

エイリアス機能を利用した例

値にエイリアスを設定し、参照する

値に名前をつけるというのが最もシンプルな使い方です。

&エイリアス名 で名前をつけ、 *エイリアス名 で値を参照します。

1
2
3
4
5
6
7


hello: &hello "hello"
greeting:
 audience: "world"
 hello: *hello # 'hello' という文字列となります
new_greeting:
 audience: "room"
 hello: *hello # 'hello' という文字列となります

正しく値が参照できているかを確認するために、 yq というコマンドラインから YAML ファイルを操作するツールを使ってみます。

YAML on ゲンゾウ用ポストイット

docker-compose.yamlのentrypoint/commandフィールドで環境変数を使いたい

はじめに

検証環境

docker-compose.yaml に環境変数 $VAR を記述した時の挙動

YAMLの重複記述を減らしDRYを保つためにエイリアス機能を使う

はじめに

重複記述を回避するために “エイリアス” を使う

エイリアス(別名)機能とは？

エイリアス機能を利用した例

値にエイリアスを設定し、参照する

`docker-compose.yaml` に環境変数 `$VAR` を記述した時の挙動