Skip to content
Merged
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
4 changes: 3 additions & 1 deletion .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# @See https://help.github.com/articles/about-codeowners/

* @aws/aws-ecs-devx
* @aws/aws-ecs-devx

*.ja.md @toricls
4 changes: 4 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@ extra:
- name: English
link: ./en/
lang: en
- name: 日本語
link: ./ja/
lang: ja

nav:
- Home: index.en.md
Expand Down Expand Up @@ -164,6 +167,7 @@ plugins:
default_language: en
languages:
en: english
ja: japanese
material_alternate: false
- macros:
include_dir: site/content/docs/include
8 changes: 8 additions & 0 deletions site/content/community/get-involved.ja.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
AWS Copilot コミュニティへようこそ ❤️

[[アプリケーション、ブログ記事、動画](https://aws.github.io/copilot-cli/community/guides/)] のような AWS Copilot CLI に関連するリソースを皆で共有しましょう👩‍✈️

コミュニティへの参加方法は他にもあります!

* GitHub リポジトリに [![GitHub イシュー](https://img.shields.io/github/issues/aws/copilot-cli)](https://github.com/aws/copilot-cli/issues)を作成してみる
* [![Gitter チャット](https://badges.gitter.im/aws/copilot-cli.svg)](https://gitter.im/aws/copilot-cli?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)で Copilot な仲間達と会話してみよう
39 changes: 39 additions & 0 deletions site/content/community/guides.ja.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
Copilot な仲間たちとアプリケーションや動画、ブログポストを共有しよう!

## ブログポスト

| タイトル | 概要 |
| ----------- | ------------------------------------ |
| [**Pilot your containers like a boss with AWS Copilot!**](https://blog.flolight.dev/pilot-your-containers-like-a-boss-with-aws-copilot) by <a href="https://twitter.com/FlolightC">@FlolightC</a> | Florian simplifies getting started with AWS Copilot by demoing deployment of a [sample app](https://github.com/aws-samples/amazon-ecs-cli-sample-app) from start to finish, including links to both required and optional resources.
| [**Use AWS Copilot CLI to deploy containers on an existing infrastructure - Tutorial**](https://dannys.cloud/aws-copilot-cli-deploy-containers-existing-infrastructure-tutorial) by <a href="https://twitter.com/dannysteenman">@dannysteenman</a> | Danny explains how to use your existing VPC and subnets with AWS Copilot to quickly set up a working container environment. Follow along as he deploys a Django app with an RDS Postgres database and Elasticache Redis cluster. |
| [**Automatically deploying your container application with AWS Copilot**](https://aws.amazon.com/blogs/containers/automatically-deploying-your-container-application-with-aws-copilot/) by <a href="https://twitter.com/nathankpeck">@nathankpeck</a> | Nathan shows how to set up a release pipeline with the CLI that builds, pushes, and deploys an application. Finally, he sets up integration tests for validation before releasing to production. |
| [**Deploying containers with the AWS Copilot CLI**](https://maartenbruntink.nl/blog/2020/08/16/deploying-containers-with-the-aws-copilot-cli-part-1/) by <a href="https://twitter.com/maartenbruntink">@maartenbruntink</a> | Maarten shows how to use the AWS Copilot CLI to deploy the [sample Docker voting app](https://github.com/dockersamples/example-voting-app), which showcases how to set up your own Redis and Postgres servers. In the [second part](https://maartenbruntink.nl/blog/2020/08/16/deploying-containers-with-the-aws-copilot-cli-part-2), he automates the release process. |
| [**AWS Copilot: an application-first CLI for containers on AWS**](https://aws.amazon.com/blogs/containers/aws-copilot-an-application-first-cli-for-containers-on-aws/) by <a href="https://twitter.com/efekarakus">@efekarakus</a> | Efe walks through the design tenets of the CLI: why they were chosen, how they map to Copilot features, and the vision for how the CLI will evolve in the future. |
| [**Introducing AWS Copilot**](https://aws.amazon.com/blogs/containers/introducing-aws-copilot/) by <a href="https://twitter.com/nathankpeck">@nathankpeck</a> | Nathan explains how with the AWS Copilot CLI you can go from idea to implementation much faster, with the confidence that the infrastructure you have deployed has production-ready configuration. |



## 動画

| タイトル | 概要 |
| ----------- | ------------------------------------ |
| [**Containers from the Couch series**](https://www.youtube.com/c/ContainersfromtheCouch/search?query=copilot) by <a href="https://twitter.com/realadamjkeller">@realadamjkeller</a>, <a href="https://twitter.com/brentContained">@brentContained</a>, and guests | Join Adam and Brent to learn about all the existing features of AWS Copilot with fun demos. From setting up a three-tier application with autoscaling to creating a continuous delivery pipeline with integration tests. |
| [**AWS re:Invent 2020: AWS Copilot: Simplifying container development**](https://youtu.be/EqW--TKQ_PQ) by <a href="https://twitter.com/efekarakus">@efekarakus</a> | Learn about the motivation behind AWS Copilot, get an overview of the existing commands and a demo of how to deploy a three-tier application. |
| [**How to Deploy a .NET Application to Amazon Elastic Container Service (ECS) with AWS Copilot**](https://youtu.be/nWaw8Rp8JgQ) by <a href="https://twitter.com/ignacioafuentes">@ignacioafuentes</a> | Get a demo on how to build and deploy a .NET application on Amazon ECS and AWS Fargate. |
| [**AWS What's Next**](https://www.youtube.com/watch?v=vmTJgVDERZU) by <a href="https://twitter.com/nathankpeck">@nathankpeck</a> and <a href="https://twitter.com/efekarakus">@efekarakus</a> | Nathan and Efe discuss what makes AWS Copilot unique compared to other infrastructure provisioning tools and then demo an overview of the existing commands. |



## コード・サンプル

| リポジトリ | 詳細 | 特徴 |
| ----------- | ------------------------------------ | ------------ |
[**github.com/copilot-example-voting-app**](https://github.com/copilot-example-voting-app) | A voting application distributed over three ECS services created with AWS Copilot. | Amazon Aurora PostgreSQL database, service discovery, autoscaling |
[**#1925**](https://github.com/aws/copilot-cli/discussions/1925) | Show and tell explaining how you can do continuous deployments from branches with AWS Copilot pipelines. | Branch-based deploys, AWS CodePipeline |


## ワークショップ

| タイトル | 詳細 |
| ----------- | ------------------------------------ |
[**ECS Workshop**](https://ecsworkshop.com/microservices/) | In this workshop, we deploy a three tier microservices application using the copilot-cli |
21 changes: 21 additions & 0 deletions site/content/docs/commands/app-delete.ja.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# app delete
```bash
$ copilot app delete [flags]
```

## コマンドの概要

`copilot app delete` Application に関連付けられた全てのリソースを削除します。

## フラグ

```bash
-h, --help help for delete
--yes Skips confirmation prompt.
```

## 実行例
Application を強制的に削除します。
```bash
$ copilot app delete --yes
```
45 changes: 45 additions & 0 deletions site/content/docs/commands/app-init.ja.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# app init
```bash
$ copilot app init [name] [flags]
```

## コマンドの概要
`copilot app init` はコマンドを実行したディレクトリ内に新しい [Application](../concepts/applications.ja.md) を作成します。 Service は Application 内に作成していきます。

質問への回答の後、CLI は、Service 用に作成されたインフラストラクチャーを管理する為の AWS Identity and Access Management ロールを作成します。
作業ディレクトリ配下に新しいサブディレクトリ `copilot/` を確認できます。 `copilot` ディレクトリには Service 用の Manifest ファイルと追加のインフラストラクチャーが格納されます。

`copilot app init` はカスタムドメイン名や AWS タグを利用したい場合に利用します。それ以外の典型的なケースでは、同じ動作をする `copilot init` を利用します。

## フラグ
Copilot CLI における全てのコマンドと同じ様に、必要なフラグを指定しなかった場合、必要な情報を全て入力する様に求められます。
フラグを指定して情報を指定すると、プロンプトをスキップできます。
```bash
--domain string Optional. Your existing custom domain name.
-h, --help help for init
--resource-tags stringToString Optional. Labels with a key and value separated by commas.
Allows you to categorize resources. (default [])
```
`--domain` フラグは、 Application が利用している AWS アカウント上の Amazon Route 53 に登録されたドメイン名を指定します。
これにより Application 内の全てのサービスが同じドメイン名を利用することが出来るようになります。次の例の様に Service に対してアクセス出来るようになります。
[https://{svcName}.{envName}.{appName}.{domain}](https://{svcName}.{envName}.{appName}.{domain})

`--resource-tags` フラグは、Application 内の全てのリソースに対してカスタム[タグ](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html)を追加します。
コマンド例: `copilot app init --resource-tags department=MyDept,team=MyTeam`

## 実行例
"my-app"という名前の新しい Application を作成します。
```bash
$ copilot app init my-app
```
Route 53 に登録済みの既存ドメイン名を利用して新しい Application を作成します。
```bash
$ copilot app init --domain example.com
```
リソースタグを指定して新しい Application を作成します。
```bash
$ copilot app init --resource-tags department=MyDept,team=MyTeam
```
## 出力例

![Running copilot app init](https://raw.githubusercontent.com/kohidave/copilot-demos/master/app-init.edited.svg?sanitize=true)
24 changes: 24 additions & 0 deletions site/content/docs/commands/app-ls.ja.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# app ls
```bash
$ copilot app ls [flags]
```

## コマンドの概要

`copilot app ls` は、AWS アカウントにある全ての Copilot Application を一覧表示します。

## フラグ

```bash
-h, --help help for ls
```

## 実行例
AWS アカウント、リージョンにある全ての Application を一覧表示します。
```bash
$ copilot app ls
```

## 出力例

![Running copilot ls](https://raw.githubusercontent.com/kohidave/copilot-demos/master/app-ls.svg?sanitize=true)
26 changes: 26 additions & 0 deletions site/content/docs/commands/app-show.ja.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# app show
```bash
$ copilot app show [flags]
```

## コマンドの概要

`copilot app show` は Application の設定、Environment、Service を出力します。

## フラグ

```bash
-h, --help help for show
--json Optional. Outputs in JSON format.
-n, --name string Name of the application.
```

## 実行例
"my-app"という Application に関する情報を出力します。
```bash
$ copilot app show -n my-app
```

## 出力例

![Running copilot app show](https://raw.githubusercontent.com/kohidave/copilot-demos/master/app-show.svg?sanitize=true)
34 changes: 34 additions & 0 deletions site/content/docs/commands/completion.ja.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# completion
```
$ copilot completion [shell] [flags]
```

## コマンドの概要
`copilot completion` は、bash や zsh のシェル補完コードを出力します。コマンドをインタラクティブに補完するためには、このコードが評価されなければなりません。

それぞれのシェルで自動補完を設定する方法については、ヘルプメニューを参照してください。

## フラグ
```bash
-h, --help help for completion
```

## 例
zsh の補完をインストールします。
```bash
$ source <(copilot completion zsh)
$ copilot completion zsh > "${fpath[1]}/_copilot" # to autoload on startup
```
bash の補完を homebrew を使って macOS にインストールします。
```bash
$ brew install bash-completion # if running 3.2
$ brew install bash-completion@2 # if running Bash 4.1+
$ copilot completion bash > /usr/local/etc/bash_completion.d
```
Install bash completion on linux
bash の補完を Linux にインストールします。
```bash
$ source <(copilot completion bash)
$ copilot completion bash > copilot.sh
$ sudo mv copilot.sh /etc/bash_completion.d/copilot
```
39 changes: 39 additions & 0 deletions site/content/docs/commands/deploy.ja.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# copilot deploy
```
$ copilot deploy
```

## コマンドの概要

このコマンドは、[`copilot svc deploy`](../commands/svc-deploy.ja.md) または [`copilot job deploy`](../commands/job-deploy.ja.md) の内部で利用されています。
`copilot deploy` の中で実行される各ステップは、`copilot svc deploy` や `copilot job deploy` で実行されるステップと同様です。

1. ローカルの Dockerfile からコンテナイメージを作成
2. `--tag` で指定された値、または最新の git sha を利用してタグ付け(git 管理されている場合)
3. コンテナイメージを ECR に対してプッシュ
4. Manifest ファイルと Addon を CloudFormation テンプレートにパッケージ
5. ECS タスク定義を作成/更新し、Job や Service を作成/更新

## フラグ

```bash
-a, --app string Name of the application.
-e, --env string Name of the environment.
-h, --help help for deploy
-n, --name string Name of the service or job.
--resource-tags stringToString Optional. Labels with a key and value separated by commas.
Allows you to categorize resources. (default [])
--tag string Optional. The container image tag.
```

## 実行例

"frontend"という名前の Service を "test" Environment にデプロイします。
```bash
$ copilot deploy --name frontend --env test
```

"mailer"という名前の Job を、追加のリソースタグを付加して、"prod" Environment にデプロイします。
```bash
$ copilot deploy -n mailer -e prod --resource-tags source/revision=bb133e7,deployment/initiator=manual
```
14 changes: 14 additions & 0 deletions site/content/docs/commands/docs.ja.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# docs
```bash
$ copilot docs [flags]
```

## コマンドの概要

`copilot docs` は、Copilot のドキュメントをブラウザ上で開きます。

## フラグ

```bash
-h, --help help for docs
```
27 changes: 27 additions & 0 deletions site/content/docs/commands/env-delete.ja.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# env delete
```bash
$ copilot env delete [flags]
```

## コマンドの概要
`copilot env delete`は、Applicationから Environment を削除します。 Environment 内に実行中のアプリケーションがある場合は、はじめに [`copilot svc delete`](../commands/svc-delete.ja.md) を実行する必要があります。

質問に答えた後、Environment 用の AWS CloudFormation スタックが削除されたことを確認してください。

## フラグ
```
-h, --help help for delete
-n, --name string Name of the environment.
--yes Skips confirmation prompt.
-a, --app string Name of the application.
```

## 実行例
"test" Environment を削除します。
```bash
$ copilot env delete --name test
```
"test" Environment をプロンプトなしで削除します。
```bash
$ copilot env delete --name test --yes
```
57 changes: 57 additions & 0 deletions site/content/docs/commands/env-init.ja.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
# env init
```bash
$ copilot env init [flags]
```

## コマンドの概要
`copilot env init` は、Service 実行用に新しい [Environment](../concepts/environments.ja.md) を作成します。

質問に答えると、CLI は VPC, Application Load Balancer, ECS Cluster などの Service で共有される共通のインフラストラクチャーを作成します。さらに、デフォルトのリソース設定や既存リソースのインポートなど、[Copilot の Environment をカスタマイズ](../concepts/environments.ja.md#Environment-のカスタマイズ)できます。

[名前付きプロファイル](../credentials.ja.md#Environment-用の認証情報)を使用して、Environment を作成する AWS アカウントとリージョンを指定します。

## フラグ
AWS Copilot CLI の全てのコマンド同様、必須フラグを省略した場合にはそれらの情報の入力をインタラクティブに求められます。必須フラグを明示的に渡してコマンドを実行することでこれをスキップできます。
```
Common Flags
--aws-access-key-id string Optional. An AWS access key.
--aws-secret-access-key string Optional. An AWS secret access key.
--aws-session-token string Optional. An AWS session token for temporary credentials.
--default-config Optional. Skip prompting and use default environment configuration.
-n, --name string Name of the environment.
--prod If the environment contains production services.
--profile string Name of the profile.
--region string Optional. An AWS region where the environment will be created.

Import Existing Resources Flags
--import-private-subnets strings Optional. Use existing private subnet IDs.
--import-public-subnets strings Optional. Use existing public subnet IDs.
--import-vpc-id string Optional. Use an existing VPC ID.

Configure Default Resources Flags
--override-private-cidrs strings Optional. CIDR to use for private subnets (default 10.0.2.0/24,10.0.3.0/24).
--override-public-cidrs strings Optional. CIDR to use for public subnets (default 10.0.0.0/24,10.0.1.0/24).
--override-vpc-cidr ipNet Optional. Global CIDR to use for VPC (default 10.0.0.0/16).

Global Flags
-a, --app string Name of the application.
```

## 実行例
AWS プロファイルの "default" に、デフォルト設定を使用して test Environment を作成します。

```bash
$ copilot env init --name test --profile default --default-config
```

AWS プロファイルの "prod-admin" を利用して既存の VPC に prod-iad Environment を作成します。
```bash
$ copilot env init --name prod-iad --profile prod-admin --prod \
--import-vpc-id vpc-099c32d2b98cdcf47 \
--import-public-subnets subnet-013e8b691862966cf,subnet-014661ebb7ab8681a \
--import-private-subnets subnet-055fafef48fb3c547,subnet-00c9e76f288363e7f
```

## 出力例
![Running copilot env init](https://raw.githubusercontent.com/kohidave/copilot-demos/master/env-init.svg?sanitize=true)

25 changes: 25 additions & 0 deletions site/content/docs/commands/env-ls.ja.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# env ls
```bash
$ copilot env ls [flags]
```

## コマンドの概要
`copilot env ls` は、Application 内の全ての Environment を一覧表示します。

## フラグ
```bash
-h, --help help for ls
--json Optional. Outputs in JSON format.
-a, --app string Name of the application.
```
結果をプログラムでパースしたい場合 `--json` フラグを利用することができます。

## 実行例
frontend Application の全ての Environment を一覧表示します。
```bash
$ copilot env ls -a frontend
```

## 出力例

![Running copilot env ls](https://raw.githubusercontent.com/kohidave/copilot-demos/master/env-ls.svg?sanitize=true)
Loading