サービスコンテナについて

サービスコンテナについて

サービスコンテナは、ワークフロー中でアプリケーションをテストもしくは運用するのに必要になるかもしれないサービスをホストするための、シンプルでポータブルな方法を提供するDockerコンテナです。 たとえば、ワークフローでデータベースやメモリキャッシュへのアクセスを必要とする結合テストを実行する必要があるかもしれません。

サービスコンテナは、ワークフロー中のそれぞれのジョブに対して設定できます。 GitHubは新しいDockerコンテナをワークフロー中で設定された各サービスに対して作成し、ジョブが完了したときにそのサービスコンテナを� �棄します。 ジョブ中のステップは、同じジョブの一部であるすべてのサービスコンテナと通信できます。 However, you cannot create and use service containers inside a composite action.

サービスコンテナとの通信

ワークフロー中のジョブは、直接ランナーマシン上で実行するようにも、Dockerコンテナ中で実行するようにも設定できます。 ジョブと、ジョブのサービスコンテナとの通信は、ジョブがランナーマシン上で直接実行されているか、コンテナ内で実行されているかによって異なります。

コンテナ内でのジョブの実行

コンテナ内でジョブを実行する� �合、GitHubはDockerのユーザー定義ブリッジネットワークを使ってサービスコンテナをジョブに接続します。 詳しい情� �についてはDockerのドキュメンテーションの「ブリッジネットワークの利用」を参照してく� さい。

コンテナ内でジョブとサービスを実行すれば、ネットワークアクセスはシンプルになります。 サービスコンテナへは、ワークフロー中で設定したラベルを使ってアクセスできます。 サービスコンテナのホスト名は、自動的にラベル名にマップされます。 たとえばredisというラベルでサービスコンテナを作成したなら、そのサービスコンテナのホスト名はredisになります。

サービスコンテナでポートを設定する必要はありません。 デフォルトで、すべてのコンテナは同じDockerネットワークの一部となってお互いにすべてのポートを公開し合い、Dockerネットワークの外部へはポートは公開されません。

ランナーマシン上でのジョブの実行

ジョブをランナーマシン上で直接実行する� �合、サービスコンテナにはlocalhost:<port>もしくは127.0.0.1:<port>を使ってアクセスできます。 GitHubは、サービスコンテナからDockerホストへの通信を可能にするよう、コンテナネットワークを設定します。

ジョブがランナーマシン上で直接実行されている� �合、Dockerコンテナ内で実行されているサービスは、ランナー上で実行しているジョブに対してデフォルトではポートを公開しません。 サービスコンテナ上のポートは、Dockerホストに対してマップする必要があります。 詳しい情� �については「Dockerホストとサービスコンテナのポートのマッピング」を参照してく� さい。

サービスコンテナの作成

servicesキーワードを使って、ワークフロー内のジョブの一部であるサービスコンテナを作成できます。 詳しい情� �についてはjobs.<job_id>.servicesを参照してく� さい。

以下の例は、container-jobというジョブの中にredisというサービスを作成します。 The Docker host in this example is the node:16-bullseye container.

name: Redis container example
on: push

jobs:
  # Label of the container job
  container-job:
    # Containers must run in Linux based operating systems
    runs-on: ubuntu-latest
    # Docker Hub image that `container-job` executes in
    container: node:16-bullseye

    # Service containers to run with `container-job`
    services:
      # Label used to access the service container
      redis:
        # Docker Hub image
        image: redis

Dockerホストとサービスコンテナのポートのマッピング

ジョブがDockerコンテナ内で実行されるなら、ポートをホストあるいはサービスコンテナにマップする必要はありません。 ジョブがランナーマシン上で直接実行されるなら、必要なサービスコンテナのポートはホストランナーマシンのポートにマップしなければなりません。

サービスコンテナのポートは、portsキーワードを使ってDockerホストにマップできます。 詳しい情� �についてはjobs.<job_id>.servicesを参照してく� さい。

portsキーワードを使ってポートをマップする� �合、GitHubは--publishコマンドを使ってコンテナのポートをDockerホストに公開します。 詳しい情� �についてはDockerのドキュメンテーションの「Dockerコンテナのネットワーキング」を参照してく� さい。

Dockerホストのポートを指定して、コンテナのポートを指定しなかった� �合、コンテナのポートは空いているポートにランダ� に割り当てられます。 GitHubは割り当てられたコンテナのポートをサービスコンテナのコンテキストに設定します。 たとえばredisサービスコンテナに対し、Dockerホストのポート5432を設定したなら、対応するコンテナのポートにはjob.services.redis.ports[5432]コンテキストを使ってアクセスできます。 詳細については、「コンテキスト」を参照してく� さい。

Redisのポートのマッピングの例

以下の例は、サービスコンテナredisのポート6379を、Dockerホストのポート6379にマップします。

name: Redis Service Example
on: push

jobs:
  # コンテナジョブのラベル
  runner-job:
    # サービスコンテナもしくはコンテナジョブの利用の際はLinux環境を使わなければならない
    runs-on: ubuntu-latest

    # `runner-job`と実行するサービスコンテナ
    services:
      # サービスコンテナへのアクセスに使われるラベル
      redis:
        # Docker Hubイメージ
        image: redis
        #
        ports:
          # ホストとサービスコンテナのTCPポート6379をオープンする
          - 6379:6379

参考リンク

• Redisサービスコンテナの作成
• PostgreSQLサービスコンテナの作成