refresh

refreshコマンドは、ECSサービスの設定を最新の状態に更新するためのコマンドです。サービス定義やタスク定義を変更せずに、サービスを再起動したい場合に使用します。

基本的な使い方

$ ecspresso refresh [オプション]

オプション

オプション	説明	デフォルト値
`--config`	設定ファイルのパス	`ecspresso.yml`
`--dry-run`	実際に更新せずに実行内容を表示	`false`
`--no-wait`	サービスが安定状態になるのを待たない	`false`
`--suspend-auto-scaling`	デプロイ中に自動スケーリングを一時停止	`false`
`--resume-auto-scaling`	デプロイ後に自動スケーリングを再開	`false`

出力例

2023/01/01 12:00:00 [info] myservice/default Starting refresh
2023/01/01 12:00:00 [info] myservice/default Refreshing service: myservice
2023/01/01 12:00:00 [info] myservice/default Service is stable now. Completed!

使用例

基本的な使用方法

$ ecspresso refresh --config ecspresso.yml

ドライラン

$ ecspresso refresh --config ecspresso.yml --dry-run

安定状態を待たない

$ ecspresso refresh --config ecspresso.yml --no-wait

自動スケーリングを一時停止して再開

$ ecspresso refresh --config ecspresso.yml --suspend-auto-scaling --resume-auto-scaling

リフレッシュプロセス

refreshコマンドは、以下のプロセスでサービスをリフレッシュします：

現在のサービス情報を取得
サービスを更新して、forceNewDeploymentフラグを設定
サービスが安定状態になるまで待機（--no-waitオプションが指定されていない場合）

graph TD
    A[開始] --> B[サービス情報を取得]
    B --> C[forceNewDeploymentフラグを設定]
    C --> D[サービスを更新]
    D --> E{--no-wait?}
    E -->|はい| F[完了]
    E -->|いいえ| G[サービスが安定状態になるまで待機]
    G --> H[完了]

リフレッシュの用途

refreshコマンドは、以下のような場合に役立ちます：

コンテナの再起動: サービスのすべてのコンテナを再起動したい場合
ホストの再配置: タスクを別のホストに再配置したい場合
設定の更新: 環境変数やシークレットの値を更新した場合
問題の解決: サービスに問題が発生し、再起動で解決する可能性がある場合

`refresh`と`deploy --force-new-deployment`の違い

refreshコマンドとdeploy --force-new-deploymentオプションは、どちらもサービスを再起動するために使用できますが、以下の違いがあります：

refreshコマンドは、タスク定義を変更せずにサービスを再起動します
deploy --force-new-deploymentオプションは、新しいタスク定義を登録してからサービスを再起動します

タスク定義を変更せずにサービスを再起動したい場合は、refreshコマンドを使用することをお勧めします。

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

refreshコマンドは、CI/CDパイプラインでサービスを定期的に再起動するのに役立ちます。以下は、GitHub Actionsでの使用例です：

jobs:
  refresh:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - uses: kayac/ecspresso@v2
        with:
          version: v2.3.0
      - run: |
          # サービスをリフレッシュ
          ecspresso refresh --config ecspresso.yml

注意事項

refreshコマンドは、タスク定義を変更せずにサービスを再起動します
--dry-runオプションを使用すると、実際に更新せずに実行内容を確認できます
--no-waitオプションを使用すると、サービスが安定状態になるのを待たずにコマンドを終了できます
--suspend-auto-scalingと--resume-auto-scalingオプションを使用すると、デプロイ中に自動スケーリングを一時停止し、デプロイ後に再開できます
リフレッシュ操作は、サービスの更新として処理されるため、サービスの更新に関連する制限が適用されます
Blue/Greenデプロイメントを使用している場合は、refreshコマンドではなく、deployコマンドを使用する必要があります