verify

verifyコマンドは、設定ファイル、タスク定義ファイル、サービス定義ファイルの構文と内容を検証するためのコマンドです。デプロイ前に設定の問題を発見するのに役立ちます。

基本的な使い方

$ ecspresso verify [オプション]

オプション

オプション	説明	デフォルト値
`--config`	設定ファイルのパス	`ecspresso.yml`
`--envfile`	環境変数ファイルのパス	-
`--ext-str`	Jsonnet用の外部文字列値	-
`--ext-code`	Jsonnet用の外部コード値	-

検証内容

verifyコマンドは、以下の項目を検証します：

設定ファイル
- 必須フィールドの存在
- フィールドの型
- ファイルパスの有効性
タスク定義ファイル
- JSON/Jsonnet構文
- 必須フィールドの存在
- フィールドの型
- リソース制限の有効性
サービス定義ファイル
- JSON/Jsonnet構文
- 必須フィールドの存在
- フィールドの型
- 設定の整合性

出力例

検証成功時

2023/01/01 12:00:00 [info] myservice/default Starting verify
2023/01/01 12:00:00 [info] myservice/default Loaded config from ecspresso.yml
2023/01/01 12:00:00 [info] myservice/default Loaded task definition from ecs-task-def.json
2023/01/01 12:00:00 [info] myservice/default Loaded service definition from ecs-service-def.json
2023/01/01 12:00:00 [info] myservice/default Verification succeeded!

検証失敗時

2023/01/01 12:00:00 [info] myservice/default Starting verify
2023/01/01 12:00:00 [info] myservice/default Loaded config from ecspresso.yml
2023/01/01 12:00:00 [info] myservice/default Loaded task definition from ecs-task-def.json
2023/01/01 12:00:00 [error] myservice/default Invalid service definition: missing required field "serviceName"
2023/01/01 12:00:00 [error] myservice/default Verification failed!

使用例

基本的な使用方法

$ ecspresso verify --config ecspresso.yml

環境変数ファイルを使用

$ ecspresso verify --config ecspresso.yml --envfile production.env

Jsonnet用の外部変数を指定

$ ecspresso verify --config ecspresso.yml --ext-str IMAGE_TAG=v1.2.3 --ext-str ENV=production

検証エラーの例と解決方法

1. タスク定義の問題

[error] Invalid task definition: CPU and Memory values required for Fargate

解決方法: タスク定義にcpuとmemoryフィールドを追加します。

{
  "family": "myservice",
  "cpu": "256",
  "memory": "512",
  // ...
}

2. サービス定義の問題

[error] Invalid service definition: networkConfiguration required for awsvpc network mode

解決方法: サービス定義にnetworkConfigurationフィールドを追加します。

{
  "networkConfiguration": {
    "awsvpcConfiguration": {
      "subnets": [
        "subnet-12345678",
        "subnet-87654321"
      ],
      "securityGroups": [
        "sg-12345678"
      ],
      "assignPublicIp": "DISABLED"
    }
  }
}

3. 設定ファイルの問題

[error] Invalid config: service_definition file not found

解決方法: 設定ファイルで指定されたサービス定義ファイルが存在することを確認します。

region: ap-northeast-1
cluster: default
service: myservice
service_definition: ecs-service-def.json  # このファイルが存在することを確認
task_definition: ecs-task-def.json

CI/CDパイプラインでの使用

verifyコマンドは、CI/CDパイプラインでデプロイ前の検証に役立ちます。以下は、GitHub Actionsでの使用例です：

jobs:
  verify:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - uses: kayac/ecspresso@v2
        with:
          version: v2.3.0
      - run: |
          ecspresso verify --config ecspresso.yml

注意事項

verifyコマンドは、ローカルファイルの検証のみを行い、AWSリソースとの整合性は確認しません
テンプレート変数を使用している場合は、--envfileまたは--ext-strオプションで値を指定する必要があります
Jsonnetファイルを使用している場合は、--ext-strまたは--ext-codeオプションで外部変数を渡すことができます
verifyコマンドは、デプロイ前の問題を発見するために使用することをお勧めします
CI/CDパイプラインでverifyコマンドを実行することで、問題のある設定がデプロイされるのを防ぐことができます