Docker-Compose on ポンコツ地方エンジニアの技術ブログ

docker-compose のアップデート方法

Mon, 12 Sep 2022 00:00:00 +0900

apt でインストールした docker-compose のバージョンが古いので、手動でアップデートする方法です。

docker-compose のリリースビルド一覧は以下で確認できます。

https://github.com/docker/compose/releases

# 現在インストールされている docker-compose をアンインストール
sudo apt remove docker-compose
# カーネル名を小文字にするため一度変数 kernel に代入
kernel=$(uname -s)
# ダウンロード
sudo wget -O /usr/bin/docker-compose https://github.com/docker/compose/releases/download/v2.10.2/docker-compose-${kernel,,}-$(uname -m)
# 実行権限の付与
sudo chmod +x /usr/bin/docker-compose

一応これで intel 系と arm 系で上手くいくことは確認しました。

参考 URL

https://github.com/docker/compose/releases

docker-compose.yml での環境変数の参照とデフォルト値の設定

Fri, 01 Jul 2022 00:00:00 +0900

公式ドキュメントを見ていろいろ設定方法があることを知ったのでメモです。

https://docs.docker.com/compose/compose-file/#interpolation

以下、ほぼ訳しただけです。

環境変数の参照

$VARIABLE または ${VARIABLE} で参照できます。
もし VARIABLE が定義されていなければ、空文字に置換されます。

補間 (interpolation)

以下のようにして、環境変数が設定されていない場合のデフォルト値を指定できます。

${VARIABLE:-default} とすると、環境変数 VARIABLE が定義されていないか空の場合に default に置換されます。
${VARIABLE-default} とすると、環境変数 VARIABLE が定義されていない場合に default に置換されます。

同様に、以下のように必須変数を指定できます。

${VARIABLE:?err} とすると、環境変数 VARIABLE が定義されていないか空の場合にエラーとなります。
${VARIABLE?err} とすると、環境変数 VARIABLE が定義されていない場合にエラーとなります。

yaml のアンカー/エイリアス機能

以下の記事で初めて知ったのですが、x- で始まるキーを書くことで、docker-compose で無視されるようになるそうです。

https://techracho.bpsinc.jp/hachi8833/2020_02_07/87447

参考 URL

docker-compose.yml で HOSTNAME が参照できない？

Thu, 30 Jun 2022 00:00:00 +0900

docker-compose.yml で $HOSTNAME と記述すると以下のようなエラーが表示され、かなりはまってしまいました。

The HOSTNAME variable is not set. Defaulting to a blank string

Ubuntu では HOSTNAME が export されていないそうなので、環境変数として参照できないようです。
どうやらかなり昔からの仕様のようですが、Ubuntu 20.04 でも状況は変わっていません。

https://ubuntuforums.org/archive/index.php/t-898924.html

私は誤解していましたが、HOSTNAME は環境変数ではなくシェル変数です。

そして、export されていないから環境変数として yml からは参照できないと。
なので、以下のようにすれば参照できるようになります。

$ export HOSTNAME && docker-compose up

毎回 export するのが面倒な場合は .bashrc に書いておくのがいいかもしれません。

参考 URL

Docker コンテナ内から Docker コマンドを使う

Thu, 26 May 2022 00:00:00 +0900

Docker コンテナ内のアプリケーションから Docker コンテナの操作をしたかったので、やってみました。

環境

Docker 20.10.12

DinD と DooD

Docker コンテナ内から Docker を扱う方法としては以下の２つがあるようです。

DinD: Docker in Docker
- Docker コンテナの中で Docker デーモンを動かす
- コンテナの中にコンテナを作成したりできる
- 非推奨
DooD: Docker outside of Docker
- ホストの docker.sock をコンテナにマウントし、Docker デーモンを共有する
- ホスト上の Docker コンテナを操作できる
- 基本的にこちらを使う

ここらへん以下のページが分かりやすかったです。

https://qiita.com/YukiMiyatake/items/2e68aa69a5ca3921d55d

DinD は Docker の開発用途のためのものらしく、セキュリティリスクなどもあることから非推奨で、基本的には DooD のほうを使うべきだそうです。
今回の用途的にも DooD のほうなので、DooD を試してみました。

DooD サンプル

ググってみると以下のようなサンプルが多いです。

$ docker run -it -v /var/run/docker.sock:/var/run/docker.sock docker

確かにこれでコンテナ内で docker コマンドが使えました。
この場合では docker という Docker 一式が入ったイメージを使っているので、/var/run/docker.sock をマウントするだけで使えています。

しかし、実際にはアプリケーションのランタイムイメージをベースとすることが多いと思います。
試しに Ubuntu のイメージを使うと、以下のようにエラーになります。

$ docker run -it -v /var/run/docker.sock:/var/run/docker.sock ubuntu:20.04
# docker ps
bash: docker: command not found

Docker クライアントがインストールされていないからです。

この場合、コンテナ内で docker.io をインストールすれば docker コマンドが使えるようになります。
ついでに docker-compose もインストールしています。

$ sudo apt update
$ sudo apt install -y docker.io docker-compose

というわけで、DooD では

/var/run/docker.sock をマウント
ベースイメージに Docker クライアントがインストールされていなければインストール

で、コンテナ内から Docker コマンドが使えるようになります。

参考 URL

Portainer を docker-compose で動かす

Tue, 19 Apr 2022 00:00:00 +0900

Docker の GUI 管理ツールである Portainer を docker-compose で動かしてみました。

環境

Docker 20.10.7
portainer-ce 2.11

docker-compose.yml

Docker での動かし方は公式ドキュメントに記載されています。

https://docs.portainer.io/v/ce-2.11/start/install/server/docker/linux

これを docker-compose に落とし込んだのが以下です。

version: '3'
services:
 portainer:
 image: portainer/portainer-ce
 container_name: portainer
 restart: unless-stopped
 volumes:
 - /var/run/docker.sock:/var/run/docker.sock
 - portainer_data:/data
 ports:
 - 8000:8000
 - 9000:9000
 - 9443:9443
volumes:
 portainer_data:

通常 HTTPS で 9443 番ポートでアクセスしますが、HTTP でアクセスしたい場合は 9000 番ポートを使用します。
8000 番ポートは Edge コンピュート機能を使用する場合にのみ必要とありますが、使っていないので詳細はわかりません。それ以外には特筆すべき点はないかと思います。

これで http://localhost:9000 にアクセスすれば画面が表示されます。

Portainer Agent を追加する

以上で Portainer が使えるようになったのですが、Docker Volume の中が閲覧出来ませんでした。
これを有効化するには、Docker Swarm または Portainer Agent を追加する必要があるようです。

https://docs.portainer.io/user/docker/volumes/browse

Docker Swarm はまた別記事にするとして、ここでは Portainer Agent を追加します。
やり方については以下の記事が参考になりました。

https://stackoverflow.com/questions/64735377/install-portainer-portainer-agent-using-docker-compose

version: '3.2'
services:
 agent:
 image: portainer/agent
 volumes:
 - /var/run/docker.sock:/var/run/docker.sock
 - /var/lib/docker/volumes:/var/lib/docker/volumes
 portainer:
 image: portainer/portainer-ce
 command: -H tcp://agent:9001 --tlsskipverify
 ports:
 - "9000:9000"
 volumes:
 - portainer_data:/data
volumes:
 portainer_data:

これで Docker Volume の中を閲覧できるようになりました。

Docker Swarm での動かし方は別記事に書きました。

https://kuttsun.blogspot.com/2022/05/portainer-docker-swarm.html

参考 URL

docker-compose でアプリの起動を遅らせる

Mon, 08 Nov 2021 00:00:00 +0900

docker-compose.yml の depends_on はあくまでコンテナの依存関係だけであり、アプリの起動や初期化までは待ってくれません。

現在の docker-compose には condition というのがあり、コンテナの状態をチェックして起動を制御することが可能なようです。

ただ、そのために healthcheck の方法を定義しないといけないなどちょっと面倒だったので、今回は sleep を入れて無理やり起動を遅らせる方法をとりました。

sleep の入れ方ですが、以下の２つの方法を思いつきました。

command で指定する例

docker-compose.yml の command で以下のように記述します。

command: bash -c "sleep 5 && python3 sample.py"

entrypoint で指定

docker-compose.yml の entrypoint で起動時に実行するスクリプトファイルを指定し、そのスクリプトファイルの中で sleep を実行します。

entrypoint: "/hoge/entrypoint.sh"

参考 URL

docker-compose で GPU を使う

Tue, 02 Nov 2021 00:00:00 +0900

docker run では --gpus all としていたのですが、docker-compose ではどう指定すればいいのかわからなかったので調べてみました。

基本的には以下に書かれている通りです。

https://docs.docker.com/compose/gpu-support/

docker-compose では例えば以下のように記述します。

deploy:
 resources:
 reservations:
 devices:
 - capabilities: [gpu]
environment: 
 - NVIDIA_VISIBLE_DEVICES=all
 - NVIDIA_DRIVER_CAPABILITIES=all

参考 URL

docker-compose での環境変数の参照方法

Fri, 29 Oct 2021 00:00:00 +0900

docker コンテナ内でホストと同じユーザーIDを指定するために、ホストの環境変数を参照していました。

例えば、docker コンテナ内でホストと同じユーザーIDを指定するために以下のように記述していましたが、

docker run -it \
 -e LOCAL_UID=$(id -u $USER) \
 -e LOCAL_GID=$(id -g $USER) \
 hoge:0 bash

これを docker-compose.yml ではどう書けばいいのか？結果的には以下のように記述することで上手くいきました。

environment: 
 - LOCAL_UID=${id:-u ${USER}}
 - LOCAL_GID=${id:-g ${USER}}

参考 URL

https://qiita.com/reflet/items/a96752b4cd3838ea6932

Rocket.Chat で使用している MongoDB をアップグレードする

Wed, 20 Oct 2021 00:00:00 +0900

Rocket.Chat をアップグレードしたら、MongoDB をアップグレードするように警告が表示されるようになったので、MongoDB もアップグレードしました。

アップグレードについては、以下の記事が参考になりました。

https://linuxhandbook.com/mongodb-upgrade-rocket-chat/

環境

アップグレード前

Rocket.Chat 3.10.4
MongoDB 4.0.22

アップグレード後

Rocket.Chat 4.0.3
MongoDB 5.0.3

やったこと

Rocket.Chat を 4.0.3 にアップグレード

3.10.4 から 4.0.3 へのアップグレードはバージョンを変更するだけでいけました。

docker コンテナ停止
docker-compose.yml の Rocket.Chat のバージョンを 4.0.3 に変更
docker コンテナ起動

この時点で Rocket.Chat 4.0.3、MongoDB 4.0.22 の組み合わせとなりましたが、以下のメッセージが表示されるようになりました。

rocketchat_1 | +----------------------------------------------+
rocketchat_1 | | SERVER RUNNING |
rocketchat_1 | +----------------------------------------------+
rocketchat_1 | | |
rocketchat_1 | | Rocket.Chat Version: 4.0.3 |
rocketchat_1 | | NodeJS Version: 12.22.1 - x64 |
rocketchat_1 | | MongoDB Version: 4.0.27 |
rocketchat_1 | | MongoDB Engine: wiredTiger |
rocketchat_1 | | Platform: linux |
rocketchat_1 | | Process Port: 3000 |
rocketchat_1 | | Site URL: http://localhost:3000 |
rocketchat_1 | | ReplicaSet OpLog: Enabled |
rocketchat_1 | | Commit Hash: 6e49fc9466 |
rocketchat_1 | | Commit Branch: HEAD |
rocketchat_1 | | |
rocketchat_1 | +----------------------------------------------+
rocketchat_1 | +----------------------------------------------------------------------+
rocketchat_1 | | DEPRECATION |
rocketchat_1 | +----------------------------------------------------------------------+
rocketchat_1 | | |
rocketchat_1 | | YOUR CURRENT MONGODB VERSION (4.0.22) IS DEPRECATED. |
rocketchat_1 | | IT WILL NOT BE SUPPORTED ON ROCKET.CHAT VERSION 5.0.0 AND GREATER, |
rocketchat_1 | | PLEASE UPGRADE MONGODB TO VERSION 4.2 OR GREATER |
rocketchat_1 | | |
rocketchat_1 | +----------------------------------------------------------------------+

MongoDB version 4.0.22 is deprecated, please upgrade your installation.

MongoDB 4.0 は非推奨なので、4.2 以上へアップグレードするよう促されます。
なので、ついでに最新の 5.0 までアップグレードします。

MongoDB を 4.2 にアップグレード

4.0 から 4.2 へのアップグレードは docker-compose.yml を修正して再起動するだけでいけました。

docker コンテナ停止
docker-compose.yml の MongoDB のバージョンを 4.0 に変更
docker コンテナ起動

MongoDB を 4.4 にアップグレード

4.2 から 4.4 へのアップグレードは docker-compose.yml を修正して再起動するだけではだめでした。
先に以下のコマンドを実行する必要があります。

$ docker exec mongo bash -c 'mongo --eval "db.adminCommand( { setFeatureCompatibilityVersion: \"4.2\" } )"'`

流れとしては以下です。

上記のコマンドを実行
docker コンテナ停止
docker-compose.yml の MongoDB のバージョンを 4.4 に変更
docker コンテナ起動

MongoDB を 5.0 にアップグレード

先ほどと同じです。
上記のコマンドのバージョンを 4.4 に変更して実行します

$ docker exec mongo bash -c 'mongo --eval "db.adminCommand( { setFeatureCompatibilityVersion: \"4.4\" } )"'`

流れとしては以下です。

上記のコマンドを実行
docker コンテナ停止
docker-compose.yml の MongoDB のバージョンを 5.0 に変更
docker コンテナ起動

参考 URL

https://linuxhandbook.com/mongodb-upgrade-rocket-chat/

Grafana のダッシュボードをログインなしで閲覧できるようにする

Fri, 11 Jun 2021 00:00:00 +0900

タイトルの通りです。

Grafana には一応 Snapshot という機能がありますが、日時の範囲が固定で、範囲を変えても範囲外のデータは閲覧できなかったりと、その名の通りあくまでスナップショットです。

なので、ログインしなくてもダッシュボードの閲覧だけは出来るように設定します。

環境

docker および docker-compose を使って構築しています。

Grafana v7.5.7

設定

設定方法は grafana.ini を編集するか、環境変数を設定するかのどちらかで行います。

今回は docker-compose.yml で環境変数を設定しました。

GF_AUTH_ANONYMOUS_ENABLED を true に設定すれば、ログインなしでもダッシュボードの閲覧ができるようになります。

以下、設定例です。

version: '3.1'
services:
 influxdb:
 container_name: influxdb
 image: influxdb:1.8.6
 ports:
 - "8086:8086"
 volumes:
 - influxdb:/var/lib/influxdb
 grafana:
 container_name: grafana
 image: grafana/grafana
 links:
 - influxdb
 ports:
 - "3000:3000"
 environment:
 - GF_AUTH_ANONYMOUS_ENABLED=true
 volumes:
 - grafana:/var/lib/grafana
volumes:
 influxdb:
 grafana:

尚、環境変数の一覧は Grafana の Server Admin > Settings で確認できます。