宣言型クラスター設定

手順

1. Web コンソールの Administrator パースペクティブで、Operators → Installed Operators に移動します。
2. インストールされている Operator から Red Hat OpenShift GitOps をクリックし、Argo CD タブに移動します。
3. round-robin シャーディングアルゴリズムを有効にする Argo CD インスタンス (例: openshift-gitops) をクリックします。

4. YAML タブをクリックし、以下の例のように YAML ファイルを編集します。

   ラウンドロビンシャーディングアルゴリズムが有効になっている Argo CD インスタンスの例

   apiVersion: argoproj.io/v1beta1
   kind: ArgoCD
   metadata:
     name: openshift-gitops
     namespace: openshift-gitops
   spec:
     controller:
       sharding:
         enabled: true 

   1

   
         replicas: 3 

   2

   
       env: 

   3

   
         - name: ARGOCD_CONTROLLER_SHARDING_ALGORITHM
           value: round-robin
       logLevel: debug 

   4

   Copy to Clipboard Toggle word wrap

   1

   シャーディングを有効にするには、sharding.enabled パラメーターを true に設定します。

   2

   レプリカの数を必要な値 (例: 3) に設定します。

   3

   シャーディングアルゴリズムを round-robin に設定します。

   4

   各クラスターがどのシャードに接続されているかを確認できるように、ログレベルを debug に設定します。

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

   成功通知アラート openshift-gitops has been updated to version <version> が表示されます。

   注記

   デフォルトの openshift-gitops インスタンスを編集すると、Managed resource ダイアログボックスが表示されます。Save をもう一度クリックして、変更を確定します。

6. 次の手順を実行して、シャーディングアルゴリズムとして round-robin を使用する設定で、シャーディングが有効になっていることを確認します。

   1. Workloads → StatefulSets に移動します。
   2. Argo CD インスタンスをインストールしたネームスペースを Project ドロップダウンリストから選択します。
   3. <instance_name>-application-controller (例: openshift-gitops-application-controller) をクリックし、Pod タブに移動します。
   4. 作成されたアプリケーションコントローラー Pod の数を確認します。これは、セットレプリカの数に対応している必要があります。

   5. 調べるコントローラー Pod をクリックし、Logs タブに移動して Pod ログを表示します。

      コントローラー Pod ログスニペットの例

      time="2023-12-13T09:05:34Z" level=info msg="ArgoCD Application Controller is starting" built="2023-12-01T19:21:49Z" commit=a3vd5c3df52943a6fff6c0rg181fth3248976299 namespace=openshift-gitops version=v2.9.2+c5ea5c4
      time="2023-12-13T09:05:34Z" level=info msg="Processing clusters from shard 1"
      time="2023-12-13T09:05:34Z" level=info msg="Using filter function:  round-robin" 

      1

      
      time="2023-12-13T09:05:34Z" level=info msg="Using filter function:  round-robin"
      time="2023-12-13T09:05:34Z" level=info msg="appResyncPeriod=3m0s, appHardResyncPeriod=0s"

      Copy to Clipboard Toggle word wrap

      1

      Using filter function: round-robin メッセージを探します。

   6. 次の例に示すように、ログの Search フィールドで processed by shard を検索して、シャード間でのクラスターの分布が均一であることを確認します。

      重要

      これらのログを確認するには、ログレベルを debug に設定していることを確認してください。

      コントローラー Pod ログスニペットの例

      time="2023-12-13T09:05:34Z" level=debug msg="ClustersList has 3 items"
      time="2023-12-13T09:05:34Z" level=debug msg="Adding cluster with id= and name=in-cluster to cluster's map"
      time="2023-12-13T09:05:34Z" level=debug msg="Adding cluster with id=068d8b26-6rhi-4w23-jrf6-wjjfyw833n23 and name=in-cluster2 to cluster's map"
      time="2023-12-13T09:05:34Z" level=debug msg="Adding cluster with id=836d8b53-96k4-f68r-8wq0-sh72j22kl90w and name=in-cluster3 to cluster's map"
      time="2023-12-13T09:05:34Z" level=debug msg="Cluster with id= will be processed by shard 0" 

      1

      
      time="2023-12-13T09:05:34Z" level=debug msg="Cluster with id=068d8b26-6rhi-4w23-jrf6-wjjfyw833n23 will be processed by shard 1" 

      2

      
      time="2023-12-13T09:05:34Z" level=debug msg="Cluster with id=836d8b53-96k4-f68r-8wq0-sh72j22kl90w will be processed by shard 2" 

      3

      Copy to Clipboard Toggle word wrap

      1 2 3

      この例では、3 つのクラスターがシャード 0、シャード 1、およびシャード 2 に連続して接続されています。

      注記

      クラスターの数 C がシャードレプリカの数 R の倍数である場合、各シャードには同じ数のクラスター N が割り当てられている必要があります。これは、C を R で割ったものに相当します。前の例では、3 つのクラスターと 3 つのレプリカを示しています。したがって、各シャードには 1 つのクラスターが割り当てられます。

手順

1. 以下のコマンドを実行して、シャード化を有効にし、レプリカの数を必要な値に設定します。

   $ oc patch argocd <argocd_instance> -n <namespace> --patch='{"spec":{"controller":{"sharding":{"enabled":true,"replicas":<value>}}}}' --type=merge

   Copy to Clipboard Toggle word wrap

   出力例

   argocd.argoproj.io/<argocd_instance> patched

   Copy to Clipboard Toggle word wrap

2. 以下のコマンドを実行して、シャード化アルゴリズムを round-robin に設定します。

   $ oc patch argocd <argocd_instance> -n <namespace> --patch='{"spec":{"controller":{"env":[{"name":"ARGOCD_CONTROLLER_SHARDING_ALGORITHM","value":"round-robin"}]}}}' --type=merge

   Copy to Clipboard Toggle word wrap

   出力例

   argocd.argoproj.io/<argocd_instance> patched

   Copy to Clipboard Toggle word wrap

3. 次のコマンドを実行して、Argo CD アプリケーションコントローラー Pod の数がセットされたレプリカの数と一致していることを確認します。

   $ oc get pods -l app.kubernetes.io/name=<argocd_instance>-application-controller -n <namespace>

   Copy to Clipboard Toggle word wrap

   出力例

   NAME                                        READY   STATUS    RESTARTS   AGE
   <argocd_instance>-application-controller-0   1/1     Running   0          11s
   <argocd_instance>-application-controller-1   1/1     Running   0          32s
   <argocd_instance>-application-controller-2   1/1     Running   0          22s

   Copy to Clipboard Toggle word wrap

4. 次のコマンドを実行して、シャーディングアルゴリズムとして round-robin を使用する設定で、シャーディングが有効になっていることを確認します。

   $ oc logs <argocd_application_controller_pod> -n <namespace>

   Copy to Clipboard Toggle word wrap

   出力の抜粋例

   time="2023-12-13T09:05:34Z" level=info msg="ArgoCD Application Controller is starting" built="2023-12-01T19:21:49Z" commit=a3vd5c3df52943a6fff6c0rg181fth3248976299 namespace=<namespace> version=v2.9.2+c5ea5c4
   time="2023-12-13T09:05:34Z" level=info msg="Processing clusters from shard 1"
   time="2023-12-13T09:05:34Z" level=info msg="Using filter function:  round-robin" 

   1

   
   time="2023-12-13T09:05:34Z" level=info msg="Using filter function:  round-robin"
   time="2023-12-13T09:05:34Z" level=info msg="appResyncPeriod=3m0s, appHardResyncPeriod=0s"

   Copy to Clipboard Toggle word wrap

   1

   Using filter function: round-robin メッセージを探します。

5. 次の手順を実行して、シャード間でクラスターが均等に分散されていることを確認します。

   1. 次のコマンドを実行して、ログレベルを debug に設定します。

      $ oc patch argocd <argocd_instance> -n <namespace> --patch='{"spec":{"controller":{"logLevel":"debug"}}}' --type=merge

      Copy to Clipboard Toggle word wrap

      出力例

      argocd.argoproj.io/<argocd_instance> patched

      Copy to Clipboard Toggle word wrap

   2. 次のコマンドを実行して、ログを表示し、processed by shard を検索して、各クラスターがどのシャードに接続されているかを確認します。

      $ oc logs <argocd_application_controller_pod> -n <namespace> | grep "processed by shard"

      Copy to Clipboard Toggle word wrap

      出力の抜粋例

      time="2023-12-13T09:05:34Z" level=debug msg="Cluster with id= will be processed by shard 0" 

      1

      
      time="2023-12-13T09:05:34Z" level=debug msg="Cluster with id=068d8b26-6rhi-4w23-jrf6-wjjfyw833n23 will be processed by shard 1" 

      2

      
      time="2023-12-13T09:05:34Z" level=debug msg="Cluster with id=836d8b53-96k4-f68r-8wq0-sh72j22kl90w will be processed by shard 2" 

      3

      Copy to Clipboard Toggle word wrap

      1 2 3

      この例では、3 つのクラスターがシャード 0、シャード 1、およびシャード 2 に連続して接続されています。

      注記

      クラスターの数 C がシャードレプリカの数 R の倍数である場合、各シャードには同じ数のクラスター N が割り当てられている必要があります。これは、C を R で割ったものに相当します。前の例では、3 つのクラスターと 3 つのレプリカを示しています。したがって、各シャードには 1 つのクラスターが割り当てられます。

手順

1. OpenShift Container Platform Web コンソールの Administrator パースペクティブで、Operators → Installed Operators に移動します。
2. Installed Operators のリストから Red Hat OpenShift GitOps Operator を選択し、ArgoCD タブをクリックします。
3. シャードの動的スケーリングを有効にする Argo CD インスタンス名 (例: openshift-gitops) を選択します。

4. YAML タブをクリックし、以下のように spec.controller.sharding プロパティーを編集して設定します。

   動的なスケーリングを有効にした Argo CD YAML ファイルの例

   apiVersion: argoproj.io/v1beta1
   kind: ArgoCD
   metadata:
     name: openshift-gitops
     namespace: openshift-gitops
   spec:
     controller:
       sharding:
         dynamicScalingEnabled: true 

   1

   
         minShards: 1 

   2

   
         maxShards: 3 

   3

   
         clustersPerShard: 1 

   4

   Copy to Clipboard Toggle word wrap

   1

   動的スケーリングを有効にするには、dynamicScalingEnabled を true に設定します。

   2

   minShards は、シャードの最小要件数に設定します。この値は 1 以上に設定する必要があります。

   3

   maxShards を、シャードの最大要件数に設定します。値は minShards の値よりも大きくなければなりません。

   4

   clustersPerShard は、シャードごとに必要なクラスターの数に設定します。この値は 1 以上に設定する必要があります。

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

   成功通知アラート openshift-gitops has been updated to version <version> が表示されます。

   注記

   デフォルトの openshift-gitops インスタンスを編集すると、Managed resource ダイアログボックスが表示されます。Save をもう一度クリックして、変更を確定します。

1. Workloads → StatefulSets に移動します。
2. Argo CD インスタンスがデプロイされている namespace を Project ドロップダウンリストから選択します (例: openshift-gitops)。
3. Argo CD インスタンスの名前を持つ StatefulSet オブジェクトの名前 (例: openshift-gitops-apllication-controller) をクリックします。
4. Pod タブをクリックし、Pod の数が Argo CD YAML ファイルで設定した minShards の値以上であることを確認します。

手順

1. oc ツールを使用して、cluster-admin 権限を持つユーザーとしてクラスターにログインします。

2. 次のコマンドを実行して、動的スケーリングを有効にします。

   $ oc patch argocd <argocd_instance> -n <namespace> --type=merge --patch='{"spec":{"controller":{"sharding":{"dynamicScalingEnabled":true,"minShards":<value>,"maxShards":<value>,"clustersPerShard":<value>}}}}'

   Copy to Clipboard Toggle word wrap

   コマンドの例

   $ oc patch argocd openshift-gitops -n openshift-gitops --type=merge --patch='{"spec":{"controller":{"sharding":{"dynamicScalingEnabled":true,"minShards":1,"maxShards":3,"clustersPerShard":1}}}}' 

   1

   Copy to Clipboard Toggle word wrap

   1

   このサンプルコマンドは、openshift-gitops namespace の openshift-gitops Argo CD インスタンスの動的スケーリングを有効にし、シャードの最小数を 1 に、シャードの最大数を 3 に、およびシャードごとのクラスター数を 1 に設定します。minShard および clustersPerShard の値は、1 以上に設定する必要があります。maxShard の値は、minShard の値以下である必要があります。

   出力例

   argocd.argoproj.io/openshift-gitops patched

   Copy to Clipboard Toggle word wrap

検証

1. Argo CD インスタンスの spec.controller.sharding プロパティーを確認します。

   $ oc get argocd <argocd_instance> -n <namespace> -o jsonpath='{.spec.controller.sharding}'

   Copy to Clipboard Toggle word wrap

   コマンドの例

   $ oc get argocd openshift-gitops -n openshift-gitops -o jsonpath='{.spec.controller.sharding}'

   Copy to Clipboard Toggle word wrap

   シャードの動的スケーリングが有効になっている場合の出力例

   {"dynamicScalingEnabled":true,"minShards":1,"maxShards":3,"clustersPerShard":1}

   Copy to Clipboard Toggle word wrap

2. オプション: OpenShift Container Platform Web コンソールで Argo CD インスタンスの設定 YAML ファイルにある設定された spec.controller.sharding プロパティーをチェックして、動的スケーリングが有効になっていることを確認します。

3. Argo CD Application Controller Pod の数を確認します。

   $ oc get pods -n <namespace> -l app.kubernetes.io/name=<argocd_instance>-application-controller

   Copy to Clipboard Toggle word wrap

   コマンドの例

   $ oc get pods -n openshift-gitops -l app.kubernetes.io/name=openshift-gitops-application-controller

   Copy to Clipboard Toggle word wrap

   出力例

   NAME                                           READY   STATUS    RESTARTS   AGE
   openshift-gitops-application-controller-0      1/1     Running   0          2m  

   1

   Copy to Clipboard Toggle word wrap

   1

   Argo CD Application Controller Pod の数は、minShard の値以下である必要があります。