コンテンツにスキップ

Environment

はじめて copilot init コマンドを実行すると、あわせて test Environment を作成するかを尋ねられます。この test Environment にはセキュアなネットワーク(e.g. VPC、サブネット、セキュリティグループ)を作成するために必要な AWS リソースや、複数の Service での共有を目的とした Application Load Balancer や ECS クラスタのようなリソースも含まれます。Service をこの test Environment にデプロイすると、この Service は test Environment のネットワークやリソースを利用します。Application は複数の Environment を持つことができ、それぞれが互いに独立したネットワークやその他のインフラストラクチャリソースを持ちます。

あなたの Copilot の利用開始にあわせて Copilot は test Environment (テスト環境)を作成しますが、これとは異なる Environment、例えば production Environment (本番環境)を新たに作るというのはごく一般的なことでしょう。この production Environment は test Environment とは完全に独立したもので、production Environment 用のネットワークスタックやそこにデプロイされる Service を持ちます。独立したテスト環境と本番環境を持つことで、まずはテスト環境にデプロイし、問題ないことを確認した上で本番環境にデプロイするというオペレーションが可能になります。

下に載せた図は、API と Backend という２つの Service を持つ MyApp という Application を表しています。これら２つの Service は test と production という２つの Environment にデプロイされています。test Environment では両方の Service が１つのコンテナを実行している一方で、production Environment ではそれぞれが３つのコンテナを実行しているのが分かるでしょうか。このように、Service はデプロイ先の Environment ごとに異なる設定を持つことができます。詳しくは環境変数の利用ガイドもご覧ください。

Environment の作成

Application 内に新しい Environment を作るには、作業ディレクトリにて copilot env init コマンドを実行します。コマンドを実行すると、作成する Environment の名前、そしてこの Environment の作成に利用する AWS プロファイルを Copilot が尋ねます。このプロファイルは AWS 名前付きプロファイルと呼ばれるもので、特定の AWS アカウントやリージョンと紐づいた設定です。プロファイルを選ぶと、その新しい Environment は選択されたプロファイルと紐づいた AWS アカウントとリージョンに作成されます。 

$ copilot env init

copilot env init コマンドの実行後は、Copilot が 2 つの IAM ロールをセットアップしている様子を確認できます。その 2 つのロールは Environment の更新と管理に必要なものです。Environment が Application と異なる AWS アカウントで作成された場合、Envrionment は Application アカウントにリンクされます。これにより、今後 Copilot コマンドを実行するユーザーがこの Environment アカウントそのものにアクセスができなくとも Application にリンクされた Environment として管理できるようになります。Copilot は copilot/environments/[env name]/manifest.yml に Environment Manifest を作成します。

Environment のデプロイ

デプロイをする前に、必要であれば、Environment Manifestを修正して Environment を設定します。 

$ copilot env deploy
このステップでは、 Copilot は Environment のインフラストラクチャーリソース、例えば ECS クラスター、セキュリティグループ、プライベート DNS 名前空間を作成します。デプロイ後は、Envrionment Manifest を修正し、再び copilot env deploy を実行するだけで、再デプロイできます。

Service のデプロイ

新しい Environment を作った時点ではまだデプロイされた Service はありません。デプロイしたい Service のディレクトリから copilot deploy コマンドを実行すると、どの Environment にデプロイしたいのかを尋ねられます。

Environment インフラストラクチャ

VPC やネットワークリソース

各 Environment はそれぞれがマルチ AZ 構成の VPC を持ちます。VPC は Environment のネットワーク上の境界であり、VPC 内に入ってくるあるいは出ていくトラフィックを許可する、またはブロックするものとして機能します。Copilot は VPC を２つのアベイラビリティゾーンにまたがって作成します。AWS best practicesに従い、各 AZ はパブリックとプライベートサブネットがあります。 デフォルトでは、Service はパブリックサブネットで起動します。ただし、セキュリティのために、Environment 内の他のサービスからのアクセスのみに制限されています。ECS タスクはパブリックサブネットに配置され、NAT ゲートウエイを必要としないインターネットへのアクセスを許可することでコストを管理するのに役立ちます。

ワークロードサブネットの配置は Manifest 内のnetwork.vpc.placementフィールドで変更できます。

ロードバランサーと DNS

Load Balanced Web Service または、Manifest に http フィールドを記載した Backend Service を作ると、Copilot は Environment 内の負荷分散する Service で共有される Application Load Balancer を作成します。Load Balanced Web Service の ALB は、インターネットからアクセス可能です。それに対して、Backend Service の ALB は内部向けです。Load Balancer は VPC 内の他の Copilot Service と通信可能です。

所有するドメイン名を Route 53 に登録するよう、Application 作成時にオプションとして設定できます。ドメイン名の利用が設定されている場合、Copilot は各 Environment の作成時に environment-name.app-name.your-domain.com のような形でサブドメインを登録し、ACM を通して発行した証明書を Application Load Balancer に設定します。これにより Service が HTTPS を利用できるようになります。

Manifest で httpフィールドが設定された Backend Service が Environment 内にデプロイされる場合、内部 ALB が作成されます。HTTPS のエンドポイントを利用する場合は、copilot env init を実行する際に、--import-cert-arns フラグを使用してください。そして、 プライベートサブネットのみの VPC をインポートします。内部 ALB に関する詳細はこちらを確認してください。

すでに VPC 内に ALB があり、Copilot が ALB を作成する代わりに既存の ALB を利用したい場合、Environment へデプロイする前に、Load Balanced Web Service (インターネット向け ALB) または、Backend Service (内部向け ALB) の Manifest で既存の ALB の名前または ARN を指定してください。

http:
  path: '/'
  alb: [name or ARN]

インポートされた ALB は、すべての Load Balanced Web Service 間で共有されるのではなく、既存の ALB をインポートした Service にのみ関連付けられます。

Environment のカスタマイズ

既存の Environment リソースをインポートする、コマンドでフラグを使う、Environment Manifest を変更するといった方法で、デフォルトの設定をすることができます。もし、現在設定可能なリソースよりも多くの種類のリソースをカスタマイズしたい場合は、お気軽にユースケースを添えた GitHub イシューを作成してください！

もっと詳しく知りたい方は、Environment のリソースをカスタマイズするページをご覧ください。

Environment の中身を掘り下げてみよう

Environment のセットアップが完了したので、Copilot を使って確認してみましょう。確認の手段として以下のような方法がよく利用されます。

Application 内にある Environment の一覧を確認したい

Application 内にある全ての Environment を確認するには copilot env ls コマンドを利用します。

$ copilot env ls
test
production

Environment に含まれるものを確認したい

copilot env show コマンドを実行すると、Environment のサマリ情報を表示します。以下は test Environment についての情報を確認する出力の例ですが、この Environment が作成されたアカウントやリージョン情報、あるいはデプロイされた Service や Environment 内のリソースに付与されるリソースタグ情報などが含まれます。さらに、--resources フラグを利用することでこの Environment に紐づけられたすべての AWS リソースを確認できます。

$ copilot env show --name test
About

  Name              test
  Region            us-west-2
  Account ID        693652174720

Workloads

  Name              Type
  ----              ----
  api               Load Balanced Web Service
  backend           Backend Service


Tags

  Key                  Value
  ---                  -----
  copilot-application  my-app
  copilot-environment  test