もうすぐリリースするecspresso v2.3に入る新機能紹介

SREチームの藤原です。

この記事は面白法人グループ Advent Calendar 2023 4日目の記事です。

今日は、自分が開発・メンテナンスしている Amazon ECS デプロイツール ecspresso の次のバージョンでリリースされる予定の新機能を、予告として紹介したいと思います。

github.com

ecspresso v2.3 に入りそうな新機能

Pull Requestで v2.3 ラベルが付いているものを新機能としてリリースする予定です。

Secrets ManagerのARNを取得する `secretsmanager_arn` テンプレート関数

add secretsmanager plugin by fujiwara · Pull Request #618 · kayac/ecspresso · GitHub

ECSタスクにSecrets Managerで管理している値を環境変数として読み込む場合、secrets.valueFrom属性にシークレット名ではなく、ARNを指定する必要があります。

Secrets ManagerのシークレットARNは、例えば名前が example/foo だった場合には次のように、作成時に末尾にランダムな値が付与されます。例: arn:aws:secretsmanager:ap-northeast-1:123456789012:secret:example/foo-soBS7X (-soBS7Xがランダムな値)

そのため名前を知っているだけではARNを構築することができず、別途 AWS CLI や ecspresso の CloudFormation / tfstate 参照機能などを利用して ARN を取得する必要がありました。

v2.3 で追加予定の secretsmanager_arn テンプレート関数を使用すると、secretsの名前を指定してARNをテンプレートに展開できるため、この手間を省けます。

  "secrets": [
    {
      "name": "EXAMPLE_FOO",
      "valueFrom": "{{ secretsmanager_arn `example/foo` }}"
    }
  ]

`ecspresso run --client-token` 引数をサポート

add run --client-token by fujiwara · Pull Request #631 · kayac/ecspresso · GitHub

先日リリースされた、ECSタスク起動の冪等性をサポートする --client-token 引数を追加します。この引数に任意の値を指定することで、同じ値が指定されて実行された RunTask API の呼び出しが冪等になり、複数回実行しても一回の呼び出しとして扱われることが保証されます。

なおSDKの更新により、引数を指定しない場合には内部でランダムな値の token が生成されて RunTask が呼び出されるようになったため、ECS API が503を返すなどして自動でリトライが行われた場合にも意識せずに冪等になるようになっています。

aws.amazon.com

`ecspresso diff` コマンドで、サービスが存在しない場合にもエラーにならないで差分が表示されるように

diff command works whenever a remote service or a task definition are not found. by fujiwara · Pull Request #632 · kayac/ecspresso · GitHub

これまでは ecspresso diff を実行した場合に比較対象の ECS サービスが存在していない場合には、エラーになっていました。

ecspresso は v2.0 から新規作成とデプロイを区別せず、deploy コマンドで新規作成も更新もできるようになっていましたが、diffコマンドの挙動では区別されていたため、これを変更しました。

v2.3ではECSサービスが存在しない場合、追加のみの差分が表示されるようになります。

デプロイフローに `ecspresso diff` を入れてると、初回デプロイ時に service xx is not found で workflow が止まるのなんとかしたい。
`|| exit 0` でエラーを無視できそうだけど、初回のそのエラーのケース以外は普通にエラーとなってほしい...
— snaka (@snaka) 2023年12月1日