「alpine」の記事 - Crieit

Docker run の起動時に任意コードを実行後 bash や ash を終了しない

2022-12-29T16:47:37+09:00

この記事は、 Docker Advent Calendar 2022 の 23日目の記事だ。
空いていたので埋めちゃうよ。

この記事では、 bash や ash で任意のコードの実行後、ターミナルを終了せずに入力待ちにする方法について紹介する。
特に、 docker run の実行後に、その環境を維持したまま入力待ちにすることを考える。

例えば、 Windows コマンドプロンプトや PowerShell であれば、 CMD /K *** オプションや、 -NoExit -Command *** オプションで実現できるような内容だ。

本来なら、 docker build にてその任意コードの実行後の内容をイメージにするべきだが、わざわざ build するまでもないとか、 build できない事情などもあるかもしれない。

ということで、 bash の場合と、 alpine などで使われる BusyBox ash それぞれについて、 docker run 実行時に任意コード実行後、ターミナルの入力待ちにする方法を紹介する。

bash の場合

bash の場合、 --rcfile オプションにて、起動時に実行するコマンドを指定できる。

ただし、 --rcfile はファイルを指定する必要があるため、替わりにプロセス置換で実行コードを与えてやる方法をとる。

user@hostmachine:~$ docker run --rm -it debian:bullseye bash -c "bash --rcfile <(echo 'ls && export '\''FOO=B A R'\'' && MY_TIME=\$(date)')"
bin   dev  home  lib64  mnt  proc  run   srv  tmp  var
boot  etc  lib   media  opt  root  sbin  sys  usr
root@container:/# echo $FOO : $MY_TIME
B A R : Thu Dec 22 15:00:00 UTC 2022
root@container:/#

プロセス置換はコンテナ内で実行される必要があるため、一旦 bash -c にてコンテナ内で bash 実行させ、その中で改めて --rcfile オプションを指定した bash を起動する流れとなる。

実際に実行したいコマンドは、 echo で文字列として書き出す。
上記例では、 ls && export 'FOO=B A R' && MY_TIME=$(date) と言う文字列を echo させている。

引用符が二重三重になっていて、エスケープが非常に難しくなっているので注意。

BusyBox ash

alpine 3.15 以降に含まれる BusyBox の ash であれば、意外にもプロセス置換が使える。

しかし、 --rcfile に相当するオプションは残念ながら無い。
替わりに、 ash には ENV という環境変数に記載されたファイルを ash 起動時に実行する機能がある。

これを使おう。

user@hostmachine:~$ docker run --rm -it alpine:3.15 ash -c "ash -c 'export ENV=\$1;ash' -s <(echo 'ls && export '\''FOO=B A R'\'' && MY_TIME=\$(date)')"
bin    etc    lib    mnt    proc   run    srv    tmp    var
dev    home   media  opt    root   sbin   sys    usr
/ # echo $FOO : $MY_TIME
B A R : Thu Dec 22 15:00:00 UTC 2022
/ #

ash の -c のコマンドに対して引数を与える -s オプションを使ってプロセス置換のファイルを与え、それを $1 経由で ENV 環境変数にセット。その状態で再度 ash を起動させれば、 bash と同様のことが行える。

ENV 環境変数に直接プロセス置換のファイルを指定せず、わざわざ一旦引数を経由させているのは、入力を受け付ける ash プロセスが動いている間、プロセス置換のファイルにアクセス可能にする必要があるためだ。
例えば、 export ENV=<(echo 'command');ash と実行しても、 ash 実行の段階ではプロセス置換のファイルが閉じられているので、コマンドは実行されない。

もうちょっと複雑な例

起動時に apt パッケージマネージャーのリポジトリを書き換える方法（Ubuntu）:

docker run --rm -it ubuntu:22.04 bash -c "bash --rcfile <(echo 'sed -i -E '\''s%^(deb(-src|)\s+)https?://(archive|security)\.ubuntu\.com/ubuntu/%\1http://srv2.ftp.ne.jp/Linux/packages/ubuntu/archive/%'\'' /etc/apt/sources.list && apt update && FooBar=`date -uIs`')"

起動時に apk パッケージマネージャーのリポジトリを書き換える方法（Alpine）:

docker run --rm -it alpine:3.15 ash -c "ash -c 'export ENV=\$1;ash' -s <(echo 'sed -i -E '\''s%^https?://dl-cdn\.alpinelinux\.org/alpine/%https://ftp.udx.icscoe.jp/Linux/alpine/%'\'' /etc/apk/repositories && apk update && FooBar=`date -uIs`')"

参考: https://stackoverflow.com/questions/74094552/how-not-to-terminate-after-carried-out-commands-in-bash

Docker の php:7-alpine イメージで Composer と Xdebug を使えるようにする

2022-05-10T22:39:48+09:00

経緯

slimphp/Slim-Skeleton を利用したいと考えました。

手元の端末で開発しようとしたところ、 XAMPP に Xdebug を入れ忘れていたことに気付きました。しかも、 XAMPP の PHP のバージョンで Xdebug のインストールが止まってしまいました。

そこで、スケルトンプロジェクトに付随している Docker Compose での開発を試みましたが、この Docker Compose 内で pull してくるイメージは Composer も Xdebug もないので入れることにしました。

コード

ディレクトリ構造

root/
    ├ _docker/                               // Dockerに関する設定置き場
    │    ├ dockerfiles/
    │    │    ├ settings/
    │    │    │    └ php.ini                 // PHPの設定 (Xdebug 有効化)
    │    │    │
    │    │    └ Dockerfile
    │    │
    │    ├ mysql/                            // MariaDB 用ディレクトリ
    │    │    └ .gitkeep
    │    │
    │    └ phpmyadmin/
    │         ├ conf/
    │         │    └ phpmyadmin-misc.ini     // phpMyAdmin の設定 (メモリ上限など)
    │         │
    │         └ sessions/
    │              └ .gitkeep
    │
    └ docker-compose.yml

Docker に関する部分のみ列挙。

docker-compose.yml

version: '3.7'

volumes:
    logs:
        driver: local

services:
    slim:
        build:
            context: ./_docker/dockerfiles/
            dockerfile: Dockerfile
        working_dir: /var/www
        command: php -S 0.0.0.0:8080 -t public
        environment:
            docker: "true"
        ports:
            - 8080:8080
        volumes:
            - .:/var/www
            - ./logs:/var/www/logs
    db:
        image: mariadb
        restart: always
        ports:
            - 3306:3306
        volumes:
            - ./_docker/mysql/mysql:/var/lib/mysql
            - ./_docker/mysql/initdb.d:/docker-entrypoint-initdb.d
        environment:
            - MYSQL_ROOT_PASSWORD=pwd
            - MYSQL_DATABASE=test
            - MYSQL_USER=user
            - MYSQL_PASSWORD=pwd
    phpmyadmin:
        image: phpmyadmin/phpmyadmin
        volumes:
            - ./_docker/phpmyadmin/sessions:/sessions
            - ./_docker/phpmyadmin/conf/phpmyadmin-misc.ini:/usr/local/etc/php/conf.d/phpmyadmin-misc.ini
        environment:
            - PMA_ARBITRARY=1
            - PMA_HOST=db
            - PMA_USER=user
            - PMA_PASSWORD=pwd
        ports:
            - 8081:80

変更点は以下。

PHP 用環境: Dockerfile を使ったイメージにカスタマイズ
DB: MariaDB のイメージをそのまま利用
- environment のパラメータはそのまま使用。アプリケーションや phpMyAdmin 側と動機は取れていないですがひとまずはこれで……
phpMyAdmin: これも phpMyAdmin 公式イメージを流用

_docker/dockerfiles/Dockerfile

FROM php:7-alpine
RUN apk --update add curl
RUN set -ex \
  && apk --no-cache add \
  autoconf build-base
RUN pecl install xdebug
RUN docker-php-ext-enable xdebug
RUN docker-php-ext-install pdo_mysql
COPY settings/php.ini /usr/local/etc/php/conf.d
RUN curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/bin --filename=composer

php:7-alpine をベースに Xdebug と Composer を追加。

_docker/dockerfiles/settings/php.ini

xdebug.mode=coverage

Xdebug でカバレッジを有効化するための設定を追加するため。なお、 Dockerfile で COPY する際のホストマシンでのパスは Dockerfile の存在するディレクトリから下でないと参照できない という地味な制約があるので dockerfiles ディレクトリをわざわざ掘りました。

_docker/phpmyadmin/conf/phpmyadmin-misc.ini

allow_url_fopen = Off
max_execution_time = 600
memory_limit = 64M
post_max_size = 64M
upload_max_filesize = 64M

メモリ上限等のカスタマイズ。

これで今回はカバレッジ出力まで動作することを確認しました。

参考

Xdebug

PHPUnitでHTMLコードカバレッジを出すまで(Docker使用) - Qiita

Warning: XDEBUG_MODE=coverage or xdebug.mode=coverage has to be set

が出たので step3 について実施。

なお、今回のケースでは

extension=xdebug.so

は不要だった。

Dockerfile

Dockerで作るNginx + PHP7 + Xdebug環境 | Crudzoo

ほぼこれでOK.

php-alpineコンテナにxdebugをインストールする時にハマったメモ - Qiita

こちらも参照。 php -v で with Xdebug と付いていればOK。

Dockerfile の COPY

【Docker】COPYで指定されたファイルは、Dockerfileが存在するディレクトリからの相対パスで、親ディレクトリを見れない - タカの技術ノート

Mariadb

could not find driver

普通に考えたら確かにドライバがないので追加して解決。

シェル

dockerでalpine linux ベースのcontainerに入って、shellを使いたいとき。 - Qiita

bash ではなく ash 。 bin/ash 指定。

sr -c

docker-compose.ymlのcommandプロパティに複数コマンドを設定する方法 | ゲンゾウ用ポストイット

最終的には使わずに済みましたが念のためメモ。

Github で特定ユーザの publicリポジトリの名前の一覧を生成する Docker Compose

2021-07-11T01:08:30+09:00

経緯

自分のあるリポジトリを clone しようとして、名前を失念。探すのに手間取ったのでリポジトリの名前の一覧を生成するスクリプトが欲しくなりました。

調査

調べたら Linuxコマンドでどうにかなりそうだったので、 Docker で Linux環境を用意してごにょごにょしよう、と思い立ちました。

成果物

GitHub - arm-band/docker_list_of_hirokawa: Github の特定ユーザの public リポジトリの一覧を生成する Docker Compose 設定集。

構成

ディレクトリ構造

PROJECT_ROOT/
    ├ docker/
    │   └ Dockerfile
    │
    ├ entrypoint/
    │   └ entrypoint.sh
    │
    ├ template/
    │   └ script.sh       // コンテナ内で実行したいスクリプトのテンプレート。一部変数をエントリポイントで置換
    │
    ├ workspace/          // リポジトリ名一覧のテキストファイルのダンプ先
    │
    ├ .env                // docker-compose.yml 用の環境変数
    └ docker-compose.yml

今回はこんなディレクトリ構造に。

docker-compose.yml

version: '3.8'
services:
    hirokawa:
        build:
            context: ./docker
            dockerfile: Dockerfile
            args:
                USER_NAME: $USER_NAME
                FILE_NAME: $FILE_NAME
        volumes:
            # entrypoint
            - ./entrypoint:/entrypoint
            # workspace
            - ./workspace:/workspace
            # docker settings template
            - ./template:/template
        tty: true
        entrypoint: /bin/sh -c "/bin/sh /entrypoint/entrypoint.sh $USER_NAME $FILE_NAME && /bin/sh"

リポジトリ名の一覧を取得したい対象ユーザ名とダンプ先ファイル名を .env で指定しています。

.env

USER_NAME=saigyo
FILE_NAME=repository_list.txt

上述の通り。

docker/Dockerfile

FROM alpine:latest
RUN apk update && \
    apk upgrade && \
    apk add --no-cache \
    jq \
    bash \
    sed \
    curl
RUN mkdir /var/script
RUN chmod 777 /var/script

必要なパッケージのインストールとスクリプトの生成先のディレクトリの作成。

今回はやることが最小限なので alpine を使用。

entrypoint/entrypoint.sh

sed -e "s/USER_NAME/${1}/gi" -e "s/FILE_NAME/${2}/gi" /template/script.sh > /var/script/script.sh

一部変数名を .env の値で置換。一行しかないので command でも良かったかも。

template/script.sh

for page in $(seq 1 10);
    do result=$(curl -s "https://api.github.com/users/USER_NAME/repos?page=$page&per_page=100"|jq -c '[.[] .name]'|jq -c '.[]');
    if [ -z "$result" ];
        then break;
    fi;
    formatted_result=$(echo "$result"|sed -e "s/\"//gi");
    echo "$formatted_result" > "/workspace/FILE_NAME";
done

実行するスクリプトのテンプレート。個人ユーザ対象で curl で Github API を叩いて100個(指定可能な最大数)ずつ出力、 jq でフィルタリングして、 workspace にファイルとしてダンプ。

これでやりたいことは実現できました。

jq play

alpine で bash

【docker alpine linux】でbashの使用方法 - Qiita

starting container process caused: exec: "bash": executable file not found in $PATH: unknown

プログラマーの雑記: docker コンテナにログイン時に、「executable file not found in $PATH」エラーの対応

alpineイメージへの entrypoint 指定

【Docker】ENTRYPOINT と CMD の仕組みと小技 – 株式会社シーポイントラボ｜浜松のシステム・RTK-GNSS開発

「alpine」の記事 - Crieit

Docker run の起動時に任意コードを実行後 bash や ash を終了しない

Docker の php:7-alpine イメージで Composer と Xdebug を使えるようにする

Github で特定ユーザの publicリポジトリ の名前の一覧を生成する Docker Compose

Github で特定ユーザの publicリポジトリの名前の一覧を生成する Docker Compose