Skip to content

Commit d174012

Browse files
committed
docs(site): On sidecars, the depends_on attributes is not on image attribute (aws#5945)
1 parent b1c4c42 commit d174012

16 files changed

+40
-34
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{% include 'image-config.en.md' %}
2+
3+
{% include 'image-depends-on-config.en.md' %}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{% include 'image-config.ja.md' %}
2+
3+
{% include 'image-depends-on-config.ja.md' %}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{% include 'image-config.en.md' %}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{% include 'image-config.ja.md' %}
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{% include 'image.md' %}
22

3-
{% include 'image-config.en.md' %}
3+
{% include 'image-config-for-main-container.en.md' %}
44

55
<span class="parent-field">image.</span><a id="image-port" href="#image-port" class="field">`port`</a> <span class="type">Integer</span>
66
The port exposed in your Dockerfile. Copilot should parse this value for you from your `EXPOSE` instruction.
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{% include 'image.ja.md' %}
22

3-
{% include 'image-config.ja.md' %}
3+
{% include 'image-config-for-main-container.ja.md' %}
44

55
<span class="parent-field">image.</span><a id="image-port" href="#image-port" class="field">`port`</a> <span class="type">Integer</span>
66
公開するポート番号。Dockerfile 内に `EXPOSE` インストラクションが記述されている場合、Copilot はそれをパースした値をここに挿入します。

site/content/docs/include/image-config.en.md

-13
Original file line numberDiff line numberDiff line change
@@ -40,16 +40,3 @@ An optional credentials ARN for a private repository. The `credentials` field fo
4040

4141
<span class="parent-field">image.</span><a id="image-labels" href="#image-labels" class="field">`labels`</a> <span class="type">Map</span>
4242
An optional key/value map of [Docker labels](https://docs.docker.com/config/labels-custom-metadata/) to add to the container.
43-
44-
<span class="parent-field">image.</span><a id="image-depends-on" href="#image-depends-on" class="field">`depends_on`</a> <span class="type">Map</span>
45-
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.
46-
47-
For example:
48-
```yaml
49-
image:
50-
build: ./Dockerfile
51-
depends_on:
52-
nginx: start
53-
startup: success
54-
```
55-
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.

site/content/docs/include/image-config.ja.md

-13
Original file line numberDiff line numberDiff line change
@@ -40,16 +40,3 @@ Dockerfile からコンテナイメージをビルドする代わりに、既存
4040

4141
<span class="parent-field">image.</span><a id="image-labels" href="#image-labels" class="field">`labels`</a> <span class="type">Map</span>
4242
コンテナに付与したい [Docker ラベル](https://docs.docker.com/config/labels-custom-metadata/)を key/value の Map で指定できます。これは任意設定項目です。
43-
44-
<span class="parent-field">image.</span><a id="image-depends-on" href="#image-depends-on" class="field">`depends_on`</a> <span class="type">Map</span>
45-
任意項目。コンテナに追加する [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` の依存条件を指定することはできません。
46-
47-
設定例:
48-
```yaml
49-
image:
50-
build: ./Dockerfile
51-
depends_on:
52-
nginx: start
53-
startup: success
54-
```
55-
上記の例では、タスクのメインコンテナは `nginx` サイドカーが起動し、`startup` コンテナが正常に完了してから起動します。
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
<span class="parent-field">image.</span><a id="image-depends-on" href="#image-depends-on" class="field">`depends_on`</a> <span class="type">Map</span>
2+
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.
3+
4+
For example:
5+
```yaml
6+
image:
7+
build: ./Dockerfile
8+
depends_on:
9+
nginx: start
10+
startup: success
11+
```
12+
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.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
<span class="parent-field">image.</span><a id="image-depends-on" href="#image-depends-on" class="field">`depends_on`</a> <span class="type">Map</span>
2+
任意項目。コンテナに追加する [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` の依存条件を指定することはできません。
3+
4+
設定例:
5+
```yaml
6+
image:
7+
build: ./Dockerfile
8+
depends_on:
9+
nginx: start
10+
startup: success
11+
```
12+
上記の例では、タスクのメインコンテナは `nginx` サイドカーが起動し、`startup` コンテナが正常に完了してから起動します。

site/content/docs/include/sidecar-config.en.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Port of the container to expose (optional).
55
<a id="image" href="#image" class="field">`image`</a> <span class="type">String or Map</span>
66
Image URL for the sidecar container (required).
77

8-
{% include 'image-config.en.md' %}
8+
{% include 'image-config-for-sidecar.en.md' %}
99

1010
<a id="essential" href="#essential" class="field">`essential`</a> <span class="type">Bool</span>
1111
Whether the sidecar container is an essential container (optional, default true).

site/content/docs/include/sidecar-config.ja.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<a id="image" href="#image" class="field">`image`</a> <span class="type">String or Map</span>
66
サイドカーコンテナのイメージ URL。(必須項目)
77

8-
{% include 'image-config.ja.md' %}
8+
{% include 'image-config-for-sidecar.ja.md' %}
99

1010
<a id="essential" href="#essential" class="field">`essential`</a> <span class="type">Bool</span>
1111
サイドカーコンテナが必須のコンテナかどうか。(任意項目。デフォルトでは true)

site/content/docs/manifest/scheduled-job.en.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ on:
7272
7373
{% include 'image.md' %}
7474
75-
{% include 'image-config.en.md' %}
75+
{% include 'image-config-for-main-container.en.md' %}
7676
7777
<div class="separator"></div>
7878

site/content/docs/manifest/scheduled-job.ja.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ on:
7474
7575
{% include 'image.ja.md' %}
7676
77-
{% include 'image-config.ja.md' %}
77+
{% include 'image-config-for-main-container.ja.md' %}
7878
7979
<div class="separator"></div>
8080

site/content/docs/manifest/worker-service.en.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -238,7 +238,7 @@ Specify this field as a map for customization of certain attributes for this top
238238

239239
{% include 'image.md' %}
240240

241-
{% include 'image-config.en.md' %}
241+
{% include 'image-config-for-main-container.en.md' %}
242242

243243
{% include 'image-healthcheck.en.md' %}
244244

site/content/docs/manifest/worker-service.ja.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -236,7 +236,7 @@ filter_policy:
236236

237237
{% include 'image.ja.md' %}
238238

239-
{% include 'image-config.ja.md' %}
239+
{% include 'image-config-for-main-container.ja.md' %}
240240

241241
{% include 'task-size.ja.md' %}
242242

0 commit comments

Comments
 (0)