Argo Rollouts

手順

1. クラスター管理者として OpenShift Container Platform Web コンソールにログインします。
2. Administrator パースペクティブで、Operators → Installed Operators をクリックします。
3. Project ドロップダウンメニューから、RolloutManager カスタムリソース (CR) を作成および設定するプロジェクトを作成または選択します。
4. インストールされた Operator から Red Hat OpenShift GitOps を選択します。
5. Details タブの Provided APIs セクションで、RolloutManager ペインの Create instance をクリックします。

6. Create RolloutManager ページで YAML view を選択し、デフォルトの YAML を使用するか、要件に応じて編集します。

   例: RolloutManager CR

   apiVersion: argoproj.io/v1alpha1
   kind: RolloutManager
   metadata:
     name: argo-rollout
     labels:
       example: basic
   spec: {}

7. Create をクリックします。
8. RolloutManager タブの RolloutManagers セクションで、RolloutManager インスタンスの Status フィールドに Phase: Available と表示されていることを確認します。

9. 左側のナビゲーションペインで、namespace をスコープとしたサポートリソースの作成を確認します。

   • Workloads → Deployments をクリックして、argo-rollouts デプロイメントが使用可能で、Status に 1 of 1 pods が実行中と表示されていることを確認します。
   • Workloads → Secrets をクリックして、argo-rollouts-notification-secret シークレットが使用可能であることを確認します。
   • Networking → Services をクリックして、argo-rollouts-metrics サービスが利用可能であることを確認します。
   • User Management → Roles をクリックして、argo-rollouts ロール、argo-rollouts-aggregate-to-admin、argo-rollouts-aggregate-to-edit、および argo-rollouts-aggregate-to-view クラスターロールが使用可能であることを確認します。
   • User Management → RoleBindings をクリックして、argo-rollouts ロールバインディングが使用可能であることを確認します。

手順

1. クラスター管理者として OpenShift Container Platform Web コンソールにログインします。
2. Administrator パースペクティブで、Operators → Installed Operators をクリックします。
3. Project ドロップダウンメニューをクリックし、RolloutManager CR を含むプロジェクトを選択します。
4. インストールされた Operator から Red Hat OpenShift GitOps を選択します。
5. RolloutManager タブをクリックして、RolloutManagers セクションで RolloutManager インスタンスを見つけます。
6. インスタンスをクリックします。
7. ドロップダウンメニューから Actions → Delete RolloutManager をクリックし、ダイアログボックスで Delete をクリックして確認します。
8. RolloutManager タブの RolloutManagers セクションで、RolloutManager インスタンスが使用できないことを確認します。

9. 左側のナビゲーションペインで、namespace をスコープとするサポートリソースが削除されていることを確認します。

   • Workloads → Deployments をクリックして、argo-rollouts デプロイメントが削除されていることを確認します。
   • Workloads → Secrets をクリックして、argo-rollouts-notification-secret シークレットが削除されていることを確認します。
   • Networking → Services をクリックして、argo-rollouts-metrics サービスが削除されていることを確認します。
   • User Management → Roles をクリックして、argo-rollouts ロールと、クラスターロール argo-rollouts-aggregate-to-admin、argo-rollouts-aggregate-to-edit、および argo-rollouts-aggregate-to-view が削除されていることを確認します。
   • User Management → RoleBindings をクリックして、argo-rollouts ロールバインディングが削除されていることを確認します。

手順

1. 次のコマンドを実行して、Argo Rollouts CLI バイナリー kubectl-argo-rollouts の最新バージョンをダウンロードします。

   $ curl -LO https://github.com/argoproj/argo-rollouts/releases/latest/download/kubectl-argo-rollouts-linux-amd64

2. 次のコマンドを実行して、kubectl-argo-rollouts バイナリーが実行可能であることを確認します。

   $ chmod +x ./kubectl-argo-rollouts-linux-amd64

3. 次のコマンドを実行して、kubectl-argo-rollouts バイナリーをシステムパスに移動します。

   # mv ./kubectl-argo-rollouts-linux-amd64 /usr/local/bin/kubectl-argo-rollouts

   重要

   このコマンドを実行するには、スーパーユーザー権限が割り当てられていることを確認してください。

4. 次のコマンドを実行して同様の出力を受け取り、プラグインが正しくインストールされていることを確認します。

   $ oc argo rollouts version

   出力例

   kubectl-argo-rollouts: v1.6.6+737ca89
     BuildDate: 2024-02-13T15:39:31Z 

   1

   
     GitCommit: 737ca89b42e4791e96e05b438c2b8540737a2a1a
     GitTreeState: clean
     GoVersion: go1.20.14 

   2

   
     Compiler: gc
     Platform: linux/amd64 

   3

   1

   Argo Rollouts バイナリーの構築の日付情報。

   2

   Argo Rollouts バイナリーの構築に使用される Go 言語のバージョン。

   3

   Argo Rollouts バイナリーの構築に使用されるプラットフォーム。

手順

1. Web コンソールの Administrator パースペクティブで、Operator → Installed Operator → Red Hat OpenShift GitOps → Rollout をクリックします。
2. Project ドロップダウンメニューから、Rollout カスタムリソース (CR) を作成および設定するプロジェクトを作成または選択します。

3. Create Rollout をクリックし、YAML ビューに以下の設定を入力します。

   apiVersion: argoproj.io/v1alpha1
   kind: Rollout
   metadata:
     name: rollouts-demo
   spec:
     replicas: 5
     strategy:
       canary: 

   1

   
         steps: 

   2

   
         - setWeight: 20 

   3

   
         - pause: {}  

   4

   
         - setWeight: 40
         - pause: {duration: 45}  

   5

   
         - setWeight: 60
         - pause: {duration: 20}
         - setWeight: 80
         - pause: {duration: 10}
     revisionHistoryLimit: 2
     selector:
       matchLabels:
         app: rollouts-demo
     template: 

   6

   
       metadata:
         labels:
           app: rollouts-demo
       spec:
         containers:
         - name: rollouts-demo
           image: argoproj/rollouts-demo:blue
           ports:
           - name: http
             containerPort: 8080
             protocol: TCP
           resources:
             requests:
               memory: 32Mi
               cpu: 5m

   1

   ロールアウトで使用する必要のあるデプロイメントストラテジー。

   2

   ロールアウトの手順を指定します。この例では、トラフィックの 20%、40%、60%、80% を段階的にカナリアバージョンにルーティングします。

   3

   カナリアバージョンに送信する必要があるトラフィックの割合。値が 20 の場合、トラフィックの 20% がカナリアバージョンに送信されることを意味します。

   4

   プロモーションのリクエストが見つかるまで Argo Rollouts コントローラーに、無期限に一時停止するように指定します。

   5

   Argo Rollouts コントローラーに 45 秒間一時停止するように指定します。期間の値は、秒 (s)、分 (m)、または時間 (h) で設定できます。たとえば、1 時間の場合は 1h と指定できます。値が指定されていない場合、期間の値はデフォルトで秒になります。

   6

   作成する Pod を指定します。

4. Create をクリックします。

   注記

   ロールアウトが作成時にすぐに利用できるように、Argo Rollouts コントローラーは、.spec.template.spec.containers.image フィールドで指定された argoproj/rollouts-demo:blue の初期コンテナーイメージを安定バージョンとして自動的に扱います。最初のインスタンスでは、Rollout リソースの作成により、すべてのトラフィックがアプリケーションの安定バージョンにルーティングされ、トラフィックがカナリアバージョンに送信される部分がスキップされます。ただし、.spec.template.spec.containers.image フィールドに変更を加えた以降のすべてのアプリケーションアップグレードでは、Argo Rollouts コントローラーは通常どおりカナリアの手順を実行します。

5. 次のコマンドを実行して、ロールアウトが正しく作成されたことを確認します。

   $ oc argo rollouts list rollouts -n <namespace> 

   1

   1

   Rollout リソースが定義されている namespace を指定します。

   出力例

   NAME           STRATEGY   STATUS        STEP  SET-WEIGHT  READY  DESIRED  UP-TO-DATE  AVAILABLE
   rollouts-demo  Canary     Healthy       8/8   100         5/5    5        5           5

6. rollouts-demo ロールアウトをターゲットとする Kubernetes サービスを作成します。

   1. Web コンソールの Administrator パースペクティブで、Networking → Services をクリックします。

   2. Create Service をクリックし、YAML ビューに次の設定を入力します。

      apiVersion: v1
      kind: Service
      metadata:
        name: rollouts-demo
      spec:
        ports: 

      1

      
        - port: 80
          targetPort: http
          protocol: TCP
          name: http
      
        selector: 

      2

      
          app: rollouts-demo

      1

      コンテナー内で実行するためにアプリケーションが使用するポートの名前を指定します。

      2

      selector フィールドの内容が Rollout カスタムリソース (CR) の内容と同じであることを確認します。

   3. Create をクリックします。

      ロールアウトは、作成されたサービスをカナリア ReplicaSet の Pod テンプレートハッシュで自動的に更新します。例: rollouts-pod-template-hash: 687d76d795

7. 次のコマンドを実行して、ロールアウトの進行状況を確認します。

   $ oc argo rollouts get rollout rollouts-demo --watch -n <namespace> 

   1

   1

   Rollout リソースが定義されている namespace を指定します。

   出力例

   Name:            rollouts-demo
   Namespace:       spring-petclinic
   Status:          ✔ Healthy
   Strategy:        Canary
     Step:          8/8
     SetWeight:     100
     ActualWeight:  100
   Images:          argoproj/rollouts-demo:blue (stable)
   Replicas:
     Desired:       5
     Current:       5
     Updated:       5
     Ready:         5
     Available:     5
   
   NAME                                       KIND        STATUS     AGE    INFO
   ⟳ rollouts-demo                            Rollout     ✔ Healthy  4m50s
   └──# revision:1
      └──⧉ rollouts-demo-687d76d795           ReplicaSet  ✔ Healthy  4m50s  stable
         ├──□ rollouts-demo-687d76d795-75k57  Pod         ✔ Running  4m49s  ready:1/1
         ├──□ rollouts-demo-687d76d795-bv5zf  Pod         ✔ Running  4m49s  ready:1/1
         ├──□ rollouts-demo-687d76d795-jsxg8  Pod         ✔ Running  4m49s  ready:1/1
         ├──□ rollouts-demo-687d76d795-rsgtv  Pod         ✔ Running  4m49s  ready:1/1
         └──□ rollouts-demo-687d76d795-xrmrj  Pod         ✔ Running  4m49s  ready:1/1

   ロールアウトの作成後、ロールアウトの Status フィールドに Phase: Healthy が表示されることを確認できます。

8. Rollout タブの Rollouts セクションで、rollouts-demo ロールアウトの Status フィールドに Phase: Healthy が表示されていることを確認します。

   ヒント

   または、以下のコマンドを実行して、ロールアウトが正常であることを確認できます。

   $ oc argo rollouts status rollouts-demo -n <namespace> 

   1

   1

   Rollout リソースが定義されている namespace を指定します。

   出力例

   Healthy

手順

1. ロールアウトでデプロイされたコンテナーイメージを変更して、アプリケーションの新しいカナリアバージョンをシミュレートします。

   1. Web コンソールの Administrator パースペクティブで、Operator → Installed Operator → Red Hat OpenShift GitOps → Rollout に移動します。
   2. 既存の rollouts-demo ロールアウトを選択し、YAML ビューで .spec.template.spec.containers.image の値を argoproj/rollouts-demo:blue から argoproj/rollouts-demo:yellow に変更します。

   3. Save、Reload の順にクリックします。

      ロールアウトでデプロイされたコンテナーイメージが変更され、ロールアウトによって新しいカナリアデプロイメントが開始されます。

      注記

      Rollout CR の .spec.strategy.canary.steps フィールドで定義されている setWeight プロパティーに従って、最初にルートへのトラフィックの 20% がカナリアバージョンに到達し、ロールアウトは、プロモーションのリクエストが受信されるまで無期限に一時停止されます。

      トラフィックの 20% がカナリアバージョンに向けられ、後続のステップでプロモーションのリクエストが指定されるまでロールアウトが無期限に一時停止されるルートの例

      spec:
        replicas: 5
        strategy:
          canary: 

      1

      
            steps: 

      2

      
            - setWeight: 20 

      3

      
            - pause: {}  

      4

      
        # (...)

      1

      ロールアウトで使用する必要のあるデプロイメントストラテジー。

      2

      ロールアウトの手順です。この例では、トラフィックの 20%、40%、60%、80% を段階的にカナリアバージョンにルーティングします。

      3

      カナリアバージョンに送信する必要があるトラフィックの割合。値が 20 の場合、トラフィックの 20% がカナリアバージョンに送信されることを意味します。

      4

      プロモーションのリクエストが見つかるまで、Argo Rollouts コントローラーを無期限に一時停止する仕様。

2. 次のコマンドを実行して、ロールアウトの進行状況を確認します。

   $ oc argo rollouts get rollout rollouts-demo --watch -n <namespace> 

   1

   1

   Rollout CR が定義されている namespace を指定します。

   出力例

   Name:            rollouts-demo
   Namespace:       spring-petclinic
   Status:          ॥ Paused
   Message:         CanaryPauseStep
   Strategy:        Canary
     Step:          1/8
     SetWeight:     20
     ActualWeight:  20
   Images:          argoproj/rollouts-demo:blue (stable)
                    argoproj/rollouts-demo:yellow (canary)
   Replicas:
     Desired:       5
     Current:       5
     Updated:       1
     Ready:         5
     Available:     5
   
   NAME                                       KIND        STATUS     AGE    INFO
   ⟳ rollouts-demo                            Rollout     ॥ Paused   9m51s
   ├──# revision:2
   │  └──⧉ rollouts-demo-6cf78c66c5           ReplicaSet  ✔ Healthy  99s    canary
   │     └──□ rollouts-demo-6cf78c66c5-zrgd4  Pod         ✔ Running  98s    ready:1/1
   └──# revision:1
      └──⧉ rollouts-demo-687d76d795           ReplicaSet  ✔ Healthy  9m51s  stable
         ├──□ rollouts-demo-687d76d795-75k57  Pod         ✔ Running  9m50s  ready:1/1
         ├──□ rollouts-demo-687d76d795-jsxg8  Pod         ✔ Running  9m50s  ready:1/1
         ├──□ rollouts-demo-687d76d795-rsgtv  Pod         ✔ Running  9m50s  ready:1/1
         └──□ rollouts-demo-687d76d795-xrmrj  Pod         ✔ Running  9m50s  ready:1/1

   ロールアウトの更新ストラテジー設定で一時停止期間が指定されていないため、ロールアウトは現在一時停止状態になっています。

3. 前の手順を繰り返して、新しくデプロイされたアプリケーションのバージョンをテストし、期待どおりに動作することを確認します。たとえば、ブラウザーを使用してアプリケーションの操作、アプリケーションの検証、テストの実行、コンテナーログの確認を行います。

   ロールアウトは、次のステップに進むまで、一時停止されたままになります。

手順

1. Argo Rollouts CLI で次のコマンドを実行して、アプリケーションの別のカナリアバージョンを新たにシミュレートします。

   $ oc argo rollouts promote rollouts-demo -n <namespace> 

   1

   1

   Rollout リソースが定義されている namespace を指定します。

   出力例

   rollout 'rollouts-demo' promoted

   これにより、カナリアバージョンではトラフィックの重みが 40% に増加します。

2. 次のコマンドを実行して、ロールアウトが残りの手順で進行していることを確認します。

   $ oc argo rollouts get rollout rollouts-demo -n <namespace> --watch 

   1

   1

   Rollout リソースが定義されている namespace を指定します。

   Rollout CR で定義されている残りのステップには、pause: {duration: 45} などのように期間が設定されているため、Argo Rollouts コントローラーは指定の期間待機してから、自動的に次のステップに進みます。

   すべての手順が正常に完了すると、新しい ReplicaSet オブジェクトが安定したレプリカセットとしてマークされます。

   出力例

   Name:            rollouts-demo
   Namespace:       spring-petclinic
   Status:          ✔ Healthy
   Strategy:        Canary
     Step:          8/8
     SetWeight:     100
     ActualWeight:  100
   Images:          argoproj/rollouts-demo:yellow (stable)
   Replicas:
     Desired:       5
     Current:       5
     Updated:       5
     Ready:         5
     Available:     5
   
   NAME                                       KIND        STATUS        AGE   INFO
   ⟳ rollouts-demo                            Rollout     ✔ Healthy     14m
   ├──# revision:2
   │  └──⧉ rollouts-demo-6cf78c66c5           ReplicaSet  ✔ Healthy     6m5s  stable
   │     ├──□ rollouts-demo-6cf78c66c5-zrgd4  Pod         ✔ Running     6m4s  ready:1/1
   │     ├──□ rollouts-demo-6cf78c66c5-g9kd5  Pod         ✔ Running     2m4s  ready:1/1
   │     ├──□ rollouts-demo-6cf78c66c5-2ptpp  Pod         ✔ Running     78s   ready:1/1
   │     ├──□ rollouts-demo-6cf78c66c5-tmk6c  Pod         ✔ Running     58s   ready:1/1
   │     └──□ rollouts-demo-6cf78c66c5-zv6lx  Pod         ✔ Running     47s   ready:1/1
   └──# revision:1
      └──⧉ rollouts-demo-687d76d795           ReplicaSet  • ScaledDown  14m

手順

1. Argo Rollouts CLI で次のコマンドを実行して、コンテナーイメージのバージョンを更新し、.spec.template.spec.containers.image の値を argoproj/rollouts-demo:yellow から argoproj/rollouts-demo:red に変更します。

   $ oc argo rollouts set image rollouts-demo rollouts-demo=argoproj/rollouts-demo:red -n <namespace> 

   1

   1

   ロールアウト カスタムリソース (CR) が定義されている namespace を指定します。

   出力例

   rollout "rollouts-demo" image updated

   ロールアウトでデプロイされたコンテナーイメージが変更され、ロールアウトによって新しいカナリアデプロイメントが開始されます。

2. ロールアウトが一時停止状態になるまで待ちます。

3. 次のコマンドを実行して、ロールアウトによって rollouts-demo:red カナリアバージョンがデプロイされ、一時停止ステータスに到達したことを確認します。

   $ oc argo rollouts get rollout rollouts-demo --watch -n <namespace> 

   1

   1

   Rollout CR が定義されている namespace を指定します。

   出力例

   Name:            rollouts-demo
   Namespace:       spring-petclinic
   Status:          ॥ Paused
   Message:         CanaryPauseStep
   Strategy:        Canary
     Step:          1/8
     SetWeight:     20
     ActualWeight:  20
   Images:          argoproj/rollouts-demo:red (canary)
                    argoproj/rollouts-demo:yellow (stable)
   Replicas:
     Desired:       5
     Current:       5
     Updated:       1
     Ready:         5
     Available:     5
   
   NAME                                       KIND        STATUS        AGE    INFO
   ⟳ rollouts-demo                            Rollout     ॥ Paused      17m
   ├──# revision:3
   │  └──⧉ rollouts-demo-5747959bdb           ReplicaSet  ✔ Healthy     75s    canary
   │     └──□ rollouts-demo-5747959bdb-fdrsg  Pod         ✔ Running     75s    ready:1/1
   ├──# revision:2
   │  └──⧉ rollouts-demo-6cf78c66c5           ReplicaSet  ✔ Healthy     9m45s  stable
   │     ├──□ rollouts-demo-6cf78c66c5-zrgd4  Pod         ✔ Running     9m44s  ready:1/1
   │     ├──□ rollouts-demo-6cf78c66c5-2ptpp  Pod         ✔ Running     4m58s  ready:1/1
   │     ├──□ rollouts-demo-6cf78c66c5-tmk6c  Pod         ✔ Running     4m38s  ready:1/1
   │     └──□ rollouts-demo-6cf78c66c5-zv6lx  Pod         ✔ Running     4m27s  ready:1/1
   └──# revision:1
      └──⧉ rollouts-demo-687d76d795           ReplicaSet  • ScaledDown  17m

4. 以下のコマンドを実行してロールアウトの更新を停止します。

   $ oc argo rollouts abort rollouts-demo -n <namespace> 

   1

   1

   Rollout CR が定義されている namespace を指定します。

   出力例

   rollout 'rollouts-demo' aborted

   Argo Rollouts コントローラーは、アプリケーションのカナリアリソースを削除し、安定バージョンにロールバックします。

5. ロールアウトを中止した後、次のコマンドを実行して、カナリア ReplicaSet が 0 レプリカにスケーリングされていることを確認します。

   $ oc argo rollouts get rollout rollouts-demo --watch -n <namespace> 

   1

   1

   Rollout CR が定義されている namespace を指定します。

   出力例

   Name:            rollouts-demo
   Namespace:       spring-petclinic
   Status:          ✖ Degraded
   Message:         RolloutAborted: Rollout aborted update to revision 3
   Strategy:        Canary
     Step:          0/8
     SetWeight:     0
     ActualWeight:  0
   Images:          argoproj/rollouts-demo:yellow (stable)
   Replicas:
     Desired:       5
     Current:       5
     Updated:       0
     Ready:         5
     Available:     5
   
   NAME                                       KIND        STATUS        AGE    INFO
   ⟳ rollouts-demo                            Rollout     ✖ Degraded    24m
   ├──# revision:3
   │  └──⧉ rollouts-demo-5747959bdb           ReplicaSet  • ScaledDown  7m38s  canary
   ├──# revision:2
   │  └──⧉ rollouts-demo-6cf78c66c5           ReplicaSet  ✔ Healthy     16m    stable
   │     ├──□ rollouts-demo-6cf78c66c5-zrgd4  Pod         ✔ Running     16m    ready:1/1
   │     ├──□ rollouts-demo-6cf78c66c5-2ptpp  Pod         ✔ Running     11m    ready:1/1
   │     ├──□ rollouts-demo-6cf78c66c5-tmk6c  Pod         ✔ Running     11m    ready:1/1
   │     ├──□ rollouts-demo-6cf78c66c5-zv6lx  Pod         ✔ Running     10m    ready:1/1
   │     └──□ rollouts-demo-6cf78c66c5-mlbsh  Pod         ✔ Running     4m47s  ready:1/1
   └──# revision:1
      └──⧉ rollouts-demo-687d76d795           ReplicaSet  • ScaledDown  24m

   ロールアウトステータスは Degraded としてマークされています。これは、アプリケーションが以前の安定バージョン (yellow) にロールバックされているにもかかわらず、ロールアウトが現在、.spec.template.spec.containers.image フィールド内で設定された、希望のバージョン (red) ではないことを示しています。

   注記

   Degraded ステータスは、アプリケーションの正常性を反映しません。これは、必要なコンテナーイメージのバージョンと実行中のコンテナーイメージのバージョンが一致していないことを示しているだけです。

6. コンテナーイメージのバージョンを以前の安定バージョン yellow に更新し、次のコマンドを実行して .spec.template.spec.containers.image の値を変更します。

   $ oc argo rollouts set image rollouts-demo rollouts-demo=argoproj/rollouts-demo:yellow -n <namespace> 

   1

   1

   Rollout CR が定義されている namespace を指定します。

   出力例

   rollout "rollouts-demo" image updated

   ロールアウトでは、分析とプロモーションの手順がスキップされ、以前の安定したバージョン yellow にロールバックされ、安定した ReplicaSet のデプロイを早い段階で行うことができます。

7. 次のコマンドを実行して、ロールアウトのステータスが Healthy としてマークされていることを確認します。

   $ oc argo rollouts get rollout rollouts-demo --watch -n <namespace> 

   1

   1

   Rollout CR が定義されている namespace を指定します。

   出力例

   Name:            rollouts-demo
   Namespace:       spring-petclinic
   Status:          ✔ Healthy
   Strategy:        Canary
     Step:          8/8
     SetWeight:     100
     ActualWeight:  100
   Images:          argoproj/rollouts-demo:yellow (stable)
   Replicas:
     Desired:       5
     Current:       5
     Updated:       5
     Ready:         5
     Available:     5
   
   NAME                                       KIND        STATUS        AGE  INFO
   ⟳ rollouts-demo                            Rollout     ✔ Healthy     63m
   ├──# revision:4
   │  └──⧉ rollouts-demo-6cf78c66c5           ReplicaSet  ✔ Healthy     55m  stable
   │     ├──□ rollouts-demo-6cf78c66c5-zrgd4  Pod         ✔ Running     55m  ready:1/1
   │     ├──□ rollouts-demo-6cf78c66c5-2ptpp  Pod         ✔ Running     50m  ready:1/1
   │     ├──□ rollouts-demo-6cf78c66c5-tmk6c  Pod         ✔ Running     50m  ready:1/1
   │     ├──□ rollouts-demo-6cf78c66c5-zv6lx  Pod         ✔ Running     50m  ready:1/1
   │     └──□ rollouts-demo-6cf78c66c5-mlbsh  Pod         ✔ Running     44m  ready:1/1
   ├──# revision:3
   │  └──⧉ rollouts-demo-5747959bdb           ReplicaSet  • ScaledDown  46m
   └──# revision:1
      └──⧉ rollouts-demo-687d76d795           ReplicaSet  • ScaledDown  63m

手順

1. Route オブジェクトを作成します。

   1. Web コンソールの Administrator パースペクティブで、Networking → Routes をクリックします。
   2. Create Route をクリックします。

   3. Create Route ページで、YAML view をクリックし、以下のスニペットを追加します。以下の例では、rollouts-demo-route というルートを作成します。

      apiVersion: route.openshift.io/v1
      kind: Route
      metadata:
        name: rollouts-demo-route
      spec:
        port:
          targetPort: http 

      1

      
        tls: 

      2

      
          insecureEdgeTerminationPolicy: Redirect
          termination: edge
        to:
          kind: Service
          name: argo-rollouts-stable-service 

      3

      
          weight: 100 

      4

      
      
        alternateBackends:
          - kind: Service
            name: argo-rollouts-canary-service 

      5

      
            weight: 0 

      6

      1

      コンテナー内で実行するためにアプリケーションが使用するポートの名前を指定します。

      2

      ルートを保護するために使用される TLS 設定を指定します。

      3

      対象となる安定したサービスの名前。

      4

      このフィールドは、Route Rollout プラグインによって安定した重みに自動的に変更されます。

      5

      対象となるカナリアサービスの名前。

      6

      このフィールドは、Route Rollout プラグインにより、カナリアの重みに自動的に変更されます。

   4. Create をクリックしてルートを作成します。その後、Routes ページに表示されます。

2. ルートで参照されるサービス (カナリアおよび安定) を作成します。

   1. Web コンソールの Administrator パースペクティブで、Networking → Services をクリックします。
   2. Create Service をクリックします。

   3. Create Service ページで、YAML view をクリックし、以下のスニペットを追加します。以下の例では、argo-rollouts-canary-service という名前のカナリアサービスを作成します。カナリアトラフィックはこのサービスに転送されます。

      apiVersion: v1
      kind: Service
      metadata:
        name: argo-rollouts-canary-service
      spec:
        ports: 

      1

      
        - port: 80
          targetPort: http
          protocol: TCP
          name: http
      
        selector: 

      2

      
          app: rollouts-demo

      1

      コンテナー内で実行するためにアプリケーションが使用するポートの名前を指定します。

      2

      selector フィールドの内容が、安定したサービスおよび Rollout カスタムリソース (CR) と同じであることを確認します。

      重要

      Route オブジェクトで指定されたカナリアサービスの名前が、Service オブジェクトで指定されたカナリアサービスの名前と一致していることを確認します。

   4. Create をクリックしてカナリアサービスを作成します。

      ロールアウトは、作成されたサービスをカナリア ReplicaSet の Pod テンプレートハッシュで自動的に更新します。例: rollouts-pod-template-hash: 7bf84f9696。

   5. これらの手順を繰り返して安定したサービスを作成します。次の例では argo-rollouts-stable-service という安定したサービスを作成します。安定したトラフィックがこのサービスに送られます。

      apiVersion: v1
      kind: Service
      metadata:
        name: argo-rollouts-stable-service
      spec:
        ports: 

      1

      
        - port: 80
          targetPort: http
          protocol: TCP
          name: http
      
        selector: 

      2

      
          app: rollouts-demo

      1

      コンテナー内で実行するためにアプリケーションが使用するポートの名前を指定します。

      2

      selector フィールドの内容がカナリアサービスと Rollout CR と同じであることを確認します。

      重要

      Route オブジェクトで指定された安定したサービスの名前が、Service オブジェクトで指定された安定したサービスの名前と一致していることを確認します。

   6. Create をクリックして安定したサービスを作成します。

      ロールアウトは、安定した ReplicaSet の Pod テンプレートハッシュを使用して、作成されたサービスを自動的に更新します。例: rollouts-pod-template-hash: 1b6a7733。

3. Route および Service オブジェクトを参照する Rollout CR を作成します。

   1. Web コンソールの Administrator パースペクティブで、Operator → Installed Operator → Red Hat OpenShift GitOps → Rollout に移動します。

   2. Create Rollout ページで、YAML view をクリックし、次のスニペットを追加します。次の例では、rollouts-demo という Rollout CR を作成します。

      apiVersion: argoproj.io/v1alpha1
      kind: Rollout
      metadata:
        name: rollouts-demo
      spec:
        template: 

      1

      
          metadata:
            labels:
              app: rollouts-demo
          spec:
            containers:
            - name: rollouts-demo
              image: argoproj/rollouts-demo:blue
              ports:
              - name: http
                containerPort: 8080
                protocol: TCP
              resources:
                requests:
                  memory: 32Mi
                  cpu: 5m
      
        revisionHistoryLimit: 2
        replicas: 5
        strategy:
          canary:
            canaryService: argo-rollouts-canary-service 

      2

      
            stableService: argo-rollouts-stable-service 

      3

      
            trafficRouting:
              plugins:
                argoproj-labs/openshift:
                  routes:
                    - rollouts-demo-route  

      4

      
            steps: 

      5

      
            - setWeight: 30
            - pause: {}
            - setWeight: 60
            - pause: {}
        selector: 

      6

      
          matchLabels:
            app: rollouts-demo

      1

      作成する Pod を指定します。

      2

      この値は、作成されたカナリア Service の名前に一致する必要があります。

      3

      この値は、作成された安定した Service の名前と一致する必要があります。

      4

      この値は、作成された Route CR の名前に一致する必要があります。

      5

      ロールアウトの手順を指定します。この例では、トラフィックの 30%、60%、100% を段階的にカナリアバージョンにルーティングします。

      6

      selector フィールドの内容が、カナリアサービスおよび安定したサービスと同じであることを確認します。

   3. Create をクリックします。
   4. Rollout タブの Rollout セクションで、ロールアウトの Status フィールドに Phase: Healthy と表示されていることを確認します。

4. ルートがトラフィックの 100% をアプリケーションの安定バージョンに送信していることを確認します。

   注記

   Rollout リソースの最初のインスタンスが作成されると、ロールアウトによって、安定バージョンおよびカナリアバージョンのアプリケーションに送信されるトラフィックの量が調整されます。最初のインスタンスでは、Rollout リソースの作成により、すべてのトラフィックがアプリケーションの安定バージョンにルーティングされ、トラフィックがカナリアバージョンに送信される部分がスキップされます。

   1. Networking → Routes に移動し、検証する Route リソースを探します。

   2. YAML タブを選択し、以下のスニペットを表示します。

      例: Route

      kind: Route
      metadata:
        name: rollouts-demo-route
      spec:
        alternateBackends:
        - kind: Service
          name: argo-rollouts-canary-service
          weight: 0 

      1

      
        # (...)
        to:
          kind: Service
          name: argo-rollouts-stable-service
          weight: 100 

      2

      1

      値が 0 の場合は、トラフィックの 0% がカナリアバージョンに転送されることを意味します。

      2

      値が 100 の場合、トラフィックの 100% が安定バージョンに送信されることを意味します。

5. ロールアウトでデプロイされたコンテナーイメージを変更して、アプリケーションの新しいカナリアバージョンをシミュレートします。

   1. Web コンソールの Administrator パースペクティブで、Operator → Installed Operator → Red Hat OpenShift GitOps → Rollout に移動します。

   2. 既存の Rollout を選択し、.spec.template.spec.containers.image の値を argoproj/rollouts-demo:blue から argoproj/rollouts-demo:yellow に変更します。

      その結果、ロールアウトにデプロイされたコンテナーイメージが変更され、ロールアウトによって新規のカナリアデプロイメントが開始されます。

      注記

      Rollout リソースの .spec.strategy.canary.steps フィールドで定義されている setWeight プロパティーに従って、最初はルートへのトラフィックの 30% がカナリアバージョンに到達し、トラフィックの 70% が安定バージョンに向けられます。トラフィックの 30% がカナリアバージョンに転送されると、ロールアウトは一時停止されます。

      トラフィックの 30% がカナリアバージョンに送られ、70% が安定バージョンに送られるルートの例。

      spec:
        alternateBackends:
        - kind: Service
          name: argo-rollouts-canary-service
          weight: 30
        # (...)
        to:
          kind: Service
          name: argo-rollouts-stable-service
          weight: 70

6. Argo Rollouts CLI で次のコマンドを実行して、アプリケーションの別のカナリアバージョンを新たにシミュレートします。

   $ oc argo rollouts promote rollouts-demo -n <namespace> 

   1

   1

   Rollout リソースが定義されている namespace を指定します。

   これにより、トラフィックの重みは、カナリアバージョンでは 60%、安定バージョンでは 40% に増加します。

   トラフィックの 60% がカナリアバージョンに送られ、40% が安定バージョンに送られるルートの例。

   spec:
     alternateBackends:
     - kind: Service
       name: argo-rollouts-canary-service
       weight: 60
     # (...)
     to:
       kind: Service
       name: argo-rollouts-stable-service
       weight: 40

7. 次のコマンドを実行して、カナリアバージョンのトラフィックの重みを 100% に増やし、アプリケーションの古い安定バージョンのトラフィックを破棄します。

   $ oc argo rollouts promote rollouts-demo -n <namespace> 

   1

   1

   Rollout リソースが定義されている namespace を指定します。

   トラフィックの 0% がカナリアバージョンに送られ、100% が安定バージョンに送られるルートの例。

   spec:
     # (...)
     to:
       kind: Service
       name: argo-rollouts-stable-service
       weight: 100

手順

1. Web コンソールの Administrator パースペクティブで、Administration → CustomResourceDefinitions に移動します。
2. Subscription を検索し、Subscription CRD をクリックします。
3. Instances タブをクリックし、openshift-gitops-operator サブスクリプションをクリックします。

4. YAML タブをクリックし、YAML ファイルを編集します。

   1. .spec.config.env プロパティーで値を true に設定して、NAMESPACE_SCOPED_ARGO_ROLLOUTS 環境変数を指定します。

      namespace スコープの Argo Rollouts のインストール設定の例

      apiVersion: operators.coreos.com/v1alpha1
      kind: Subscription
      metadata:
        name: openshift-gitops-operator
      spec:
        # (...)
        config:
          env:
            - name: NAMESPACE_SCOPED_ARGO_ROLLOUTS
              value: 'true' 

      1

      1

      値を 'true' に設定すると、namespace スコープのインストールが有効になります。値が 'false' に設定されているか指定されていない場合、インストールはデフォルトでクラスタースコープモードになります。

   2. Save をクリックします。

      Red Hat OpenShift GitOps Operator は、namespace スコープのインストール内での Argo Rollouts カスタムリソースの調整を容易にします。

5. GitOps コンテナーのログを表示して、Red Hat OpenShift GitOps Operator が namespace スコープの Argo Rollouts インストールを有効にしたことを確認します。

   1. Web コンソールの Administrator パースペクティブで、Workloads → Pods に移動します。
   2. openshift-gitops-operator-controller-manager Pod をクリックし、Logs タブをクリックします。
   3. Running in namespaced-scoped mode のログステートメントを探します。このステートメントは、Red Hat OpenShift GitOps Operator が namespace スコープの Argo Rollouts インストールを有効にしたことを示します。

6. RolloutManager リソースを作成して、namespace スコープの Argo Rollouts のインストールを完了します。

   1. Operator → Installed Operator → Red Hat OpenShift GitOps に移動し、RolloutManager タブをクリックします。
   2. Create RolloutManager を作成します。

   3. YAML view を選択し、以下のスニペットを入力します。

      namespace スコープの Argo Rollouts インストール用の RolloutManager CR の例

      apiVersion: argoproj.io/v1alpha1
      kind: RolloutManager
      metadata:
        name: rollout-manager
        namespace: my-application 

      1

      
      spec:
        namespaceScoped: true

      1

      namespace スコープの Argo Rollouts インスタンスをインストールするプロジェクトの名前を指定します。

   4. Create をクリックします。

      RolloutManager CR が作成されると、Red Hat OpenShift GitOps は namespace スコープの Argo Rollouts インスタンスを選択した名前空間にインストールします。

7. namespace スコープのインストールが成功していることを確認します。

   1. RolloutManager タブの RolloutManagers セクションで、RolloutManager インスタンスの Status フィールドが Phase: Available であることを確認します。

   2. RolloutManagers セクションの YAML タブで以下の出力を確認して、インストールが正常に行われていることを確認します。

      namespace スコープの Argo Rollouts インストール YAML ファイルの例

      spec:
        namespaceScoped: true
      status:
        conditions:
          lastTransitionTime: '2024-07-10T14:20:5z`
          message: ''
          reason: Success
          status: 'True' 

      1

      
          type: 'Reconciled'
        phase: Available
        rolloutController: Available

      1

      このステータスは、namespace スコープの Argo Rollouts インストールが正常に有効化されていることを示します。

      クラスター上にクラスタースコープのインストールがすでに存在する場合に、namespace 固有の Argo Rollouts インスタンスをインストールしようとすると、次のエラーメッセージが表示されます。

      エラーメッセージが表示される誤ったインストールの例

      spec:
        namespaceScoped: true
      status:
        conditions:
         lastTransitionTime: '2024-07-10T14:10:7z`
         message: 'when Subscription has environment variable NAMESPACE_SCOPED_ARGO_ROLLOUTS set to False, there may not exist any namespace-scoped RolloutManagers: only a single cluster-scoped RolloutManager is supported'
         reason: InvalidRolloutManagerScope
         status: 'False' 

      1

      
         type: 'Reconciled'
        phase: Failure
        rolloutController: Failure

      1

      このステータスは、namespace スコープの Argo Rollouts のインストールが正常に有効になっていないことを示します。インストールのデフォルトは cluster-scoped モードです。