diff --git a/site/content/docs/include/image-config-for-main-container.en.md b/site/content/docs/include/image-config-for-main-container.en.md new file mode 100644 index 00000000000..f12a5807590 --- /dev/null +++ b/site/content/docs/include/image-config-for-main-container.en.md @@ -0,0 +1,3 @@ +{% include 'image-config.en.md' %} + +{% include 'image-depends-on-config.en.md' %} diff --git a/site/content/docs/include/image-config-for-main-container.ja.md b/site/content/docs/include/image-config-for-main-container.ja.md new file mode 100644 index 00000000000..7294c054bc7 --- /dev/null +++ b/site/content/docs/include/image-config-for-main-container.ja.md @@ -0,0 +1,3 @@ +{% include 'image-config.ja.md' %} + +{% include 'image-depends-on-config.ja.md' %} diff --git a/site/content/docs/include/image-config-for-sidecar.en.md b/site/content/docs/include/image-config-for-sidecar.en.md new file mode 100644 index 00000000000..9e4d88058c6 --- /dev/null +++ b/site/content/docs/include/image-config-for-sidecar.en.md @@ -0,0 +1 @@ +{% include 'image-config.en.md' %} diff --git a/site/content/docs/include/image-config-for-sidecar.ja.md b/site/content/docs/include/image-config-for-sidecar.ja.md new file mode 100644 index 00000000000..73396c51487 --- /dev/null +++ b/site/content/docs/include/image-config-for-sidecar.ja.md @@ -0,0 +1 @@ +{% include 'image-config.ja.md' %} diff --git a/site/content/docs/include/image-config-with-port.en.md b/site/content/docs/include/image-config-with-port.en.md index f82897a7323..747b0e29c9e 100644 --- a/site/content/docs/include/image-config-with-port.en.md +++ b/site/content/docs/include/image-config-with-port.en.md @@ -1,6 +1,6 @@ {% include 'image.md' %} -{% include 'image-config.en.md' %} +{% include 'image-config-for-main-container.en.md' %} image.`port` Integer The port exposed in your Dockerfile. Copilot should parse this value for you from your `EXPOSE` instruction. diff --git a/site/content/docs/include/image-config-with-port.ja.md b/site/content/docs/include/image-config-with-port.ja.md index f1aec47ef97..b76ed78171c 100644 --- a/site/content/docs/include/image-config-with-port.ja.md +++ b/site/content/docs/include/image-config-with-port.ja.md @@ -1,6 +1,6 @@ {% include 'image.ja.md' %} -{% include 'image-config.ja.md' %} +{% include 'image-config-for-main-container.ja.md' %} image.`port` Integer 公開するポート番号。Dockerfile 内に `EXPOSE` インストラクションが記述されている場合、Copilot はそれをパースした値をここに挿入します。 diff --git a/site/content/docs/include/image-config.en.md b/site/content/docs/include/image-config.en.md index 6fd17b4d4a4..7e4b97548b8 100644 --- a/site/content/docs/include/image-config.en.md +++ b/site/content/docs/include/image-config.en.md @@ -40,16 +40,3 @@ An optional credentials ARN for a private repository. The `credentials` field fo image.`labels` Map An optional key/value map of [Docker labels](https://docs.docker.com/config/labels-custom-metadata/) to add to the container. - -image.`depends_on` Map -An optional key/value map of [Container Dependencies](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerDependency.html) to add to the container. The key of the map is a container name and the value is the condition to depend on. Valid conditions are: `start`, `healthy`, `complete`, and `success`. You cannot specify a `complete` or `success` dependency on an essential container. - -For example: -```yaml -image: - build: ./Dockerfile - depends_on: - nginx: start - startup: success -``` -In the above example, the task's main container will only start after the `nginx` sidecar has started and the `startup` container has completed successfully. diff --git a/site/content/docs/include/image-config.ja.md b/site/content/docs/include/image-config.ja.md index 2ba45790a17..08299b43095 100644 --- a/site/content/docs/include/image-config.ja.md +++ b/site/content/docs/include/image-config.ja.md @@ -40,16 +40,3 @@ Dockerfile からコンテナイメージをビルドする代わりに、既存 image.`labels` Map コンテナに付与したい [Docker ラベル](https://docs.docker.com/config/labels-custom-metadata/)を key/value の Map で指定できます。これは任意設定項目です。 - -image.`depends_on` Map -任意項目。コンテナに追加する [Container Dependencies](https://docs.aws.amazon.com/ja_jp/AmazonECS/latest/APIReference/API_ContainerDependency.html) の任意の key/value の Map。Map の key はコンテナ名で、value は依存関係を表す値 (依存条件) として `start`、`healthy`、`complete`、`success` のいずれかを指定できます。なお、必須コンテナに `complete` や `success` の依存条件を指定することはできません。 - -設定例: -```yaml -image: - build: ./Dockerfile - depends_on: - nginx: start - startup: success -``` -上記の例では、タスクのメインコンテナは `nginx` サイドカーが起動し、`startup` コンテナが正常に完了してから起動します。 diff --git a/site/content/docs/include/image-depends-on-config.en.md b/site/content/docs/include/image-depends-on-config.en.md new file mode 100644 index 00000000000..2a08ac920bf --- /dev/null +++ b/site/content/docs/include/image-depends-on-config.en.md @@ -0,0 +1,12 @@ +image.`depends_on` Map +An optional key/value map of [Container Dependencies](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerDependency.html) to add to the container. The key of the map is a container name and the value is the condition to depend on. Valid conditions are: `start`, `healthy`, `complete`, and `success`. You cannot specify a `complete` or `success` dependency on an essential container. + +For example: +```yaml +image: + build: ./Dockerfile + depends_on: + nginx: start + startup: success +``` +In the above example, the task's main container will only start after the `nginx` sidecar has started and the `startup` container has completed successfully. diff --git a/site/content/docs/include/image-depends-on-config.ja.md b/site/content/docs/include/image-depends-on-config.ja.md new file mode 100644 index 00000000000..1ebed9bab32 --- /dev/null +++ b/site/content/docs/include/image-depends-on-config.ja.md @@ -0,0 +1,12 @@ +image.`depends_on` Map +任意項目。コンテナに追加する [Container Dependencies](https://docs.aws.amazon.com/ja_jp/AmazonECS/latest/APIReference/API_ContainerDependency.html) の任意の key/value の Map。Map の key はコンテナ名で、value は依存関係を表す値 (依存条件) として `start`、`healthy`、`complete`、`success` のいずれかを指定できます。なお、必須コンテナに `complete` や `success` の依存条件を指定することはできません。 + +設定例: +```yaml +image: + build: ./Dockerfile + depends_on: + nginx: start + startup: success +``` +上記の例では、タスクのメインコンテナは `nginx` サイドカーが起動し、`startup` コンテナが正常に完了してから起動します。 diff --git a/site/content/docs/include/sidecar-config.en.md b/site/content/docs/include/sidecar-config.en.md index 4b21531cce7..a37468064c6 100644 --- a/site/content/docs/include/sidecar-config.en.md +++ b/site/content/docs/include/sidecar-config.en.md @@ -5,7 +5,7 @@ Port of the container to expose (optional). `image` String or Map Image URL for the sidecar container (required). -{% include 'image-config.en.md' %} +{% include 'image-config-for-sidecar.en.md' %} `essential` Bool Whether the sidecar container is an essential container (optional, default true). diff --git a/site/content/docs/include/sidecar-config.ja.md b/site/content/docs/include/sidecar-config.ja.md index fdb0faec476..8a7832777a7 100644 --- a/site/content/docs/include/sidecar-config.ja.md +++ b/site/content/docs/include/sidecar-config.ja.md @@ -5,7 +5,7 @@ `image` String or Map サイドカーコンテナのイメージ URL。(必須項目) -{% include 'image-config.ja.md' %} +{% include 'image-config-for-sidecar.ja.md' %} `essential` Bool サイドカーコンテナが必須のコンテナかどうか。(任意項目。デフォルトでは true) diff --git a/site/content/docs/manifest/scheduled-job.en.md b/site/content/docs/manifest/scheduled-job.en.md index 34591048c92..af1b5e42211 100644 --- a/site/content/docs/manifest/scheduled-job.en.md +++ b/site/content/docs/manifest/scheduled-job.en.md @@ -72,7 +72,7 @@ on: {% include 'image.md' %} -{% include 'image-config.en.md' %} +{% include 'image-config-for-main-container.en.md' %}
diff --git a/site/content/docs/manifest/scheduled-job.ja.md b/site/content/docs/manifest/scheduled-job.ja.md index bf8ce7d129b..35107aab4fa 100644 --- a/site/content/docs/manifest/scheduled-job.ja.md +++ b/site/content/docs/manifest/scheduled-job.ja.md @@ -74,7 +74,7 @@ on: {% include 'image.ja.md' %} -{% include 'image-config.ja.md' %} +{% include 'image-config-for-main-container.ja.md' %}
diff --git a/site/content/docs/manifest/worker-service.en.md b/site/content/docs/manifest/worker-service.en.md index 6135c9fab69..30a077a7477 100644 --- a/site/content/docs/manifest/worker-service.en.md +++ b/site/content/docs/manifest/worker-service.en.md @@ -238,7 +238,7 @@ Specify this field as a map for customization of certain attributes for this top {% include 'image.md' %} -{% include 'image-config.en.md' %} +{% include 'image-config-for-main-container.en.md' %} {% include 'image-healthcheck.en.md' %} diff --git a/site/content/docs/manifest/worker-service.ja.md b/site/content/docs/manifest/worker-service.ja.md index 3214d238e97..ab41eecd90a 100644 --- a/site/content/docs/manifest/worker-service.ja.md +++ b/site/content/docs/manifest/worker-service.ja.md @@ -236,7 +236,7 @@ filter_policy: {% include 'image.ja.md' %} -{% include 'image-config.ja.md' %} +{% include 'image-config-for-main-container.ja.md' %} {% include 'task-size.ja.md' %}