Docker Compose ファイル構文の使用 - Amazon Elastic Container Service

Docker Compose ファイル構文の使用

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

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

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

Amazon ECS CLI の Compose ファイルでは、次のパラメータがサポートされています。

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

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

  • command

  • cpu_shares

    注記

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

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

  • dns

  • dns_search

  • entrypoint

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

    重要

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

  • env_file

    重要

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

  • extends (Compose ファイルバージョン 1.0 および 2 のみ)

  • extra_hosts

  • healthcheck (Compose ファイルバージョン 3.0 のみ)

    注記

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

  • hostname

  • image

  • labels

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

  • log_driver (Compose ファイルバージョン 1.0 のみ)

  • log_opt (Compose ファイルバージョン 1.0 のみ)

  • logging (Compose ファイルバージョン 2.0 および 3.0)

    • driver

    • options

  • mem_limit (バイト単位)

    注記

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

  • mem_reservation (バイト単位)

    注記

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

  • ports

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

  • read_only

  • security_opt

  • shm_size (Compose ファイルバージョン 1.0 と 2 のみ。Fargate 起動タイプを使用するタスクには無効です)

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

  • tty

  • ulimits

  • user

  • volumes

  • volumes_from (Compose ファイルバージョン 1.0 および 2 のみ)

  • working_dir

重要

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

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