ドキュメント
circleci.com
Start Building for Free

Docker コマンドの実行手順

3 weeks ago1 min read
クラウド
Server v3.x
Server v2.x
On This Page

このページでは、デプロイやテストを行う Docker イメージをビルドする方法について説明します。 このページの Docker 実行環境を使った例では、リモート Docker 環境でサービスを開始する方法を紹介します。

概要

Docker 実行環境でデプロイする Docker イメージをビルドするには、セキュリティのために各ビルドに独立した環境を作成する、特別な setup_remote_docker キーを使用する必要があります。 この環境は、リモートで完全に隔離され、Docker コマンドを実行するように設定されています。 ジョブで docker コマンドや docker-compose コマンドが必要な場合は、.circleci/config.ymlsetup_remote_docker ステップを追加します。

jobs:
  build:
    docker:
      - image: cimg/base:2022.06
    steps:
      # ... steps for building/testing app ...
      - setup_remote_docker:
        version: 20.10.14

setup_remote_docker が実行されるとリモート環境が作成され、現在の プライマリコンテナは、そのリモート環境を使用するように設定されます。 これにより、使用するすべての Docker 関連コマンドが、この新しい環境で安全に実行されるようになります。

注: setup_remote_docker キーは、プライマリ Executor を Docker コンテナとするよう指定した設定ファイルで使用することが想定されています。 Executor が machine または macos の場合 (および設定ファイルで Docker コマンドを使用する場合)、setup_remote_docker キーを使用する必要はありません

仕様

リモート Docker 環境の技術仕様は以下のとおりです (CircleCI Server をお使いの場合は、システム管理者にお問い合わせください)。

CPU 数プロセッサーRAMHD
2Intel(R) Xeon(R) @ 2.3GHz8 GB100GB

Machine Executor を使った Docker コマンドの実行

以下の例では、machine Executor を使って、デフォルトのイメージで Docker イメージをビルドする方法を示しています。この場合、リモートDocker を使用する必要はありません。

version: 2.1

jobs:
 build:
   machine:
    image: ubuntu-2204:2022.04.2
   steps:
     - checkout
     # start proprietary DB using private Docker image
     # with credentials stored in the UI
     - run: |
         echo "$DOCKER_PASS" | docker login --username $DOCKER_USER --password-stdin
         docker run -d --name db company/proprietary-db:1.2.3

     # build the application image
     - run: docker build -t company/app:$CIRCLE_BRANCH .


     # イメージをデプロイします。
     - run: docker push company/app:$CIRCLE_BRANCH

Docker Executor を使った Docker コマンドの実行

以下では、リモート Docker で Docker Executor を使用して Docker デモプロジェクト用の Docker イメージをビルドし、デプロイする例を紹介します。

version: 2.1
jobs:
  build:
    docker:
      - image: cimg/go:1.17
        auth:
          username: mydockerhub-user
          password: $DOCKERHUB_PASSWORD  # context / project UI env-var reference
    steps:
      - checkout
      # ... steps for building/testing app ...

      - setup_remote_docker:
          version: 20.10.14
          docker_layer_caching: true

      # build and push Docker image
      - run: |
          TAG=0.1.$CIRCLE_BUILD_NUM
          docker build -t CircleCI-Public/circleci-demo-docker:$TAG .
          echo $DOCKER_PASS | docker login -u $DOCKER_USER --password-stdin
          docker push CircleCI-Public/circleci-demo-docker:$TAG

ビルド中に何が行われているのか詳しく見てみましょう。

  1. すべてのコマンドが プライマリコンテナで実行されます。 (5 行目)
  2. setup_remote_docker が呼び出されると、新しいリモート環境が作成され、それを使用するようにプライマリコンテナが設定されます。 Docker 関連のコマンドもすべてプライマリコンテナで実行されますが、イメージのビルドおよびプッシュとコンテナの実行はリモート Docker エンジン内で行われます。 (10 行目)
  3. ここで Docker レイヤーキャッシュ (DLC) を有効化し、イメージのビルドを高速化します。
  4. プロジェクト環境変数を使用して、Docker ハブ の認証情報を格納します。 (17 行目)

注: Docker Executor 用の CircleCI ビルド済み Docker イメージ には、Docker CLI がプリインストールされています。 Docker CLI がインストールされていないサードパーティーのイメージをプライマリコンテナで使用する場合は、docker コマンドを実行する前に、ジョブの一部として Docker CLI をインストールする必要があります。

      # Alpine ベースのイメージに APK でインストールします。
      - run:
          name: Docker クライアントのインストール
          command: apk add docker-cli

リモート Docker の Docker バージョンの指定

ジョブで特定の Docker バージョンが必要な場合は、version 属性でバージョンを設定できます。

      - setup_remote_docker:
        version: 20.10.11

CircleCI は複数の Docker バージョンをサポートしています。 サポートされているバージョンは以下のとおりです。

  • 20.10.14
  • 20.10.12
  • 20.10.11
  • 20.10.7
  • 20.10.6
  • 20.10.2
  • 19.03.13
  • 17.09.0-ce (デフォルト)

注: version キーは、現在 CircleCI サーバー環境ではサポートされていません。 リモート環境にインストールされている Docker のバージョンについては、システム管理者に問い合わせてください。

環境の分離

ジョブと リモート Docker は、独立した環境で実行されます。 したがって、ジョブ実行用に指定している Docker コンテナは、リモート Docker で実行されているコンテナと直接やり取りできません。

サービスへのアクセス

リモート Docker でサービスを開始してプライマリコンテナから直接 ping することや、リモート Docker 内のサービスに ping できるプライマリコンテナを開始することはできません。 実行するには、リモート Docker から同じコンテナを通してサービスとやり取りをする必要があります。

#...
      - run:
          name: "サービスの開始および実行チェック"
          command: |
            docker run -d --name my-app my-app
            docker exec my-app curl --retry 10 --retry-connrefused http://localhost:8080
#...

同じネットワーク内で動作する別のコンテナをターゲットコンテナとして使用する方法もあります。

#...
      - run: |
          docker run -d --name my-app my-app
          docker run --network container:my-app appropriate/curl --retry 10 --retry-connrefused http://localhost:8080
#...

フォルダーのマウント

ジョブ空間からリモート Docker 内のコンテナにボリュームをマウントすること (およびその逆) はできませんdocker cp コマンドを使用して、この 2 つの環境間でファイルを転送することは可能です。 たとえば以下のように、ソースコードから設定ファイルを使用してリモート Docker でコンテナを開始します。

- run: |
    # 設定ファイルとボリュームを保持するダミー コンテナを作成します。
    docker create -v /cfg --name configs alpine:3.4 /bin/true
    # このボリュームに設定ファイルをコピーします。
    docker cp path/in/your/source/code/app_config.yml configs:/cfg
    # このボリュームを使用してアプリケーション コンテナを開始します。
    docker run --volumes-from configs app-image:1.2.3

同様に、保存する必要があるアーティファクトをアプリケーションが生成する場合は、以下のようにリモート Docker からコピーできます。

run: |
  # アプリケーションとコンテナを開始します。
  # <code>--rm</code> オプションは使用しません (使用すると、終了時にコンテナが強制終了されます)。
  docker run --name app app-image:1.2.3

また、https://github.com/outstand/docker-dockup やバックアップおよびリストア用の同様のイメージを使って、以下の例のようにコンテナをスピンアップさせることも可能です。 circle-dockup.yml の設定例:

version: '2'
services:
 bundler-cache:
   image: outstand/dockup:latest
   command: restore
   container_name: bundler-cache
   tty: true
   environment:
     COMPRESS: 'false'
   volumes:
     - bundler-data:/source/bundler-data

次に、以下の CircleCI .circleci/config.yml スニペットで bundler-cache コンテナにデータを挿入し、バックアップを行います。

# CircleCI キャッシュから bundler-data コンテナにデータを挿入します。

- restore_cache:
    keys:
      - v4-bundler-cache-{{ arch }}-{{ .Branch }}-{{ checksum "Gemfile.lock" }}
      - v4-bundler-cache-{{ arch }}-{{ .Branch }}
      - v4-bundler-cache-{{ arch }}
- run:
    name: Docker ボリュームへの Bundler キャッシュの復元
    command: |
      NAME=bundler-cache
      CACHE_PATH=~/bundler-cache
      set -x
      mkdir -p $CACHE_PATH
      docker-compose -f docker-compose.yml -f docker/circle-dockup.yml up --no-start $NAME
      docker cp $CACHE_PATH/. $NAME:/backup
      docker-compose -f docker-compose.yml -f docker/circle-dockup.yml up --no-recreate $NAME
      docker rm -f $NAME

# 同じボリュームを CircleCI キャッシュにバックアップします。
- run:
    name: Docker ボリュームからの Bundler キャッシュのバックアップ
    command: |
      NAME=bundler-cache
      CACHE_PATH=~/bundler-cache
      set -x
      docker-compose -f docker-compose.yml -f docker/circle-dockup.yml run --name $NAME $NAME backup
      docker cp $NAME:/backup/. $CACHE_PATH
      docker rm -f $NAME
- save_cache:
    key: v4-bundler-cache-{{ arch }}-{{ .Branch }}-{{ checksum "Gemfile.lock" }}
    paths:
      - ~/bundler-cache

リモート Docker 環境へのアクセス

リモート Docker 環境が起動されると、SSH エイリアスが作成され、リモート Docker 仮想マシンに対して SSH 接続できます。 SSH 接続は、ビルドをデバッグする場合や、Docker または VM ファイルシステムの設定を変更する場合に便利です。 リモート Docker 仮想マシンに SSH 接続するには、プロジェクトを設定するジョブステップ内で、または SSH 再実行中に、以下を実行します。

ssh remote-docker

注: 上記の例は、docker Executor で動作しないボリュームマウントを使用する方法を示しています。 この他に、ボリューム マウントが動作する machine Executor を使用する方法もあります。

これらのサンプルコードは ryansch 氏より提供していただきました。

関連項目

Docker レイヤーキャッシュ

ジョブ空間

プライマリコンテナ

Docker レイヤーキャッシュ


ドキュメントの改善にご協力ください

このガイドは、CircleCI の他のドキュメントと同様にオープンソースであり、 GitHub でご利用いただけます。 ご協力いただき、ありがとうございます。

サポートが必要ですか

CircleCI のサポートエンジニアによる、サービスに関する問題、請求およびアカウントについての質問への対応、設定の構築に関する問題解決のサポートを行っています。 サポートチケットを送信して、CircleCI のサポートエンジニアにお問い合わせください。日本語でお問い合わせいただけます。

または、 サポートサイト から、サポート記事やコミュニティフォーラム、トレーニングリソースをご覧いただけます。