Amazon Elastic Container Service
开发人员指南 (API 版本 2014-11-13)
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 AWS 服务入门

ecs-cli compose

在 ECS 集群上利用 docker-compose 式命令管理 Amazon ECS 任务。有关 Docker 复合文件语法如何与 Amazon ECS CLI 结合使用的更多信息,请参阅使用 Docker 复合文件语法

注意

要使用 Amazon ECS CLI 创建 Amazon ECS 服务,请参阅 ecs-cli compose service

ecs-cli compose 命令将项目名称与其创建的任务定义和服务结合使用。当 CLI 从复合文件创建任务定义时,任务定义将称为 project-name。当 CLI 从复合文件创建服务时,服务将称为 service-project-name。默认情况下,项目名称是包含 Docker 复合文件的目录的名称。但是,您也可以使用 --project-name 选项指定自己的项目名称。

注意

Amazon ECS CLI 只能管理使用 CLI 创建的任务、服务和容器实例。要管理并非使用 Amazon ECS CLI 创建的任务、服务和容器实例,请使用 AWS Command Line Interface 或 AWS 管理控制台。

重要

所介绍的某些功能仅可用于最新版本的 Amazon ECS CLI。有关获取最新版本的更多信息,请参阅 安装 Amazon ECS CLI

语法

ecs-cli compose [--verbose] [--file compose_file] [--project-name project_name] [--task-role-arn task_role_arn] [--ecs-params ecs_params_file] [--registry-creds value] [--region region] [--cluster-config cluster_config_name] [--ecs-profile ecs_profile] [--aws-profile aws_profile] [--cluster cluster_name] [--help] [subcommand] [arguments] [--help]

选项

名称 描述

--verbose, --debug

提高命令输出的详细程度以帮助诊断。

必需:否

--file, -f compose-file

指定要使用的 Docker 复合文件。此时,最新版本的 Amazon ECS CLI 支持 Docker 复合文件语法版本 1 和 2。 如果在 ecs-cli compose 运行时设置 COMPOSE_FILE 环境变量,则 Docker 复合文件将设置为该环境变量的值。

类型:字符串

默认值:./docker-compose.yml

必需:否

--project-name, -p project-name

指定要使用的项目名称。如果在运行 ecs-cli compose 时设置 COMPOSE_PROJECT_NAME 环境变量,则项目名称将设置为该环境变量的值。

类型:字符串

默认值:当前目录名。

必需:否

--task-role-arn role_value

指定该任务中的容器可以代入的 IAM 角色的短名称或完整的 Amazon 资源名称 (ARN)。该任务中的所有容器都将被授予在该角色中指定的权限。

类型:字符串

必需:否

--region, -r region

指定要使用的 AWS 区域。默认为使用 configure 命令配置的集群。

类型:字符串

必需:否

--cluster-config cluster_config_name

指定要使用的 Amazon ECS 集群配置的名称。默认为作为默认值设置的集群设置。

类型:字符串

必需:否

--ecs-profile ecs_profile

指定要使用的 Amazon ECS 配置文件的名称。默认为使用 configure profile 命令配置的配置文件。

类型:字符串

必需:否

--aws-profile aws_profile

指定要使用的 AWS 配置文件。使您能够使用 ~/.aws/credentials 中现有指定配置文件中的 AWS 凭证。

类型:字符串

必需:否

--cluster, -c cluster_name

指定要使用的 Amazon ECS 集群名称。默认为使用 configure 命令配置的集群。

类型:字符串

必需:否

--help, -h

显示指定命令的帮助文本。

必需:否

可用子命令

ecs-cli compose 命令支持以下子命令。其中,每条子命令均具有关联的标记,这些标记可通过 --help 标记显示。

create

从复合文件创建 Amazon ECS 任务定义。有关更多信息,请参阅 ecs-cli compose create

ps, list

列出集群中由复合项目启动的所有容器。

run [containerName] ["command ..."] ...

使用为容器提供的一次性命令来启动覆盖命令的所有容器。

scale n

将正在运行的任务数扩展至指定计数。

start

从通过复合文件创建的任务定义启动单个任务。有关更多信息,请参阅 ecs-cli compose start

stop, down

停止由复合项目创建的所有正在运行的任务。

up

从复合文件创建 ECS 任务定义(如果该任务定义不存在)并在集群上运行该任务的一个实例(createstart 的组合)。有关更多信息,请参阅ecs-cli compose up

service [subcommand]

从复合文件创建 ECS 服务。有关更多信息,请参阅 ecs-cli compose service

help

显示指定命令的帮助文本。

本页内容: