Amazon Elastic Container Service
開発者ガイド (API バージョン 2014-11-13)

Docker Compose ファイル構文の使用

ecs-cli compose および ecs-cli compose service コマンドを使用すると、タスク定義を作成し、Docker Compose ファイルを使用して Amazon ECS タスクおよびサービスを管理できます。詳細については、「ecs-cli compose」および「ecs-cli compose service」を参照してください。

現時点で、Amazon ECS CLI の最新バージョンでは、Docker 構成ファイル構文のバージョン 1、2、3 がサポートされています。Docker Compose ファイル構文のメジャーバージョンのみがサポートされています。したがって、構成ファイルで指定されたバージョンは、文字列 "1""1.0""2""2.0""3"、または "3.0" である必要があります。

デフォルトでは、Amazon ECS CLI コマンドは現在のディレクトリで docker-compose.yml という名前の Docker Compose ファイルを検索します。ただし、--file オプションを使用して、構成ファイルに別のファイル名またはパスを指定できます。これは、Amazon ECS CLI を使用して複数の構成ファイルからタスクとサービスを一度に管理するために特に便利です。

以下のパラメーターが、Amazon ECS CLI 用の構成ファイルでサポートされています。

  • cap_add (Fargate 起動タイプを使用するタスクでは無効)

  • cap_drop (Fargate 起動タイプを使用するタスクでは無効)

  • command

  • cpu_shares

    注記

    Compose バージョン 3 形式を使用している場合、cpu_shares は、ecs-params.yml で指定する必要があります。file. 詳細については、「Amazon ECS パラメータの使用」を参照してください。

  • devices (Fargate 起動タイプを使用するタスクでは無効)

  • dns

  • dns_search

  • entrypoint

  • environment: 構成ファイルで環境変数値が指定されていないが、シェル環境に存在する場合、シェル環境変数値が、関連付けられたタスクまたはサービス用に作成されたタスク定義に渡されます。

    重要

    認証情報データなどの機密情報にプレーンテキストの環境変数を使用することはお勧めしません。

  • env_file

    重要

    認証情報データなどの機密情報にプレーンテキストの環境変数を使用することはお勧めしません。

  • extra_hosts

  • healthcheck (構成ファイルバージョン 3 のみ)

    注記

    start_period フィールドは構成ファイルの使用をサポートしていません。start_period を指定するには、ecs-params.yml を使用します。file. 詳細については、「Amazon ECS パラメータの使用」を参照してください。

  • hostname

  • image

  • labels

  • links (Fargate 起動タイプを使用するタスクでは無効)

  • log_driver (構成ファイルバージョン 1 のみ)

  • log_opt (構成ファイルバージョン 1 のみ)

  • logging (構成ファイルバージョン 2 および 3)

    • driver

    • options

  • mem_limit (バイト単位)

    注記

    Compose バージョン 3 形式を使用している場合、mem_limit は、ecs-params.yml で指定する必要があります。file. 詳細については、「Amazon ECS パラメータの使用」を参照してください。

  • mem_reservation (バイト単位)

    注記

    Compose バージョン 3 形式を使用している場合、mem_reservation は、ecs-params.yml で指定する必要があります。file. 詳細については、「Amazon ECS パラメータの使用」を参照してください。

  • ports

  • privileged (Fargate 起動タイプを使用するタスクでは無効)

  • read_only

  • security_opt

  • shm_size (構成ファイルバージョン 1 および 2 のみで、Fargate 起動タイプを使用するタスクには無効です)

  • tmpfs (Fargate 起動タイプを使用するタスクでは無効)

  • ulimits

  • user

  • volumes

  • volumes_from (構成ファイルバージョン 1 および 2 のみ)

  • working_dir

重要

build ディレクティブは現在サポートされていません。

Docker 構成ファイル構文の詳細については、Docker ドキュメントの構成ファイルのリファレンスを参照してください。