Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
40 commits
Select commit Hold shift + click to select a range
15c5a99
docs(ja): periodic update (v1.15)
shingos Mar 7, 2022
14051be
docs(ja): periodic update
shingos Mar 7, 2022
09be87b
docs(ja): periodic update
shingos Mar 8, 2022
b757e92
docs(ja): periodic update
shingos Mar 8, 2022
411cb36
docs(ja): periodic update
shingos Mar 9, 2022
b803706
docs(ja): periodic update
shingos Mar 9, 2022
0b02e47
docs(ja): periodic update
shingos Mar 9, 2022
0817615
docs(ja): periodic update
shingos Mar 9, 2022
367615d
docs(ja): periodic update
shingos Mar 9, 2022
e7f16a2
docs(ja): periodic update
shingos Mar 9, 2022
a9afed7
docs(ja): periodic update
shingos Mar 9, 2022
9213816
docs(ja): periodic update
shingos Mar 9, 2022
72f8b13
docs(ja): periodic update
shingos Mar 9, 2022
9c45104
docs(ja): periodic update
shingos Mar 9, 2022
51a4303
docs(ja): periodic update
shingos Mar 9, 2022
c20bfd1
docs(ja): periodic update
shingos Mar 9, 2022
8c07ab2
docs(ja): periodic update
shingos Mar 9, 2022
fe12e48
docs(ja): periodic update
shingos Mar 10, 2022
f365e8c
docs(ja): periodic update
shingos Mar 10, 2022
8e88c83
docs(ja): periodic update
shingos Mar 10, 2022
1d20a60
docs(ja): periodic update
shingos Mar 10, 2022
c9859b6
docs(ja): periodic update
shingos Mar 10, 2022
ad9e3d2
docs(ja): periodic update
shingos Mar 10, 2022
76f803c
docs(ja): periodic update
shingos Mar 10, 2022
254b57e
docs(ja): periodic update
shingos Mar 11, 2022
7352dd7
docs(ja): periodic update
shingos Mar 11, 2022
be9bd52
docs(ja): periodic update
shingos Mar 11, 2022
acfc320
docs(ja): periodic update
shingos Mar 11, 2022
851b30b
docs(ja): periodic update
shingos Mar 11, 2022
4e4c4e1
docs(ja): periodic update
shingos Mar 11, 2022
7564ada
docs(ja): periodic update
shingos Mar 11, 2022
c1a78d9
docs(ja): periodic update
shingos Mar 11, 2022
700b135
docs(ja): periodic update
shingos Mar 11, 2022
12fae84
Merge branch 'aws:mainline' into ja-docs-periodic-update
shingos Mar 14, 2022
bf0d705
docs(ja): periodic update
shingos Mar 15, 2022
8c1f670
docs(ja): periodic update
shingos Mar 15, 2022
d949450
docs(ja): periodic update
shingos Mar 15, 2022
f693cd9
docs(ja): periodic update
shingos Mar 15, 2022
cfdf38f
docs(ja): periodic update
shingos Mar 15, 2022
f05e237
Merge branch 'mainline' into ja-docs-periodic-update
mergify[bot] Mar 15, 2022
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
5 changes: 5 additions & 0 deletions site/content/docs/include/envvars.ja.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,8 @@

<a id="variables" href="#variables" class="field">`variables`</a> <span class="type">Map</span>
Copilot は Service 名などを常に環境変数としてタスクに対して渡します。本フィールドではそれら以外に追加で渡したい環境変数をキーバーリューのペアで指定します。

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

<a id="env_file" href="#env_file" class="field">`env_file`</a> <span class="type">String</span>
ワークスペースのルートから、メインコンテナに引き渡す環境変数を含むファイルへのパスを指定します。環境変数ファイルの詳細については、[環境変数ファイルの指定に関する考慮事項](https://docs.aws.amazon.com/ja_jp/AmazonECS/latest/developerguide/taskdef-envfiles.html#taskdef-envfiles-considerations)を参照してください。
5 changes: 4 additions & 1 deletion site/content/docs/include/exec.ja.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
<div class="separator"></div>

<a id="exec" href="#exec" class="field">`exec`</a> <span class="type">Boolean</span>
コンテナ内部でのインタラクティブなコマンド実行機能を有効化します。デフォルト値は `false` です。`$ copilot svc exec` コマンドの利用には、この値に `true` を指定しておく必要があります。
コンテナ内部でのインタラクティブなコマンド実行機能を有効化します。デフォルト値は `false` です。`$ copilot svc exec` コマンドの利用には、この値に `true` を指定しておく必要があります。

!!! info
Windows OS 上で動作するコンテナでは、Exec はサポートされていません。
11 changes: 9 additions & 2 deletions site/content/docs/include/http-config.ja.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
<div class="separator"></div>

<a id="http" href="#http" class="field">`http`</a> <span class="type">Map</span>
<a id="http" href="#http" class="field">`http`</a> <span class="type">Boolean or Map</span>
http セクションは Service と Application Load Balancer の連携に関するパラメーターを含みます。

Application Load Balancer を無効にするには、`http: false` を指定します。Load-Balanced Web Service では、
Application Load Balancer または Network Load Balancer の少なくともどちらかが有効である必要があることに注意してください。

<span class="parent-field">http.</span><a id="http-path" href="#http-path" class="field">`path`</a> <span class="type">String</span>
このパスに対するリクエストが Service に転送されます。各 [Load Balanced Web Service](../concepts/services.ja.md#load-balanced-web-service) は、ユニークなパスでリッスンする必要があります。

Expand Down Expand Up @@ -63,7 +66,7 @@ http:
```

<span class="parent-field">http.</span><a id="http-alias" href="#http-alias" class="field">`alias`</a> <span class="type">String or Array of Strings</span>
サービスの HTTPS ドメインエイリアス
Service の HTTPS ドメインエイリアス
```yaml
# 文字列で指定する場合
http:
Expand All @@ -72,3 +75,7 @@ http:
http:
alias: ["example.com", "v1.example.com"]
```

<span class="parent-field">http.</span><a id="http-version" href="#http-version" class="field">`version`</a> <span class="type">String</span>
HTTP(S) のプロトコルバージョン。'grpc', 'http1', 'http2' のいずれかである必要があります。省略した場合は、'http1' とみなされます。
gRPC を使用する場合、Application にドメインが関連付けられなければならないことに注意してください。
7 changes: 5 additions & 2 deletions site/content/docs/include/image-config.ja.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
image セクションは、Docker ビルドに関する設定や公開するポートについてのパラメータを含みます。

<span class="parent-field">image.</span><a id="image-build" href="#image-build" class="field">`build`</a> <span class="type">String or Map</span>
オプションの引数で指定した Dockerfile からコンテナを構築します。後述の [`image.location`](#image-location) フィールドとは排他的な使用となります。

このフィールドに String(文字列)を指定した場合、Copilot はそれを Dockerfile の場所を示すパスと解釈します。その際、指定したパスのディレクトリ部が Docker のビルドコンテキストであると仮定します。以下は build フィールドに文字列を指定する例です。
```yaml
image:
Expand Down Expand Up @@ -34,8 +36,9 @@ Copilot はあなたの意図を理解するために最善を尽くしますの
Dockerfile からコンテナイメージをビルドする代わりに、既存のコンテナイメージ名の指定も可能です。`image.location` と [`image.build`](#image-build) の同時利用はできません。
`location` フィールドの制約を含む指定方法は Amazon ECS タスク定義の [`image` パラメータ](https://docs.aws.amazon.com/ja_jp/AmazonECS/latest/developerguide/task_definition_parameters.html#container_definition_image)のそれに従います。

!!! note
Windows コンテナイメージを指定する場合、Manifest に`platform: windows/amd64`を指定する必要があります。
!!! warning
Windows コンテナイメージを指定する場合、Manifest に `platform: windows/amd64` を指定する必要があります。
ARM アーキテクチャベースのコンテナイメージを指定する場合、Manifest に `platform: linux/arm64` を指定する必要があります。

<span class="parent-field">image.</span><a id="image-credential" href="#image-credential" class="field">`credentials`</a> <span class="type">String</span>
任意項目です。プライベートリポジトリの認証情報の ARN。`credentials` フィールドは、Amazon ECS タスク定義の [`credentialsParameter`](https://docs.aws.amazon.com/ja_jp/AmazonECS/latest/developerguide/private-auth.html) と同じです。
Expand Down
2 changes: 1 addition & 1 deletion site/content/docs/include/image-healthcheck.ja.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,5 +14,5 @@
<span class="parent-field">image.healthcheck.</span><a id="image-healthcheck-timeout" href="#image-healthcheck-timeout" class="field">`timeout`</a> <span class="type">Duration</span>
ヘルスチェックの実行開始から失敗とみなすまでに待機する秒単位の期間です。デフォルト値は5秒です。

<span class="parent-field">image.healthcheck.</span><a id="image-healthcheck-start-period" href="#image-healthcheck-start-period" class="field">`start_period`</a> <span class="type">Duration</span>
<span class="parent-field">image.healthcheck.</span><a id="image-healthcheck-start-period" href="#image-healthcheck-start-period" class="field">`start_period`</a> <span class="type">Duration</span>
ヘルスチェックの実行と失敗がリトライ回数としてカウントされ始める前に、コンテナに対して起動処理を済ませる猶予期間の長さです。秒単位で指定し、デフォルトは0秒です。
82 changes: 82 additions & 0 deletions site/content/docs/include/nlb.ja.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
<div class="separator"></div>

<a id="nlb" href="#nlb" class="field">`nlb`</a> <span class="type">Map</span>
nlb セクションは Service を Network Load Balancer と統合するためのパラメーターを含みます。

Network Load Balancerは、`nlb` フィールドを指定した場合のみ有効になります。Load-Balanced Web Service では、Application Load Balancer と Network Load Balancer のいずれかが有効になっている必要があることに注意してください。

<span class="parent-field">nlb.</span><a id="nlb-port" href="#nlb-port" class="field">`port`</a> <span class="type">String</span>
必須項目。Network Load Balancer がリッスンするポートとプロトコルを指定します。

使用可能なプロトコルは `tcp` と `tls` です。プロトコルを指定しない場合、デフォルトで `tcp` が使用されます。
設定例:
```yaml
nlb:
port: 80
```
`tcp` リクエストをポート 80 で待ち受けるようにするためには、以下のように設定します。
設定例:
```yaml
nlb:
port: 80/tcp
```

簡単に TLS 終端を有効にすることができます。
設定例:
```yaml
nlb:
port: 443/tls
```

<span class="parent-field">nlb.</span><a id="nlb-healthcheck" href="#nlb-healthcheck" class="field">`healthcheck`</a> <span class="type">Map</span>
Network Load Balancer のヘルスチェックの設定を指定します。
```yaml
nlb:
healthcheck:
port: 80
healthy_threshold: 3
unhealthy_threshold: 2
interval: 15s
timeout: 10s
```

<span class="parent-field">nlb.healthcheck.</span><a id="nlb-healthcheck-port" href="#nlb-healthcheck-port" class="field">`port`</a> <span class="type">String</span>
ヘルスチェックのリクエストが送信されるポート。ヘルスチェックが、コンテナターゲットポートとは異なるポートで実行される必要がある場合に指定します。

<span class="parent-field">nlb.healthcheck.</span><a id="nlb-healthcheck-healthy-threshold" href="#nlb-healthcheck-healthy-threshold" class="field">`healthy_threshold`</a> <span class="type">Integer</span>
unhealthy なターゲットを healthy とみなすために必要な、連続したヘルスチェックの成功回数を指定します。デフォルト値は 3 で、設定可能な範囲は、2 〜 10 です。

<span class="parent-field">nlb.healthcheck.</span><a id="nlb-healthcheck-unhealthy-threshold" href="#nlb-healthcheck-unhealthy-threshold" class="field">`unhealthy_threshold`</a> <span class="type">Integer</span>
ターゲットが unhealthy であると判断するまでに必要な、連続したヘルスチェックの失敗回数を指定します。デフォルト値は 3 で、設定可能な範囲は、2 〜 10 です。

!!! info
この説明を書いている時点では、[ドキュメント](https://docs.aws.amazon.com/ja_jp/elasticloadbalancing/latest/network/target-group-health-checks.html)によると、Network Load Balancer の 'unhealthy threshold' は 'healthy threshold' と同じである必要があるとされています。

<span class="parent-field">nlb.healthcheck.</span><a id="nlb-healthcheck-interval" href="#nlb-healthcheck-interval" class="field">`interval`</a> <span class="type">Duration</span>
個々のターゲットへのヘルスチェックを行う際の、おおよその間隔を秒単位で指定します。設定可能な値は 10s (10 秒) または 30s (30 秒) で、デフォルト値は 30s です。

<span class="parent-field">nlb.healthcheck.</span><a id="nlb-healthcheck-timeout" href="#nlb-healthcheck-timeout" class="field">`timeout`</a> <span class="type">Duration</span>
ターゲットからの応答がない場合、ヘルスチェックが失敗したとみなすまでの時間を秒単位で指定します。デフォルト値は 10s (10 秒)です。

<span class="parent-field">nlb.</span><a id="nlb-target-container" href="#nlb-target-container" class="field">`target_container`</a> <span class="type">String</span>
サイドカーコンテナを指定することで、Service のメインコンテナの代わりにサイドカーでロードバランサからのリクエストを受け取れます。

<span class="parent-field">nlb.</span><a id="nlb-target-port" href="#nlb-target-port" class="field">`target_port`</a> <span class="type">Integer</span>
トラフィックを受信するコンテナのポート。コンテナポートがリスナーポートの `nlb.port` と異なる場合、このフィールドを指定します。

<span class="parent-field">nlb.</span><a id="nlb-ssl-policy" href="#nlb-ssl-policy" class="field">`ssl_policy`</a> <span class="type">String</span>
どのようなプロトコルや暗号をサポートするかを定義するセキュリティポリシーです。詳しくは[このドキュメント](https://docs.aws.amazon.com/ja_jp/elasticloadbalancing/latest/network/create-tls-listener.html#describe-ssl-policies)をご覧ください。

<span class="parent-field">nlb.</span><a id="nlb-stickiness" href="#nlb-stickiness" class="field">`stickiness`</a> <span class="type">Boolean</span>
スティッキーセッションの有効化、あるいは無効化を指定します。

<span class="parent-field">nlb.</span><a id="nlb-alias" href="#nlb-alias" class="field">`alias`</a> <span class="type">String or Array of Strings</span>
Service のドメインエイリアス
```yaml
# 文字列で指定する場合
nlb:
alias: example.com
# 別の方法として、文字列配列の場合
nlb:
alias: ["example.com", "v1.example.com"]
```
2 changes: 1 addition & 1 deletion site/content/docs/include/platform.en.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<div class="separator"></div>

<a id="platform" href="#platform" class="field">`platform`</a> <span class="type">String or Map</span>
<a id="platform" href="#platform" class="field">`platform`</a> <span class="type">String or Map</span>
Operating system and architecture (formatted as `[os]/[arch]`) to pass with `docker build --platform`. For example, `linux/arm64` or `windows/x86_64`. The default is `linux/x86_64`.

Override the generated string to build with a different valid `osfamily` or `architecture`. For example, Windows users might change the string
Expand Down
10 changes: 8 additions & 2 deletions site/content/docs/include/publish.ja.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,16 @@
```yaml
publish:
topics:
- name: order-events
- name: orderEvents
```

上記の例では、この Manifest は、`order-events` という名前の SNS トピックを定義しています。Copilot の Environment にデプロイされた、他の Worker Service は `order-events` トピックをサブスクライブできます。
上記の例では、この Manifest は、Copilot の Environment にデプロイされた他の Worker Service がサブスクライブできる `orderEvents` という名前の SNS トピックを定義しています。`COPILOT_SNS_TOPIC_ARNS` という名前の環境変数が、JSON 文字列としてワークロードに設定されます。

JavaScriptでは、次のように記述できます。
```js
const {orderEvents} = JSON.parse(process.env.COPILOT_SNS_TOPIC_ARNS)
```
詳しくは、[パブリッシュ / サブスクライブ](../developing/publish-subscribe.ja.md)のページをご覧ください。

<span class="parent-field">publish.</span><a id="publish-topics" href="#publish-topics" class="field">`topics`</a> <span class="type">Array of topics</span>
[`topic`](#publish-topics-topic) オブジェクトのリスト。
Expand Down
2 changes: 1 addition & 1 deletion site/content/docs/include/secrets.ja.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<div class="separator"></div>

<a id="secrets" href="#secrets" class="field">`secrets`</a> <span class="type">Map</span>
[AWS Systems Manager (SSM) パラメータストア](https://docs.aws.amazon.com/ja_jp/systems-manager/latest/userguide/systems-manager-parameter-store.html)から取得する秘密情報を、キーに環境変数名、バリューに SSM パラメータ名をペアで指定します。秘密情報はタスク実行時に安全に取得され、環境変数として設定されます
[AWS Systems Manager (SSM) パラメータストア](https://docs.aws.amazon.com/ja_jp/systems-manager/latest/userguide/systems-manager-parameter-store.html)または [AWS Secrets Manager](https://docs.aws.amazon.com/ja_jp/secretsmanager/latest/userguide/intro.html)から環境変数として、Service に安全に渡される秘密値を表すキー・値ペアを指定します
4 changes: 2 additions & 2 deletions site/content/docs/manifest/backend-service.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ List of all available properties for a `'Backend Service'` manifest. To learn ab

???+ note "Sample manifest for an api service"

```yaml
```yaml
# Your service name will be used in naming your resources like log groups, ECS services, etc.
name: api
type: Backend Service
Expand Down Expand Up @@ -55,7 +55,7 @@ List of all available properties for a `'Backend Service'` manifest. To learn ab
spot: 2
production:
count: 2
```
```

<a id="name" href="#name" class="field">`name`</a> <span class="type">String</span>
The name of your service.
Expand Down
3 changes: 3 additions & 0 deletions site/content/docs/manifest/backend-service.ja.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ network:

variables:
LOG_LEVEL: info
env_file: log.env
secrets:
GITHUB_TOKEN: GITHUB_TOKEN

Expand Down Expand Up @@ -90,6 +91,8 @@ Service は、希望するタスク数を 5 に設定し、Service 内に 5 つ
count:
spot: 5
```
!!! info
ARM アーキテクチャで動作するコンテナでは、Fargate Spot はサポートされていません。

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

Expand Down
4 changes: 2 additions & 2 deletions site/content/docs/manifest/lb-web-service.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ List of all available properties for a `'Load Balanced Web Service'` manifest. T

???+ note "Sample manifest for a frontend service"

```yaml
```yaml
# Your service name will be used in naming your resources like log groups, ECS services, etc.
name: frontend
type: Load Balanced Web Service
Expand Down Expand Up @@ -62,7 +62,7 @@ List of all available properties for a `'Load Balanced Web Service'` manifest. T
spot: 2
production:
count: 2
```
```

<a id="name" href="#name" class="field">`name`</a> <span class="type">String</span>
The name of your service.
Expand Down
10 changes: 10 additions & 0 deletions site/content/docs/manifest/lb-web-service.ja.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ http:
path: '/'
healthcheck:
path: '/_healthcheck'
success_codes: '200,301'
healthy_threshold: 3
unhealthy_threshold: 2
interval: 15s
Expand All @@ -20,6 +21,10 @@ http:
deregistration_delay: 5s
stickiness: false
allowed_source_ips: ["10.24.34.0/23"]
alias: example.com

nlb:
port: 443/tls

# コンテナと Service の構成
image:
Expand All @@ -40,6 +45,7 @@ exec: true

variables:
LOG_LEVEL: info
env_file: log.env
secrets:
GITHUB_TOKEN: GITHUB_TOKEN

Expand Down Expand Up @@ -68,6 +74,8 @@ Service のアーキテクチャタイプ。 [Load Balanced Web Service](../conc

{% include 'http-config.ja.md' %}

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

{% include 'image-config-with-port.ja.md' %}

{% include 'image-healthcheck.ja.md' %}
Expand All @@ -92,6 +100,8 @@ Service は、希望するタスク数を 5 に設定し、Service 内に 5 つ
count:
spot: 5
```
!!! info
ARM アーキテクチャで動作するコンテナでは、Fargate Spot はサポートされていません。

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

Expand Down
4 changes: 2 additions & 2 deletions site/content/docs/manifest/pipeline.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ List of all available properties for a Copilot pipeline manifest. To learn more

???+ note "Sample manifest for a pipeline triggered from a GitHub repo"

```yaml
```yaml
name: pipeline-sample-app-frontend
version: 1

Expand All @@ -26,7 +26,7 @@ List of all available properties for a Copilot pipeline manifest. To learn more
-
name: prod
requires_approval: true
```
```

<a id="name" href="#name" class="field">`name`</a> <span class="type">String</span>
The name of your pipeline.
Expand Down
2 changes: 1 addition & 1 deletion site/content/docs/manifest/pipeline.ja.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ Pipeline をトリガーするための GitHub アクセストークンを保持
Copilot v1.4.0 から GitHub リポジトリをソースにする場合のアクセストークンは不要になりました。代わりに Copilot は [AWS CodeStar の GitHub への接続](https://docs.aws.amazon.com/ja_jp/codepipeline/latest/userguide/update-github-action-connections.html)を使って Pipeline をトリガーします。

<span class="parent-field">source.properties.</span><a id="source-properties-branch" href="#source-properties-branch" class="field">`branch`</a> <span class="type">String</span>
Pipeline をトリガーするリポジトリのブランチ名。 GitHub と CodeCommit の場合デフォルトは `main` で Bitbucket の場合デフォルトは `master` です
Pipeline をトリガーするリポジトリのブランチ名。 Copilot は、このフィールドに現在のローカルブランチを自動的に入力します

<span class="parent-field">source.properties.</span><a id="source-properties-repository" href="#source-properties-repository" class="field">`repository`</a> <span class="type">String</span>
リポジトリの URL 。
Expand Down
Loading