アンバサダを経由したリンク

はじめに

サービスの利用者とプロバイダ間をネットワーク・リンクで固定するよりも、サービスのポータビリティを Docker は推奨します。

(利用者) --> (redis)

利用者 が別の redis サービスに接続するには再起動が必用です。そこで、アンバサダ(「ambassador」=大使、使節の意味 )を追加できます。

(利用者) --> (redis-ambassador) --> (redis)
(利用者) --> (redis-ambassador) ---network---> (redis-ambassador) --> (redis)

利用者が別の Redis サーバに通信するよう書き換える必要がある時、コンテナを接続する redis-ambassador しか再起動が不要です。

このパターンは利用者を別の docker ホスト上に対し、透過的に移動させるのにも使えます。

svendowideit/ambassador コンテナを使い、 docker run パラメータで全体を制御するリンクを追加してみましょう。

2つのホスト例

Docker ホスト上で実際の Redis サーバを開始します。

big-server $ docker run -d --name redis crosbymichael/redis

それから Redis サーバにリンクしてポートを公開するアンバサダを追加します。

big-server $ docker run -d --link redis:redis --name redis_ambassador -p 6379:6379 svendowideit/ambassador

別のホスト上で、更にアンバサダをセットアップできます。ここではプロキシしたい big-server のリモート・ポートを環境変数に設定します。

client-server $ docker run -d --name redis_ambassador --expose 6379 -e REDIS_PORT_6379_TCP=tcp://192.168.1.52:6379 svendowideit/ambassador

それから client-server ホスト上で Redis クライアント・コンテナがリモートの Redis サーバに通信できるようにするため、ローカルの Redis アンバサダにリンクします。

client-server $ docker run -i -t --rm --link redis_ambassador:redis relateiq/redis-cli
redis 172.17.0.160:6379> ping
PONG

動作内容

以下の例で、 svendowideit/ambassador コンテナが自動的に(多少の sed の力を使い)何を行っているか見ていきましょう。

Docker ホスト(192.168.1.52)上では Redis が実行されています。

# 実際の redis サーバを起動
$ docker run -d --name redis crosbymichael/redis

# 接続テスト用の redis-cli コンテナを取得
$ docker pull relateiq/redis-cli

# redis サーバと直接通信してテスト
$ docker run -t -i --rm --link redis:redis relateiq/redis-cli
redis 172.17.0.136:6379> ping
PONG
^D

# redis アンバサダを追加
$ docker run -t -i --link redis:redis --name redis_ambassador -p 6379:6379 alpine:3.2 sh

redis_ambassador コンテナ内では、リンクされた Redis コンテナの状態を env で確認できます。

/ # env
REDIS_PORT=tcp://172.17.0.136:6379
REDIS_PORT_6379_TCP_ADDR=172.17.0.136
REDIS_NAME=/redis_ambassador/redis
HOSTNAME=19d7adf4705e
SHLVL=1
HOME=/root
REDIS_PORT_6379_TCP_PORT=6379
REDIS_PORT_6379_TCP_PROTO=tcp
REDIS_PORT_6379_TCP=tcp://172.17.0.136:6379
TERM=xterm
PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
PWD=/
/ # exit

この環境変数は、アンバサダの socat スクリプトが Redis を公開するために使います( -p 6379:6369 でポートを割り当てます )。

$ docker rm redis_ambassador
$ CMD="apk update && apk add socat && sh"
$ docker run -t -i --link redis:redis --name redis_ambassador -p 6379:6379 alpine:3.2 sh -c "$CMD"
[...]
/ # socat -t 100000000 TCP4-LISTEN:6379,fork,reuseaddr TCP4:172.17.0.136:6379

次は Redis サーバにアンバサダ経由で ping します。

次は別のサーバに移動します。

$ CMD="apk update && apk add socat && sh"
$ docker run -t -i --expose 6379 --name redis_ambassador alpine:3.2 sh -c "$CMD"
[...]
/ # socat -t 100000000 TCP4-LISTEN:6379,fork,reuseaddr TCP4:192.168.1.52:6379

redis-cli イメージを取得し、アンバサダ・ブリッジを経由して通信します。

$ docker pull relateiq/redis-cli
$ docker run -i -t --rm --link redis_ambassador:redis relateiq/redis-cli
redis 172.17.0.160:6379> ping
PONG

svendowideit/ambassador Dockerfile

svendowideit/ambassador イメージは socat がインストールされた alpine:3.2 イメージをベースとしています。コンテナを実行すると、小さな sed スクリプトが(利用可能な複数の)リンク環境変数をポート転送用に使います。リモートホストであれば、コマンドラインのオプション実行に -e で環境変数を指定する必要があります。

--expose 1234 -e REDIS_PORT_1234_TCP=tcp://192.168.1.52:6379

ローカルの 1234 ポートをリモートの IP とポートに転送します。この例では 192.168.1.52:6379 です。

#
# do
#   docker build -t svendowideit/ambassador .
# then to run it (on the host that has the real backend on it)
#   docker run -t -i -link redis:redis -name redis_ambassador -p 6379:6379 svendowideit/ambassador
# on the remote host, you can set up another ambassador
#    docker run -t -i -name redis_ambassador -expose 6379 -e REDIS_PORT_6379_TCP=tcp://192.168.1.52:6379 svendowideit/ambassador sh
# you can read more about this process at https://docs.docker.com/articles/ambassador_pattern_linking/

# use alpine because its a minimal image with a package manager.
# prettymuch all that is needed is a container that has a functioning env and socat (or equivalent)
FROM    alpine:3.2
MAINTAINER  SvenDowideit@home.org.au

RUN apk update && \
    apk add socat && \
    rm -r /var/cache/

CMD env | grep _TCP= | sed 's/.*_PORT_\([0-9]*\)_TCP=tcp:\/\/\(.*\):\(.*\)/socat -t 100000000 TCP4-LISTEN:\1,fork,reuseaddr TCP4:\2:\3 \&/' && echo wait) | sh