シングルノード OpenShift クラスターでの OpenShift Data Foundation のデプロイと管理

1. OpenShift クラスターに Red Hat Advanced Cluster Management for Kubernetes (RHACM) がインストールされている。詳細は、 Red Hat Advanced Cluster Management for Kubernetes: Install を参照してください。
2. すべてのマネージド SNO クラスターには、ストレージのプロビジョニングに使用される専用のディスクがあります。

手順

1. OpenShift 認証情報を使用して RHACM CLI にログインします。

   詳細は、Install Red Hat Advanced Cluster Management for Kubernetes を参照してください。

2. ポリシーを作成する namespace を作成します。

   # oc create ns lvm-policy-ns

3. 次の YAML を policy-lvm-operator.yaml などの名前でファイルに保存して、ポリシーを作成します。

   # This policy verifies the installation of the official version of the {product-name-short}
   # Logical Volume Manager Operator on the managed clusters.
   # If set to "enforce" it installs the operator.
   # Used APIs: OLM, ODF-LVMO #https://github.com/operator-framework/operator-lifecycle-manager
   # https://github.com/red-hat-storage/lvm-operator
   
   apiVersion: apps.open-cluster-management.io/v1
   kind: PlacementRule
   metadata:
     name: placement-install-odf-lvm-operator
   spec:
     clusterConditions:
     - status: "True"
       type: ManagedClusterConditionAvailable
     clusterSelector:
       matchExpressions:
       - key: vendor
         operator: In
         values:
         - OpenShift
   ---
   apiVersion: policy.open-cluster-management.io/v1
   kind: PlacementBinding
   metadata:
     name: binding-install-odf-lvm-operator
   placementRef:
     apiGroup: apps.open-cluster-management.io
     kind: PlacementRule
     name: placement-install-odf-lvm-operator
   subjects:
   - apiGroup: policy.open-cluster-management.io
     kind: Policy
     name: install-odf-lvm-operator
   ---
   apiVersion: policy.open-cluster-management.io/v1
   kind: Policy
   metadata:
     annotations:
       policy.open-cluster-management.io/categories: CM Configuration Management
       policy.open-cluster-management.io/controls: CM-2 Baseline Configuration
       policy.open-cluster-management.io/standards: NIST SP 800-53
     name: install-odf-lvm-operator
   spec:
     disabled: false
     remediationAction: enforce
     policy-templates:
     - objectDefinition:
         apiVersion: policy.open-cluster-management.io/v1
         kind: ConfigurationPolicy
         metadata:
           name: install-odf-lvm-operator
         spec:
           object-templates:
           - complianceType: musthave
             objectDefinition:
               apiVersion: v1
               kind: Namespace
               metadata:
                 labels:
                   openshift.io/cluster-monitoring: "true"
                   pod-security.kubernetes.io/enforce: privileged
                   pod-security.kubernetes.io/audit: privileged
                   pod-security.kubernetes.io/warn: privileged
                 name: openshift-storage
           - complianceType: musthave
             objectDefinition:
               apiVersion: operators.coreos.com/v1
               kind: OperatorGroup
               metadata:
                 name: openshift-storage-operatorgroup
                 namespace: openshift-storage
               spec:
                 targetNamespaces:
                 - openshift-storage
           - complianceType: musthave
             objectDefinition:
               apiVersion: operators.coreos.com/v1alpha1
               kind: Subscription
               metadata:
                 name: odf-lvm-operator
                 namespace: openshift-storage
               spec:
                 installPlanApproval: Automatic
                 name: odf-lvm-operator
                 source: redhat-operators
                 sourceNamespace: openshift-marketplace
           remediationAction: enforce
           severity: low
     - objectDefinition:
         apiVersion: policy.open-cluster-management.io/v1
         kind: ConfigurationPolicy
         metadata:
           name: odf-lvmcluster
         spec:
           object-templates:
              - complianceType: musthave
                objectDefinition:
                  apiVersion: lvm.topolvm.io/v1alpha1
                  kind: LVMCluster
                  metadata:
                    name: odf-lvmcluster
                    namespace: openshift-storage
                  spec:
                    storage:
                      deviceClasses:
                      - name: vg1
                        thinPoolConfig:
                          name: thin-pool-1
                          sizePercent: 90
                          overprovisionRatio: 10
           remediationAction: enforce
           severity: low

4. 次のコマンドを実行して、namespace にポリシーを作成します。

   # oc create -f policy-lvm-operator.yaml -n lvm-policy-ns

   ここで、policy-lvm-operator.yaml は、ポリシーが保存されるファイルの名前です。

   これにより、namespace lvm-policy-ns に Policy、PlacementRule、および PlacementBinding が作成されます。Policy は、PlacementRule に一致するクラスター上に Namespace、OperatorGroup、Subscription、および LVMCluster リソースを作成します。これにより、選択基準に一致する SNO クラスターで Operator をデプロイし、ストレージをプロビジョニングするのに必要なリソースを設定するように設定します。operator は、インストール後に未使用のディスクをすべて使用します。

手順

1. OpenShift コマンドラインインターフェイスで、次のコマンドを使用して、ハブクラスターに OpenShift Data Foundation Logical Volume Manager Operator をデプロイおよび設定するのに作成した ACM ポリシーを削除します。

   # oc delete -f policy-lvm-operator.yaml -n lvm-policy-ns

2. 次の YAML を odf-lvmcluster-deletion.yaml などの名前でファイルに保存して、LVMCluster を削除するためのポリシーを作成します。これにより、operator はクラスター上に作成したすべての Logical Volume Manager リソースをクリーンアップできます。

   apiVersion: policy.open-cluster-management.io/v1
   kind: Policy
   metadata:
     name: policy-lvmcluster-delete
     annotations:
       policy.open-cluster-management.io/standards: NIST SP 800-53
       policy.open-cluster-management.io/categories: CM Configuration Management
       policy.open-cluster-management.io/controls: CM-2 Baseline Configuration
   spec:
     remediationAction: enforce
     disabled: false
     policy-templates:
       - objectDefinition:
           apiVersion: policy.open-cluster-management.io/v1
           kind: ConfigurationPolicy
           metadata:
             name: policy-lvmcluster-removal
           spec:
             remediationAction: enforce # the policy-template spec.remediationAction is overridden by the preceding parameter value for spec.remediationAction.
             severity: low
             object-templates:
               - complianceType: mustnothave
                 objectDefinition:
                   kind: LVMCluster
                   apiVersion: lvm.topolvm.io/v1alpha1
                   metadata:
                     name: odf-lvmcluster
                     namespace: openshift-storage # must have namespace 'openshift-storage'
   ---
   apiVersion: policy.open-cluster-management.io/v1
   kind: PlacementBinding
   metadata:
    name: binding-policy-lvmcluster-delete
   placementRef:
    apiGroup: apps.open-cluster-management.io
    kind: PlacementRule
    name: placement-policy-lvmcluster-delete
   subjects:
    - apiGroup: policy.open-cluster-management.io
      kind: Policy
      name: policy-lvmcluster-delete
   ---
   apiVersion: apps.open-cluster-management.io/v1
   kind: PlacementRule
   metadata:
    name: placement-policy-lvmcluster-delete
   spec:
    clusterConditions:
      - status: 'True'
        type: ManagedClusterConditionAvailable
    clusterSelector:
      matchExpressions:
        - key: vendor
          operator: In
          values:
            - OpenShift

3. 次のコマンドを実行してポリシーを作成します。

   # oc create -f odf-lvmcluster-deletion.yaml -n lvm-policy-ns

4. 次の YAML を check-odf-lvmcluster-deletion.yaml などの名前でファイルに保存して、LVMCluster CR が削除されたかどうかを確認するポリシーを作成します。

   apiVersion: policy.open-cluster-management.io/v1
   kind: Policy
   metadata:
     name: policy-lvmcluster-inform
     annotations:
       policy.open-cluster-management.io/standards: NIST SP 800-53
       policy.open-cluster-management.io/categories: CM Configuration Management
       policy.open-cluster-management.io/controls: CM-2 Baseline Configuration
   spec:
     remediationAction: inform
     disabled: false
     policy-templates:
       - objectDefinition:
           apiVersion: policy.open-cluster-management.io/v1
           kind: ConfigurationPolicy
           metadata:
             name: policy-lvmcluster-removal-inform
           spec:
             remediationAction: inform # the policy-template spec.remediationAction is overridden by the preceding parameter value for spec.remediationAction.
             severity: low
             object-templates:
               - complianceType: mustnothave
                 objectDefinition:
                   kind: LVMCluster
                   apiVersion: lvm.topolvm.io/v1alpha1
                   metadata:
                     name: odf-lvmcluster
                     namespace: openshift-storage # must have namespace 'openshift-storage'
   ---
   apiVersion: policy.open-cluster-management.io/v1
   kind: PlacementBinding
   metadata:
    name: binding-policy-lvmcluster-check
   placementRef:
    apiGroup: apps.open-cluster-management.io
    kind: PlacementRule
    name: placement-policy-lvmcluster-check
   subjects:
    - apiGroup: policy.open-cluster-management.io
      kind: Policy
      name: policy-lvmcluster-inform
   ---
   apiVersion: apps.open-cluster-management.io/v1
   kind: PlacementRule
   metadata:
    name: placement-policy-lvmcluster-check
   spec:
    clusterConditions:
      - status: 'True'
        type: ManagedClusterConditionAvailable
    clusterSelector:
      matchExpressions:
        - key: vendor
          operator: In
          values:
            - OpenShift

5. 次のコマンドを実行してポリシーを作成します。

   # oc create -f check-odf-lvmcluster-deletion.yaml -n lvm-policy-ns

6. ポリシーのステータスを確認します。

   # oc get policy -n lvm-policy-ns
   NAME                       REMEDIATION ACTION   COMPLIANCE STATE   AGE
   policy-lvmcluster-delete   enforce              Compliant          15m
   policy-lvmcluster-inform   inform               Compliant          15m

7. 両方のポリシーに準拠したら、次の YAML を odf-lvm-operator-remove-policy.yaml などの名前のファイルに保存して、OpenShift Data Foundation Logical Volume Manager Operator をアンインストールするポリシーを作成します。

   apiVersion: apps.open-cluster-management.io/v1
   kind: PlacementRule
   metadata:
     name: placement-uninstall-odf-lvm-operator
   spec:
     clusterConditions:
     - status: "True"
       type: ManagedClusterConditionAvailable
     clusterSelector:
       matchExpressions:
       - key: vendor
         operator: In
         values:
         - OpenShift
   ---
   apiVersion: policy.open-cluster-management.io/v1
   kind: PlacementBinding
   metadata:
     name: binding-uininstall-odf-lvm-operator
   placementRef:
     apiGroup: apps.open-cluster-management.io
     kind: PlacementRule
     name: placement-uninstall-odf-lvm-operator
   subjects:
   - apiGroup: policy.open-cluster-management.io
     kind: Policy
     name: uninstall-odf-lvm-operator
   ---
   apiVersion: policy.open-cluster-management.io/v1
   kind: Policy
   metadata:
     annotations:
       policy.open-cluster-management.io/categories: CM Configuration Management
       policy.open-cluster-management.io/controls: CM-2 Baseline Configuration
       policy.open-cluster-management.io/standards: NIST SP 800-53
     name: uninstall-odf-lvm-operator
   spec:
     disabled: false
     policy-templates:
     - objectDefinition:
         apiVersion: policy.open-cluster-management.io/v1
         kind: ConfigurationPolicy
         metadata:
           name: uninstall-odf-lvm-operator
         spec:
           object-templates:
           - complianceType: mustnothave
             objectDefinition:
               apiVersion: v1
               kind: Namespace
               metadata:
                 name: openshift-storage
           - complianceType: mustnothave
             objectDefinition:
               apiVersion: operators.coreos.com/v1
               kind: OperatorGroup
               metadata:
                 name: openshift-storage-operatorgroup
                 namespace: openshift-storage
               spec:
                 targetNamespaces:
                 - openshift-storage
           - complianceType: mustnothave
             objectDefinition:
               apiVersion: operators.coreos.com/v1alpha1
               kind: Subscription
               metadata:
                 name: odf-lvm-operator
                 namespace: openshift-storage
               spec:
                 installPlanApproval: Automatic
                 name: odf-lvm-operator
                 source: redhat-operators
                 sourceNamespace: openshift-marketplace
           remediationAction: enforce
           severity: low
     - objectDefinition:
         apiVersion: policy.open-cluster-management.io/v1
         kind: ConfigurationPolicy
         metadata:
           name: policy-remove-lvm-operator-crds
         spec:
           object-templates:
           - complianceType: mustnothave
             objectDefinition:
               apiVersion: apiextensions.k8s.io/v1
               kind: CustomResourceDefinition
               metadata:
                 name: logicalvolumes.topolvm.cybozu.com
           - complianceType: mustnothave
             objectDefinition:
               apiVersion: apiextensions.k8s.io/v1
               kind: CustomResourceDefinition
               metadata:
                 name: lvmclusters.lvm.topolvm.io
           - complianceType: mustnothave
             objectDefinition:
               apiVersion: apiextensions.k8s.io/v1
               kind: CustomResourceDefinition
               metadata:
                 name: lvmvolumegroupnodestatuses.lvm.topolvm.io
           - complianceType: mustnothave
             objectDefinition:
               apiVersion: apiextensions.k8s.io/v1
               kind: CustomResourceDefinition
               metadata:
                 name: lvmvolumegroups.lvm.topolvm.io
           remediationAction: enforce
           severity: high

8. 次のコマンドを実行してポリシーを作成します。

   # oc create -f odf-lvm-operator-remove-policy.yaml -ns lvm-policy-ns

手順

1. OpenShift Web コンソールにログインします。
2. Operators → OperatorHub をクリックします。
3. ODF LVM Operator をスクロールするか、Filter by keyword ボックスに入力して、ODF LVM Operator を見つけます。
4. Install をクリックします。

5. Install Operator ページで、以下のオプションを設定します。

   1. Channel を stable-4.11 として更新します。
   2. Installation Mode オプションに A specific namespace on the cluster を選択します。
   3. Installed Namespace に Operator recommended namespace openshift-storage を選択します。namespace openshift-storage が存在しない場合、これは Operator のインストール時に作成されます。

   4. 承認ストラテジー を Automatic または Manual として選択します。

      Automatic (自動) 更新を選択した場合、Operator Lifecycle Manager (OLM) は介入なしに、Operator の実行中のインスタンスを自動的にアップグレードします。

      Manual 更新を選択した場合、OLM は更新要求を作成します。クラスター管理者は、Operator を新しいバージョンに更新できるように更新要求を手動で承認する必要があります。

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

手順

1. OpenShift Web コンソールで、Operators → Installed Operators をクリックし、インストールされた Operator を表示します。

   選択された Project が openshift-storage であることを確認します。

2. ODF LVM operator をクリックしてから、LVMCluster の下の Create instance をクリックします。
3. LVMCluster の作成ページで、Form view または YAML view のいずれかを選択します。
4. クラスターの名前を入力します。
5. Create をクリックします。

検証手順

1. OpenShift Web コンソールの左側のペインから Storage → Storage Classes をクリックします。
2. ODF LVM クラスターの作成で odf-lvm-<device-class-name> ストレージクラスが作成されていることを確認します。デフォルトでは、vg1 は device-class-name になります。

手順

1. プロジェクト openshift-storage を選択します。

   $ oc project openshift-storage

2. Pod を表示します。

   $ oc get pods
   NAME                                               READY   STATUS    RESTARTS      AGE
   lvm-operator-controller-manager-54df65b5c4-n7bhb   3/3     Running   1 (45h ago)   7d2h
   topolvm-controller-645cb47cd4-kskqb                5/5     Running   5 (45h ago)   7d3h
   topolvm-node-7bqxp                                 4/4     Running   0             7d3h
   vg-manager-hwmg2                                   1/1     Running   0             7d

3. lvmcluster を表示します。

   $ oc get lvmcluster
   NAME             AGE
   odf-lvmcluster   7d3h

4. lvmcluster を削除します。

   $ oc delete lvmcluster odf-lvmcluster
   lvmcluster.lvm.topolvm.io "odf-lvmcluster" deleted

5. lvmcluster を表示して削除を確認します。

   $ oc get lvmcluster
   No resources found in openshift-storage namespace.

6. lvm-operator Pod のみが実行されるまで待ちます。

   $ oc get pods
   NAME                                               READY   STATUS    RESTARTS      AGE
   lvm-operator-controller-manager-54df65b5c4-n7bhb   3/3     Running   1 (45h ago)   7d2h

7. プロジェクトを default に変更します。

   $ oc project default

8. プロジェクト openshift-storage を削除します。

   $ oc delete project openshift-storage

手順

1. 次の YAML を odf-lvm-vol-snapshot.yaml などの名前でファイルに保存して、ボリュームスナップショットのポリシーを作成します。

   # Sample YAML to create a volume snapshot
   
   apiVersion: snapshot.storage.k8s.io/v1
   kind: VolumeSnapshot
   metadata:
       name: lvm-block-1-snap
    spec:
        volumeSnapshotClassName: odf-lvm-vg1
        source:
           persistentVolumeClaimName: lvm-block-1

2. 次のコマンドを実行してポリシーを作成します。

   # oc create -f odf-lvm-vol-snapshot.yaml -ns lvm-policy-ns

   PVC の読み取り専用コピーがボリュームスナップショットとして作成されます。

手順

1. ソース PVC のストレージクラス名とボリュームスナップショット名を特定します。

2. 次の YAML を odf-lvm-vol-restore.yaml などの名前でファイルに保存して、スナップショットを復元します。

   # Sample YAML to restore a PVC.
   
   kind: PersistentVolumeClaim
   apiVersion: v1
   metadata:
     name: lvm-block-1-restore
   spec:
     accessModes:
    - ReadWriteOnce
     volumeMode: Block
     Resources:
       Requests:
         storage: 2Gi
     storageClassName: odf-lvm-vg1
     dataSource:
       name: lvm-block-1-snap
       kind: VolumeSnapshot
       apiGroup: snapshot.storage.k8s.io

3. 次のコマンドを実行してポリシーを作成します。

   # oc create -f odf-lvm-vol-restore.yaml -ns lvm-policy-ns

手順

1. ソース PVC のストレージクラスを特定します。

2. 次の YAML を odf-lvm-vol-clone.yaml などの名前でファイルに保存して、ボリュームクローンを作成します。

   # Sample YAML to clone a volume
   # pvc-clone.yaml
   apiVersion: v1
   kind: PersistentVolumeClaim
   Metadata:
     name: lvm-block-1-clone
   Spec:
     storageClassName: odf-lvm-vg1
     dataSource:
       name: lvm-block-1
       kind: PersistentVolumeClaim
     accessModes:
      - ReadWriteOnce
     volumeMode: Block
     Resources:
       Requests:
         storage: 2Gi
   The cloned PVC has write access.

3. 次のコマンドを実行してポリシーを作成します。