Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(site): On sidecars, the depends_on attribute is not on image map (#5945) #5950

Open
wants to merge 1 commit into
base: mainline
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{% include 'image-config.en.md' %}

{% include 'image-depends-on-config.en.md' %}
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{% include 'image-config.ja.md' %}

{% include 'image-depends-on-config.ja.md' %}
1 change: 1 addition & 0 deletions site/content/docs/include/image-config-for-sidecar.en.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{% include 'image-config.en.md' %}
1 change: 1 addition & 0 deletions site/content/docs/include/image-config-for-sidecar.ja.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{% include 'image-config.ja.md' %}
2 changes: 1 addition & 1 deletion site/content/docs/include/image-config-with-port.en.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{% include 'image.md' %}

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

<span class="parent-field">image.</span><a id="image-port" href="#image-port" class="field">`port`</a> <span class="type">Integer</span>
The port exposed in your Dockerfile. Copilot should parse this value for you from your `EXPOSE` instruction.
2 changes: 1 addition & 1 deletion site/content/docs/include/image-config-with-port.ja.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{% include 'image.ja.md' %}

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

<span class="parent-field">image.</span><a id="image-port" href="#image-port" class="field">`port`</a> <span class="type">Integer</span>
公開するポート番号。Dockerfile 内に `EXPOSE` インストラクションが記述されている場合、Copilot はそれをパースした値をここに挿入します。
13 changes: 0 additions & 13 deletions site/content/docs/include/image-config.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,16 +40,3 @@ An optional credentials ARN for a private repository. The `credentials` field fo

<span class="parent-field">image.</span><a id="image-labels" href="#image-labels" class="field">`labels`</a> <span class="type">Map</span>
An optional key/value map of [Docker labels](https://docs.docker.com/config/labels-custom-metadata/) to add to the container.

<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>
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.
13 changes: 0 additions & 13 deletions site/content/docs/include/image-config.ja.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,16 +40,3 @@ Dockerfile からコンテナイメージをビルドする代わりに、既存

<span class="parent-field">image.</span><a id="image-labels" href="#image-labels" class="field">`labels`</a> <span class="type">Map</span>
コンテナに付与したい [Docker ラベル](https://docs.docker.com/config/labels-custom-metadata/)を key/value の Map で指定できます。これは任意設定項目です。

<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>
任意項目。コンテナに追加する [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` コンテナが正常に完了してから起動します。
12 changes: 12 additions & 0 deletions site/content/docs/include/image-depends-on-config.en.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
<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>
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.
12 changes: 12 additions & 0 deletions site/content/docs/include/image-depends-on-config.ja.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
<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>
任意項目。コンテナに追加する [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` コンテナが正常に完了してから起動します。
2 changes: 1 addition & 1 deletion site/content/docs/include/sidecar-config.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Port of the container to expose (optional).
<a id="image" href="#image" class="field">`image`</a> <span class="type">String or Map</span>
Image URL for the sidecar container (required).

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

<a id="essential" href="#essential" class="field">`essential`</a> <span class="type">Bool</span>
Whether the sidecar container is an essential container (optional, default true).
Expand Down
2 changes: 1 addition & 1 deletion site/content/docs/include/sidecar-config.ja.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<a id="image" href="#image" class="field">`image`</a> <span class="type">String or Map</span>
サイドカーコンテナのイメージ URL。(必須項目)

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

<a id="essential" href="#essential" class="field">`essential`</a> <span class="type">Bool</span>
サイドカーコンテナが必須のコンテナかどうか。(任意項目。デフォルトでは true)
Expand Down
2 changes: 1 addition & 1 deletion site/content/docs/manifest/scheduled-job.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ on:

{% include 'image.md' %}

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

<div class="separator"></div>

Expand Down
2 changes: 1 addition & 1 deletion site/content/docs/manifest/scheduled-job.ja.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ on:

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

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

<div class="separator"></div>

Expand Down
2 changes: 1 addition & 1 deletion site/content/docs/manifest/worker-service.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -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' %}

Expand Down
2 changes: 1 addition & 1 deletion site/content/docs/manifest/worker-service.ja.md
Original file line number Diff line number Diff line change
Expand Up @@ -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' %}

Expand Down