第6章 Container Storage Interface (CSI) の使用


6.1. CSI ボリュームの設定

Container Storage Interface (CSI) は、ストレージベンダーがコンテナーオーケストレーションシステム間で動作するプラグインを開発できるようにする標準仕様です。OpenShift Container Platform は、CSI ドライバーを使用して永続ストレージをプロビジョニングおよび管理し、ツリー内ストレージプラグインを置き換えます。

6.1.1. CSI アーキテクチャー

Container Storage Interface (CSI) アーキテクチャーは、OpenShift Container Platform とストレージバックエンド間の通信にコンテナー化されたドライバーとブリッジコンポーネントを使用します。各ドライバーには、ボリューム操作用のコントローラーデプロイメントとデーモンセットが必要です。複数のドライバーを同時に実行できます。

Container Storage Interface (CSI) により、OpenShift Container Platform は CSI インターフェイス を永続ストレージとして実装するストレージバックエンドからストレージを使用できます。

注記

OpenShift Container Platform 4.21 は、CSI 仕様 のバージョン 1.6.0 をサポートします。

CSI 仕様の詳細は、「CSI 仕様」を参照してください。

CSI ドライバーは通常、コンテナーイメージとして提供されます。これらのコンテナーは、実行先の OpenShift Container Platform を認識しません。OpenShift Container Platform でサポートされる CSI 互換のストレージバックエンドを使用するには、クラスター管理者は、OpenShift Container Platform とストレージドライバーの橋渡しとして機能するコンポーネントを複数デプロイする必要があります。

以下の図では、OpenShift Container Platform クラスターの Pod で実行されるコンポーネントの俯瞰図を示しています。

CSI コンポーネントのアーキテクチャー

異なるストレージバックエンドに対して複数の CSI ドライバーを実行できます。各ドライバーには、独自の外部コントローラーのデプロイメントおよびドライバーと CSI レジストラーを含むデーモンセットが必要です。

6.1.1.1. 外部の CSI コントローラー

External Container Storage Interface (CSI) コントローラーは、ボリュームのプロビジョニング、削除、アタッチ、スナップショット、サイズ変更を処理するコンテナーを備えたデプロイメントとして実行されます。コントローラー Pod は、UNIX Domain Socket を使用して CSI ドライバーと通信し、認証情報を保護するためにインフラストラクチャーノード上で実行されます。

外部の CSI コントローラーは、5 つのコンテナーを含む 1 つまたは複数の Pod を配置するデプロイメントです。

  • スナップショットコンテナーは、VolumeSnapshot オブジェクトおよび VolumeSnapshotContent オブジェクトを監視し、VolumeSnapshotContent オブジェクトの作成および削除を担当します。
  • リサイザーコンテナーは、PersistentVolumeClaim オブジェクトでより多くのストレージを要求した場合に、PersistentVolumeClaim の更新を監視し、CSI エンドポイントに対して ControllerExpandVolume 操作をトリガーするサイドカーコンテナーです。
  • OpenShift Container Platform からの attach および detach の呼び出しを適切な CSI ドライバーへの ControllerPublish および ControllerUnpublish 呼び出しに変換する外部の CSI アタッチャーコンテナー。
  • OpenShift Container Platform からの provision および delete 呼び出しを適切な CSI ドライバーへの CreateVolume および DeleteVolume 呼び出しに変換する外部の CSI プロビジョナーコンテナー。
  • CSI ドライバーコンテナー。

CSI アタッチャーおよび CSI プロビジョナーコンテナーは、Unix Domain Socket を使用して、CSI ドライバーコンテナーと通信し、CSI の通信が Pod 外に出ないようにします。CSI ドライバーは Pod 外からはアクセスできません。

注記

通常、attach、detach、provision、および delete 操作では、CSI ドライバーがストレージバックエンドに対する認証情報を使用する必要があります。CSI コントローラー Pod をインフラストラクチャーノードで実行し、コンピュートノードで致命的なセキュリティー違反が発生した場合でも認証情報がユーザープロセスに漏洩されないようにします。

注記

外部のアタッチャーは、サードパーティーの attach または detach 操作をサポートしない CSI ドライバーに対しても実行する必要があります。外部のアタッチャーは、CSI ドライバーに対して ControllerPublish または ControllerUnpublish 操作を発行しません。ただし、必要な OpenShift Container Platform 割り当て API を実装できるように依然として実行する必要があります。

6.1.1.2. CSI ドライバーのデーモンセット

CSI ドライバーデーモンセットは、ボリュームのマウントと操作を可能にするために、すべてのノードで実行されます。各 Pod には、UNIX ドメインソケットを使用してノードサービスと通信するドライバーとレジストラーが含まれています。ノードドライバーは最小限の認証情報を使用し、パブリッシュやステージなどのノード固有の CSI 操作を実装します。

CSI ドライバーのデーモンセットは、OpenShift Container Platform が CSI ドライバーによって提供されるストレージをノードにマウントして、永続ボリューム (PV) としてユーザーワークロード (Pod) で使用できるように、全ノードで Pod を実行します。CSI ドライバーがインストールされた Pod には、以下のコンテナーが含まれます。

CSI ドライバーレジストラー
CSI ドライバーレジストラーは、ノード上で実行中の openshift-node サービスに CSI ドライバーを登録します。このノードで実行中の openshift-node プロセスは、ノードで利用可能な UNIX Domain Socket を使用して CSI ドライバーに直接接続します。
CSI ドライバー
ノードにデプロイされた CSI ドライバーには、ストレージバックエンドへの認証情報をできる限り少なく指定する必要があります。OpenShift Container Platform は、NodePublish/NodeUnpublish および NodeStage/NodeUnstage (実装されている場合) などの CSI 呼び出しのノードプラグインセットのみを使用します。

6.1.2. OpenShift Container Platform でサポートされる CSI ドライバー

OpenShift Container Platform はデフォルトで複数の CSI ドライバーをインストールし、サポートされているバックエンドのドライバー Operator、ドライバー、およびストレージクラスを自動的にデプロイします。デフォルトドライバーは、ツリー内プラグイン以外の拡張機能を提供します。AWS EFS や GCP Filestore などの一部のドライバーは、手動でインストールする必要があります。

これらのサポートされるストレージアセットにマウントする CSI でプロビジョニングされた永続ボリュームを作成するには、OpenShift Container Platform は必要な CSI Driver Operator、CSI ドライバー、および必要なストレージクラスをインストールします。Operator およびドライバーのデフォルト namespace の詳細は、特定の CSI Driver Operator のドキュメントを参照してください。

重要

AWS EFS CSI ドライバーはデフォルトではインストールされないため、手動でインストールする必要があります。AWS EFS CSI ドライバーのインストール手順は、「AWS Elastic File Service CSI Driver Operator のセットアップ」を参照してください。

次の表では、OpenShift Container Platform とともにインストールされ、OpenShift Container Platform でサポートされている CSI ドライバーと、ボリュームのスナップショットやサイズ変更など、ドライバーでサポートされている CSI 機能を説明します。

重要

CSI ドライバーが次の表に記載されていない場合は、CSI ストレージベンダーが提供するインストール手順に従って、サポートされている CSI 機能を使用する必要があります。

サードパーティーによって認定された CSI ドライバーのリストは、関連情報 の Red Hat エコシステムポータル を参照してください。

表6.1 OpenShift Container Platform でサポートされる CSI ドライバーおよび機能
CSI ドライバーCSI ボリュームスナップショットCSI ボリュームグループスナップショット [1]CSI のクローン作成CSI のサイズ変更インラインのエフェメラルボリュームユーザー名前空間

AWS EBS

✅

  

✅

 

✅

AWS EFS

      

Google Compute Platform (GCP) persistent disk (PD)

✅

 

✅[2]

✅

 

✅

GCP Filestore

✅

  

✅

  

IBM Power® 仮想サーバーブロック

   

✅

 

✅

IBM Cloud® Block

✅[3]

  

✅[3]

 

✅

LVM Storage

✅

 

✅

✅

 

✅

Microsoft Azure Disk

✅

 

✅

✅

 

✅

Microsoft Azure Stack Hub

✅

 

✅

✅

 

✅

Microsoft Azure File

✅

 

✅

✅

✅

 

OpenStack Cinder

✅

 

✅

✅

 

✅

OpenShift Data Foundation

✅

✅

✅

✅

 

✅ [4]

OpenStack Manila

✅

  

✅

  

CIFS/SMB

  

✅

   

VMware vSphere

✅[5]

  

✅[6]

 

✅ [7]

1.

重要

CSI ボリュームグループスナップショットは、テクノロジープレビュー機能です。テクノロジープレビュー機能は、Red Hat 製品のサービスレベルアグリーメント (SLA) の対象外であり、機能的に完全ではないことがあります。Red Hat は、実稼働環境でこれらを使用することを推奨していません。テクノロジープレビュー機能は、最新の製品機能をいち早く提供して、開発段階で機能のテストを行い、フィードバックを提供していただくことを目的としています。

Red Hat のテクノロジープレビュー機能のサポート範囲に関する詳細は、テクノロジープレビュー機能のサポート範囲 を参照してください。

2.

  • ストレージプールを使用する hyperdisk-balanced ディスクでは、クローン作成はサポートされていません。

3.

  • オフラインスナップショットまたはサイズ変更はサポートされていません。ボリュームは、実行中の Pod にアタッチする必要があります。

4.

  • RBD はユーザー名前空間をサポートしていますが、CephFS はサポートしていません。

5.

  • vCenter Server と ESXi の両方において、VMware vSphere バージョン 8.0 Update 1 以降、または VMware vSphere Foundation (VVF) 9、あるいは VMware Cloud Foundation (VCF) 9 が必要です。
  • ファイル共有ボリュームはサポートされません。

6.

  • オンライン拡張は、VMware vSphere バージョン 8.0 Update 1 以降、または VVF 9、あるいは VCF 9 でサポートされています。

7.

  • vSAN ファイルサービスなどのファイル永続ボリューム (PV) は、ユーザー名前空間をサポートしていません。

6.1.3. 動的プロビジョニング

動的プロビジョニングは、ストレージクラス設定からオンデマンドで永続ボリュームを作成します。Container Storage Interface (CSI) ドライバーは、動作を決定する特定のパラメーターをサポートします。デフォルトのストレージクラスを作成して、クラスを指定せずにクレームのプロビジョニングを有効にします。

永続ストレージの動的プロビジョニングは、CSI ドライバーおよび基礎となるストレージバックエンドの機能により異なります。CSI ドライバーのプロバイダーは、OpenShift Container Platform でのストレージクラスの作成方法および設定に利用でじるパラメーターに関する文書を作成する必要があります。

作成されたストレージクラスは、動的プロビジョニングを有効にするために設定できます。

手順

  • デフォルトのストレージクラスを作成します。これにより、特殊なストレージクラスを必要としないすべての PVC がインストールされた CSI ドライバーでプロビジョニングされます。

    # oc create -f - << EOF
    apiVersion: storage.k8s.io/v1
    kind: StorageClass
    metadata:
      name: <storage-class>
      annotations:
        storageclass.kubernetes.io/is-default-class: "true"
    provisioner: <provisioner-name>
    parameters:
      csi.storage.k8s.io/fstype: xfs
    EOF
  • metadata.name: 作成されるストレージクラスの名前を指定します。
  • provisioner: インストールされている CSI ドライバーの名前を指定します。
  • parameters.csi.storage.k8s.io/fstype: vSphere CSI ドライバーは、XFS や Ext4 など、基盤となる Red Hat Core オペレーティングシステムリリースでサポートされているすべてのファイルシステムをサポートします。

6.1.4. CSI ドライバーの使用例

Container Storage Interface (CSI) 永続ストレージを使用して MySQL アプリケーションをデプロイし、動的ボリュームプロビジョニングをデモンストレーションします。この例では、CSI ドライバーが手動で介入することなく、永続ボリューム要求を自動的に作成し、動的にプロビジョニングされたボリュームにバインドする方法を示します。

前提条件

  • CSI ドライバーがデプロイされている。
  • 動的プロビジョニング用にストレージクラスが作成されている。

手順

  • MySQL テンプレートを作成します。

    # oc new-app mysql-persistent

    出力例

    --> Deploying template "openshift/mysql-persistent" to project default
    ...

    # oc get pvc

    出力例

    NAME           STATUS         VOLUME                                   CAPACITY ACCESS MODES   STORAGECLASS   AGE
    mysql          Bound          kubernetes-dynamic-pv-3271ffcb4e1811e8   1Gi      RWO            gp3-csi        3s

6.2. CSI インラインの一時ボリューム

Pod デプロイメント時に自動的に作成され、Pod 終了時に削除される Container Storage Interface (CSI) インラインエフェメラルボリュームを使用して、Pod 固有の一時的なストレージをプロビジョニングできます。

6.2.1. CSI インラインのエフェメラルボリュームの概要

従来は、Container Storage Interface (CSI) ドライバーでサポートされるボリュームは PersistentVolume および PersistentVolumeClaim オブジェクトの組み合わせでのみ使用できます。

CSI インラインエフェメラルボリュームを使用すると、PersistentVolume オブジェクトではなく、Pod 仕様に CSI ボリュームを直接指定できます。インラインボリュームは一時的なボリュームであり、Pod の再起動後は永続化されません。

CSI インラインエフェメラルボリュームは、サポートされている次の CSI ドライバーでのみ使用できます。

  • Azure File CSI ドライバー
  • Secrets Store CSI ドライバー

6.2.1.1. CSI インラインエフェメラルボリュームのサポート制限

重要

Shared Resource CSI Driver 機能は、Builds for Red Hat OpenShift 1.1 で一般提供されました。この機能は OpenShift Container Platform 4.18 以降で削除されました。この機能を使用するには、Red Hat OpenShift 1.1 以降の Builds を使用している必要があります。builds for Red Hat OpenShift 1.1 の詳細は、「builds for Red Hat OpenShift 1.1」を参照してください。

デフォルトで、OpenShift Container Platform は以下の制限下で CSI インラインのエフェメラルボリュームのクローン作成をサポートします。

  • サポートは CSI ドライバーでのみ利用可能です。インツリーおよび FlexVolumes はサポートされません。
  • コミュニティーまたはストレージベンダーは、これらのボリュームをサポートする他の CSI ドライバーを提供します。CSI ドライバーのプロバイダーが提供するインストール手順に従います。

CSI ドライバーは、Ephemeral 機能を含む、インラインボリューム機能を実装していない可能性があります。詳細は、CSI ドライバーのドキュメントを参照してください。

6.2.2. CSI Volume Admission プラグイン

Container Storage Interface (CSI) のエフェメラルボリュームの使用を Pod のセキュリティー標準に基づいて制限するために、CSI Volume Admission プラグインは CSI ドライバー上のセキュリティープロファイルラベルを検査してアドミッションポリシーを適用します。

6.2.2.1. CSI Volume Admission プラグインの概要

CSI Volume Admission プラグインを使用すると、Pod アドミッション時に CSI エフェメラルボリュームをプロビジョニングできる個別の CSI ドライバーの使用を制限できます。管理者は csi-ephemeral-volume-profile ラベルを追加できます。このラベルは Admission プラグインによって検査され、施行、警告、監査の決定に使用されます。

CSI Volume Admission プラグインを使用するには、管理者は security.openshift.io/csi-ephemeral-volume-profile ラベルを CSIDriver オブジェクトに追加します。これは、CSI エフェメラルボリュームを提供するために使用される CSI ドライバーの有効な Pod セキュリティープロファイルを次のように宣言します。次の例に示されています。

CSI Admission プラグインの使用を可能にする CSIDriver YAML ファイルの例

kind: CSIDriver
metadata:
  name: csi.mydriver.company.org
  labels:
    security.openshift.io/csi-ephemeral-volume-profile: restricted

metadata.labels.security.openshift.io/csi-ephemeral-volume-profile を restricted に設定すると、CSI Admission プラグインが使用できるようになります。

この “有効なプロファイル” は、Pod の namespace が Pod のセキュリティー標準によって管理されている場合に、Pod が CSI ドライバーを使用して CSI エフェメラルボリュームをマウントできることを伝えます。

CSI Volume Admission プラグインは、Pod の作成時に Pod ボリュームを検査します。CSI ボリュームを使用する既存の Pod は影響を受けません。Pod がコンテナーストレージインターフェイス (CSI) ボリュームを使用する場合、プラグインは CSIDriver オブジェクトを検索して csi-ephemeral-volume-profile ラベルを検査し、そのラベルの値を適用、警告、および監査の決定に使用します。

6.2.2.2. Pod セキュリティープロファイルの適用

CSI ドライバーに csi-ephemeral-volume-profile ラベルが付いている場合、CSI ドライバーを使用して CSI エフェメラルボリュームをマウントする Pod は、同等以上のアクセス許可の Pod セキュリティー標準を強制する namespace で実行する必要があります。namespace がより制限的な標準を適用する場合、CSI Volume Admission プラグインは受付を拒否します。以下の表は、指定のラベル値に対するさまざまな Pod セキュリティープロファイルの適用動作を説明しています。

表6.2 Pod セキュリティープロファイルの適用
Pod セキュリティープロファイルドライバーラベル: restrictedドライバーラベル: baselineドライバーラベル: privileged

Restricted

許可

拒否済み

拒否済み

Baseline

許可

許可

拒否済み

Privileged

許可

許可

許可

6.2.2.3. Pod セキュリティープロファイルの警告

CSI Volume Admission プラグインは、CSI ドライバーの有効なプロファイルが Pod namespace の Pod セキュリティー警告プロファイルよりも許容度が高い場合に警告できます。次の表は、指定されたラベル値のさまざまな Pod セキュリティープロファイルで警告がいつ発生するかを示しています。

表6.3 Pod セキュリティープロファイルの警告
Pod セキュリティープロファイルドライバーラベル: restrictedドライバーラベル: baselineドライバーラベル: privileged

Restricted

警告なし

警告

警告

Baseline

警告なし

警告なし

警告

Privileged

警告なし

警告なし

警告なし

6.2.2.4. Pod セキュリティープロファイル監査

CSI ボリュームの受付プラグインは、CSI ドライバーの有効なプロファイルが Pod namespace の Pod セキュリティー監査プロファイルよりも許容されている場合に、監査アノテーションを Pod に適用できます。以下の表は、指定のラベル値のさまざまな Pod セキュリティープロファイルに適用される監査アノテーションを示しています。

表6.4 Pod セキュリティープロファイル監査
Pod セキュリティープロファイルドライバーラベル: restrictedドライバーラベル: baselineドライバーラベル: privileged

Restricted

監査なし

監査

監査

Baseline

監査なし

監査なし

監査

Privileged

監査なし

監査なし

監査なし

6.2.2.5. CSI Volume Admission プラグインのデフォルト動作

CSI エフェメラルボリュームの参照 CSI ドライバーに csi-ephemeral-volume-profile ラベルがない場合、CSI Volume Admission プラグインは、ドライバーに強制、警告、および監査動作用の特権プロファイルがあると見なされます。同様に、Pod の namespace に Pod セキュリティーアドミッションラベルが設定されていない場合、受付プラグインは restricted プロファイルの強制、警告、および監査の決定が許可されていると見なします。そのため、ラベルが設定されていない場合、その CSI ドライバーを使用する CSI エフェメラルボリュームはデフォルトで特権付き namespace でのみ利用できます。

OpenShift Container Platform に同梱され、エフェメラルボリュームをサポートする CSI ドライバーには、csi-ephemeral-volume-profile ラベルの妥当なデフォルトセットがあります。

  • Azure File CSI ドライバー: privileged

必要に応じて、管理者はラベルのデフォルト値を変更できます。

6.2.3. Pod 仕様への CSI インラインエフェメラルボリュームの埋め込み

Pod のライフサイクルに自動的に従う一時ストレージをプロビジョニングするには、Pod 仕様に Container Storage Interface (CSI) インラインエフェメラルボリュームを埋め込み、CSI ドライバーが Pod の起動/停止時にボリュームの作成とクリーンアップを管理するようにします。

手順

  1. Pod オブジェクト定義を作成し、これをファイルに保存します。
  2. 以下の pod YAML ファイルのように、CSI インラインエフェメラルボリュームをファイルに埋め込みます。

    エフェメラルボリュームが埋め込まれた Pod YAML ファイルの例

    kind: Pod
    apiVersion: v1
    metadata:
      name: my-csi-app
    spec:
      containers:
        - name: my-frontend
          image: busybox
          volumeMounts:
          - mountPath: "/data"
            name: my-csi-inline-vol
          command: [ "sleep", "1000000" ]
      volumes:
        - name: my-csi-inline-vol
          csi:
            driver: inline.storage.kubernetes.io
            volumeAttributes:
              foo: bar

    ここで、`spec.volumes.name` は Pod が使用するボリュームの名前です。

  3. 以下のコマンドを実行して、前の手順で保存したオブジェクト定義ファイルを作成します。

    $ oc create -f my-csi-app.yaml

6.3. CSI ボリュームスナップショット

Container Storage Interface (CSI) スナップショットは、データ保護とリカバリーのためにポイントインタイムコピーを取得します。スナップショットを使用すると、VolumeSnapshot、VolumeSnapshotContent、および VolumeSnapshotClass オブジェクトを使用して、ボリュームを以前の状態に復元したり、既存のデータから新しいボリュームを作成したりできます。

6.3.1. CSI ボリュームスナップショットの概要

スナップショットは、特定の時点でのクラスター内のストレージボリュームの状態を表します。ボリュームスナップショットは新規ボリュームのプロビジョニングに使用できます。

OpenShift Container Platform は、デフォルトで Container Storage Interface (CSI) ボリュームスナップショットをサポートします。ただし、特定の CSI ドライバーが必要です。

永続ボリューム をある程度理解していることが推奨されます。永続ボリュームの詳細は、「永続ボリューム」を参照してください。

CSI ボリュームのスナップショットを使用して、クラスター管理者は以下を行うことができます。

  • スナップショットをサポートするサードパーティーの CSI ドライバーをデプロイします。
  • 既存のボリュームスナップショットから永続ボリューム要求 (PVC) を新たに作成します。
  • 既存の PVC のスナップショットを作成します。
  • スナップショットを別の PVC として復元します。
  • 既存のボリュームスナップショットを削除します。

CSI ボリュームスナップショットを使用すると、アプリケーション開発者は以下を行うことができます。

  • ボリュームスナップショットは、アプリケーションレベルまたはクラスターレベルのストレージバックアップソリューションを開発するためのビルディングブロックとして使用します。
  • 迅速に直前の開発バージョンにロールバックします。
  • 毎回フルコピーを作成する必要がないため、ストレージをより効率的に使用できます。

ボリュームスナップショットを使用する場合は、以下の点に注意してください。

  • サポートは CSI ドライバーでのみ利用可能です。インツリーおよび FlexVolumes はサポートされません。
  • OpenShift Container Platform には一部の CSI ドライバーのみが含まれています。OpenShift Container Platform Driver Operator によって提供されない CSI ドライバーについては、Kubernetes コミュニティーまたは既知のストレージベンダー が提供する CSI ドライバーを使用することが推奨されます。CSI ドライバーのプロバイダーが提供するインストール手順に従います。Kubernetes CSI ドライバーの詳細は、「Kubernetes CSI Developer Documentation」を参照してください。
  • CSI ドライバーは、ボリュームのスナップショット機能を実装している場合もあれば、実装していない場合もあります。ボリュームスナップショットのサポートを提供している CSI ドライバーは、csi-external-snapshotter サイドカーコンテナーを使用する可能性があります。詳細は、CSI ドライバーで提供されるドキュメントを参照してください。

6.3.2. CSI スナップショットコントローラーおよびサイドカー

Container Storage Interface (CSI) スナップショットには、OpenShift Container Platform によってコントロールプレーンにデプロイされるコントローラーと、CSI ドライバーを備えたベンダー提供のサイドカーの 2 つのコンポーネントが必要です。コントローラーは VolumeSnapshot バインディングを管理し、サイドカーは作成および削除操作をトリガーします。

CSI スナップショットコントローラーおよびサイドカーは、OpenShift Container Platform API を使用してボリュームのスナップショットを提供します。これらの外部コンポーネントはクラスターで実行されます。

外部コントローラーは CSI スナップショットコントローラー Operator によってデプロイされます。

外部コントローラー
CSI スナップショットコントローラーは VolumeSnapshot および VolumeSnapshotContent オブジェクトをバインドします。コントローラーは、VolumeSnapshotContent オブジェクトを作成し、削除して動的プロビジョニングを管理します。
外部サイドカー
CSI ドライバーベンダーは、csi-external-snapshotter サイドカーを提供します。これは、CSI ドライバーでデプロイされる別のヘルパーコンテナーです。サイドカーは、CreateSnapshot および DeleteSnapshot 操作をトリガーしてスナップショットを管理します。ベンダーが提供するインストールの手順に従います。

6.3.3. CSI スナップショットコントローラー Operator について

OpenShift Container Platform では、CSI Snapshot Controller Operator のカスタムリソース定義 (CRD) を使用して、スナップショット要求、ストレージ、および設定のボリュームスナップショットを管理できます。

Container Storage Interface (CSI) スナップショットコントローラー Operator は openshift-cluster-storage-operator namespace で実行されます。これは、デフォルトですべてのクラスターの Cluster Version Operator (CVO) によってインストールされます。

CSI スナップショットコントローラー Operator は、openshift-cluster-storage-operator namespace で実行される CSI スナップショットコントローラーをインストールします。

6.3.3.1. ボリュームスナップショット CRD

OpenShift Container Platform のインストール時に、CSI スナップショットコントローラー Operator は、snapshot.storage.k8s.io/v1 API グループに以下のスナップショットのカスタムリソース定義 (CRD) を作成します。

VolumeSnapshotContent

クラスター管理者がプロビジョニングしたクラスター内のボリュームのスナップショット。

PersistentVolume オブジェクトと同様に、VolumeSnapshotContent CRD はストレージバックエンドの実際のスナップショットを参照するクラスターリソースです。

手動でプロビジョニングされたスナップショットの場合、クラスター管理者は多くの VolumeSnapshotContent CRD を作成します。これらには、ストレージシステム内の実際のボリュームスナップショットの詳細が含まれます。

VolumeSnapshotContent CRD には namespace が使用されず、これはクラスター管理者によって使用されるものです。

VolumeSnapshot

PersistentVolumeClaim オブジェクトと同様に、VolumeSnapshot CRD はスナップショットの開発者要求を定義します。CSI スナップショットコントローラー Operator は、適切な VolumeSnapshotContent CRD で VolumeSnapshot CRD のバインディングを処理する CSI スナップショットコントローラーを実行します。バインディングは 1 対 1 のマッピングです。

VolumeSnapshot CRD には namespace が使用されます。開発者は、CRD をスナップショットの個別の要求として使用します。

VolumeSnapshotClass

VolumeSnapshotClass CRD を使用すると、クラスター管理者は、VolumeSnapshot オブジェクトに属する異なる属性を指定できます。これらの属性は、ストレージシステムの同じボリュームで作成されるスナップショット間で異なる場合があります。この場合、それらは永続ボリューム要求の同じストレージクラスを使用して表現できません。

VolumeSnapshotClass CRD は、スナップショットの作成時に使用する csi-external-snapshotter サイドカーのパラメーターを定義します。これにより、ストレージバックエンドは、複数のオプションがサポートされる場合に動的に作成するスナップショットの種類を認識できます。

動的にプロビジョニングされるスナップショットは VolumeSnapshotClass CRD を使用して、スナップショットの作成時に使用するストレージプロバイダー固有のパラメーターを指定します。

VolumeSnapshotContentClass CRD には namespace が使用されず、クラスター管理者がストレージバックエンドのグローバル設定オプションを有効にするために使用します。

6.3.4. ボリュームスナップショットのプロビジョニング

OpenShift Container Platform でボリュームスナップショットをプロビジョニングするには、動的プロビジョニングを使用してオンデマンドで新しいスナップショットを作成するか、静的プロビジョニングを使用して既存のスナップショットを参照します。

6.3.4.1. 動的プロビジョニング

既存のスナップショットを使用する代わりに、スナップショットを永続ボリューム要求から動的に取得するように要求できます。パラメーターは VolumeSnapshotClass CRD を使用して指定されます。

6.3.4.2. 静的プロビジョニング

クラスター管理者は、多数の VolumeSnapshotContent オブジェクトを手動で事前にプロビジョニングできます。これらは、クラスターユーザーが利用できる実際のボリュームのスナップショットの詳細を保持します。

6.3.5. ボリュームのスナップショットを動的に作成する

永続ボリューム要求 (PVC) のポイントインタイムバックアップを作成するには、スナップショットの作成を自動化する VolumeSnapshotClass と VolumeSnapshot を定義して、ボリュームスナップショットを動的にプロビジョニングします。

VolumeSnapshot オブジェクトを作成すると、OpenShift Container Platform はボリュームスナップショットを作成します。

前提条件

  • 実行中の OpenShift Container Platform クラスターにログインしている。
  • VolumeSnapshot オブジェクトをサポートする CSI ドライバーを使用して作成される PVC。
  • ストレージバックエンドをプロビジョニングするストレージクラス。
  • スナップショットの作成に使用する必要のある永続ボリューム要求 (PVC) を使用している Pod はありません。

    警告

    Pod によって使用されている PVC のボリュームスナップショットを作成すると、書き込まれていないデータやキャッシュされたデータがスナップショットから除外される可能性があります。すべてのデータがディスクに確実に書き込まれるようにするには、PVC を使用している Pod を削除してから、スナップショットを作成してください。

手順

  1. 以下の YAML によって記述される VolumeSnapshotClass オブジェクトを使用してファイルを作成します。

    volumesnapshotclass.yaml の例

    apiVersion: snapshot.storage.k8s.io/v1
    kind: VolumeSnapshotClass
    metadata:
      name: csi-hostpath-snap
    driver: hostpath.csi.k8s.io
    deletionPolicy: Delete

    driver は、この VolumeSnapshotClass オブジェクトのスナップショットを作成するために使用される CSI ドライバーの名前です。名前は、スナップショットが作成される PVC に対応するストレージクラスの Provisioner フィールドと同じである必要があります。

    注記

    永続ストレージの設定に使用したドライバーによっては、追加のパラメーターが必要になる場合があります。既存の VolumeSnapshotClass オブジェクトを使用することもできます。

  2. 以下のコマンドを実行して、直前の手順で保存されたオブジェクトを作成します。

    $ oc create -f volumesnapshotclass.yaml
  3. VolumeSnapshot オブジェクトを作成します。

    volumesnapshot-dynamic.yaml の例

    apiVersion: snapshot.storage.k8s.io/v1
    kind: VolumeSnapshot
    metadata:
      name: mysnap
    spec:
      volumeSnapshotClassName: csi-hostpath-snap
      source:
        persistentVolumeClaimName: myclaim

    • spec.volumeSnapshotClassName: ボリュームスナップショットによって特定のクラスのリクエストを指定します。volumeSnapshotClassName 設定がなく、デフォルトのボリュームスナップショットクラスがある場合、スナップショットはデフォルトのボリュームスナップショットクラス名で作成されます。ただし、フィールドがなく、デフォルトのボリュームスナップショットクラスが存在しない場合には、スナップショットは作成されません。
    • spec.source.persistentVolumeClaimName: 永続ボリュームにバインドされた PersistentVolumeClaim オブジェクトの名前を指定します。これは、スナップショットの作成に使用する内容を定義します。スナップショットの動的プロビジョニングに必要です。
  4. 以下のコマンドを実行して、直前の手順で保存されたオブジェクトを作成します。

    $ oc create -f volumesnapshot-dynamic.yaml

検証

  1. スナップショットがクラスターで作成されると、スナップショットに関する追加情報が利用可能になります。

    作成したボリュームスナップショットの詳細を表示するには、次のコマンドを実行します。

    $ oc describe volumesnapshot mysnap

    以下の例は、mysnap ボリュームスナップショットの詳細を表示します。

    volumesnapshot.yaml の例

    apiVersion: snapshot.storage.k8s.io/v1
    kind: VolumeSnapshot
    metadata:
      name: mysnap
    spec:
      source:
        persistentVolumeClaimName: myclaim
      volumeSnapshotClassName: csi-hostpath-snap
    status:
      boundVolumeSnapshotContentName: snapcontent-1af4989e-a365-4286-96f8-d5dcd65d78d6
      creationTime: "2020-01-29T12:24:30Z"
      readyToUse: true
      restoreSize: 500Mi

    • status.boundVolumeSnapshotContentName: このパラメーターは、コントローラーによって作成された実際のストレージコンテンツへのポインターです。
    • status.creationTime: スナップショットが作成された時刻を指定します。スナップショットには、このタイミングで利用できるボリュームコンテンツが含まれます。
    • status.readyToUse: スナップショットの準備状況を指定します。値が true に設定されている場合、スナップショットを使用して新規 PVC として復元できます。値が false に設定されている場合、スナップショットが作成されています。ただし、ストレージバックエンドは、スナップショットを新規ボリュームとして復元できるようにするために、追加のタスクを実行してスナップショットを使用できる状態にする必要があります。たとえば、Amazon Elastic Block Store データを別の低コストの場所に移動する場合があり、これには数分の時間がかかる可能性があります。
  2. ボリュームのスナップショットが作成されたことを確認するには、以下のコマンドを実行します。

    $ oc get volumesnapshotcontent

    実際のコンテンツへのポインターが表示されます。boundVolumeSnapshotContentName フィールドにデータが設定される場合、VolumeSnapshotContent オブジェクトが存在し、スナップショットが作成されています。

  3. スナップショットの準備が完了していることを確認するには、VolumeSnapshot オブジェクトに readyToUse: true があることを確認します。

6.3.6. ボリュームスナップショットの静的作成

既存のストレージスナップショットを OpenShift Container Platform で使用できるようにするには、既存のスナップショットの内容を名前で参照するボリュームスナップショットを手動で作成します。

前提条件

  • 実行中の OpenShift Container Platform クラスターにログインしている。
  • VolumeSnapshot オブジェクトをサポートする CSI ドライバーを使用して作成される PVC。
  • ストレージバックエンドをプロビジョニングするストレージクラス。
  • スナップショットの作成に使用する必要のある永続ボリューム要求 (PVC) を使用している Pod はありません。

    警告

    Pod によって使用されている PVC のボリュームスナップショットを作成すると、書き込まれていないデータやキャッシュされたデータがスナップショットから除外される可能性があります。すべてのデータがディスクに確実に書き込まれるようにするには、PVC を使用している Pod を削除してから、スナップショットを作成してください。

手順

  1. 以下の YAML によって記述される VolumeSnapshotClass オブジェクトを使用してファイルを作成します。

    volumesnapshotclass.yaml の例

    apiVersion: snapshot.storage.k8s.io/v1
    kind: VolumeSnapshotClass
    metadata:
      name: csi-hostpath-snap
    driver: hostpath.csi.k8s.io
    deletionPolicy: Delete

    driver は、この VolumeSnapshotClass オブジェクトのスナップショットを作成するために使用される CSI ドライバーの名前です。名前は、スナップショットが作成される PVC に対応するストレージクラスの Provisioner フィールドと同じである必要があります。

    注記

    永続ストレージの設定に使用したドライバーによっては、追加のパラメーターが必要になる場合があります。既存の VolumeSnapshotClass オブジェクトを使用することもできます。

  2. 以下のコマンドを実行して、直前の手順で保存されたオブジェクトを作成します。

    $ oc create -f volumesnapshotclass.yaml
  3. スナップショットのソースとして、volumeSnapshotContentName パラメーターの値を指定します。

    volumesnapshot-manual.yaml の例

    apiVersion: snapshot.storage.k8s.io/v1
    kind: VolumeSnapshot
    metadata:
      name: snapshot-demo
    spec:
      source:
        volumeSnapshotContentName: mycontent

    事前にプロビジョニングされたスナップショットには、spec.source.volumeSnapshotContentName が必要です。

  4. 以下のコマンドを実行して、直前の手順で保存されたオブジェクトを作成します。

    $ oc create -f volumesnapshot-manual.yaml

検証

スナップショットがクラスターで作成されると、スナップショットに関する追加情報が利用可能になります。

  1. 作成したボリュームスナップショットの詳細を表示するには、以下のコマンドを実行します。

    $ oc describe volumesnapshot mysnap

    以下の例は、mysnap ボリュームスナップショットの詳細を表示します。

    volumesnapshot.yaml の例

    apiVersion: snapshot.storage.k8s.io/v1
    kind: VolumeSnapshot
    metadata:
      name: mysnap
    spec:
      source:
        persistentVolumeClaimName: myclaim
      volumeSnapshotClassName: csi-hostpath-snap
    status:
      boundVolumeSnapshotContentName: snapcontent-1af4989e-a365-4286-96f8-d5dcd65d78d6
      creationTime: "2020-01-29T12:24:30Z"
      readyToUse: true
      restoreSize: 500Mi

    • status.boundVolumeSnapshotContentName: コントローラーによって作成された実際のストレージコンテンツへのポインターを指定します。
    • status.creationTime: スナップショットが作成された時刻を指定します。スナップショットには、このタイミングで利用できるボリュームコンテンツが含まれます。
    • status.readyToUse: 値が true に設定されている場合、スナップショットを使用して新規 PVC として復元できます。値が false に設定されている場合、スナップショットが作成されています。ただし、ストレージバックエンドは、スナップショットを新規ボリュームとして復元できるようにするために、追加のタスクを実行してスナップショットを使用できる状態にする必要があります。たとえば、Amazon Elastic Block Store データを別の低コストの場所に移動する場合があり、これには数分の時間がかかる可能性があります。
  2. ボリュームのスナップショットが作成されたことを確認するには、以下のコマンドを実行します。

    $ oc get volumesnapshotcontent

    実際のコンテンツへのポインターが表示されます。boundVolumeSnapshotContentName フィールドにデータが設定される場合、VolumeSnapshotContent オブジェクトが存在し、スナップショットが作成されています。

  3. スナップショットの準備が完了していることを確認するには、VolumeSnapshot オブジェクトに readyToUse: true があることを確認します。

6.3.7. ボリュームスナップショットの削除

不要なスナップショットをクリーンアップしてストレージリソースを解放するには、基盤となるコンテンツを保持するか削除するかを制御する削除ポリシーを設定して、ボリュームスナップショットを削除します。

手順

  1. 以下の例のように、VolumeSnapshotClass オブジェクトで必要な削除ポリシーを指定します。

    volumesnapshotclass.yaml ファイルの例

    apiVersion: snapshot.storage.k8s.io/v1
    kind: VolumeSnapshotClass
    metadata:
      name: csi-hostpath-snap
    driver: hostpath.csi.k8s.io
    deletionPolicy: Delete
    # ...

    ボリュームスナップショットの削除時に deletionPolicy が Delete に設定されている場合、基礎となるスナップショットは VolumeSnapshotContent オブジェクトと共に削除されます。Retain 値を設定すると、基礎となるスナップショットと VolumeSnapshotContent オブジェクトの両方が残ります。

    注記

    Retain 値を設定し、対応する VolumeSnapshotContent オブジェクトを削除せずに VolumeSnapshot オブジェクトを削除すると、コンテンツは残ります。スナップショット自体はストレージバックエンドにも保持されます。

  2. 以下のコマンドを入力してボリュームスナップショットを削除します。

    $ oc delete volumesnapshot <volumesnapshot_name>

    <volumesnapshot_name> は、削除するボリュームスナップショットの名前に置き換えます。

    出力例

    volumesnapshot.snapshot.storage.k8s.io "mysnapshot" deleted

  3. 削除ポリシーが Retain に設定されている場合は、以下のコマンドを入力してボリュームスナップショットのコンテンツを削除します。

    $ oc delete volumesnapshotcontent <volumesnapshotcontent_name>

    <volumesnapshotcontent_name> は、削除するコンテンツに置き換えます。

  4. オプション: VolumeSnapshot オブジェクトが正常に削除されていない場合は、以下のコマンドを実行して残されているリソースのファイナライザーを削除し、削除操作を続行できるようにします。

    重要

    永続ボリューム要求またはボリュームスナップショットのコンテンツのいずれかから VolumeSnapshot オブジェクトへの既存の参照がない場合にのみファイナライザーを削除します。--force オプションを使用する場合でも、すべてのファイナライザーが削除されるまで削除操作でスナップショットオブジェクトは削除されません。

    $ oc patch -n $PROJECT volumesnapshot/$NAME --type=merge -p '{"metadata": {"finalizers":null}}'

    出力例

    volumesnapshotclass.snapshot.storage.k8s.io "csi-ocs-rbd-snapclass" deleted

    ファイナライザーが削除され、ボリュームスナップショットが削除されます。

6.3.8. ボリュームスナップショットの復元

以前のデータを回復したり、スナップショットデータを再利用したりするには、既存のボリュームスナップショットのコンテンツが事前に入力された新しい永続ボリューム要求 (PVC) を作成します。

VolumeSnapshot CRD コンテンツは、既存のボリュームを以前の状態に復元するために使用されます。VolumeSnapshot CRD がバインドされ、readyToUse 値が true に設定された後に、そのリソースを使用して、スナップショットからのデータが事前に設定されている新規ボリュームをプロビジョニングできます。

前提条件

  • 実行中の OpenShift Container Platform クラスターにログインしている。
  • ボリュームスナップショットをサポートする Container Storage Interface (CSI) ドライバーを使用して作成される永続ボリューム要求 (PVC)。
  • ストレージバックエンドをプロビジョニングするストレージクラス。
  • ボリュームスナップショットが作成され、使用できる状態である。

手順

  1. 以下のように PVC に VolumeSnapshot データソースを指定します。

    pvc-restore.yaml

    apiVersion: v1
    kind: PersistentVolumeClaim
    metadata:
      name: myclaim-restore
    spec:
      storageClassName: csi-hostpath-sc
      dataSource:
        name: mysnap
        kind: VolumeSnapshot
        apiGroup: snapshot.storage.k8s.io
      accessModes:
        - ReadWriteOnce
      resources:
        requests:
          storage: 1Gi

    • spec.dataSource.name: ソースとして使用するスナップショットを表す VolumeSnapshot オブジェクトの名前を指定します。
    • spec.dataSource.kind: VolumeSnapshot 値に設定する必要があります。
    • spec.dataSource.apiGroup: snapshot.storage.k8s.io 値に設定する必要があります。
  2. 以下のコマンドを実行して PVC を作成します。

    $ oc create -f pvc-restore.yaml
  3. 以下のコマンドを実行して、復元された PVC が作成されていることを確認します。

    $ oc get pvc

    myclaim-restore などの新規 PVC が表示されます。

6.3.9. vSphere のスナップショットの最大数の変更

vSphere 環境でストレージ容量とパフォーマンスのバランスを取るには、ボリュームあたりのスナップショットの最大数をグローバルまたは特定のデータストアタイプに設定します。

vSphere Container Storage Interface (CSI) のボリュームあたりのスナップショットのデフォルトの最大数は 3 です。1 ボリュームあたり最大 32 個まで変更できます。ただし、スナップショットの最大値を増やすとパフォーマンスとのトレードオフが発生するため、パフォーマンスを向上させるには、ボリュームごとに 2 - 3 個のスナップショットのみを使用するようにしてください。

VMware スナップショットのパフォーマンスに関する推奨事項は、「vSphere 環境で VMware スナップショットを使用するためのベストプラクティス」を参照してください。

前提条件

  • 管理者権限でクラスターにアクセスできる。

手順

  1. 次のコマンドを実行して、現在のシークレットを確認します。

    $ oc -n openshift-cluster-csi-drivers get secret/vsphere-csi-config-secret -o jsonpath='{.data.cloud\.conf}' | base64 -d

    出力例

    # Labels with topology values are added dynamically via operator
    [Global]
    cluster-id = vsphere-01-cwv8p
    
    # Populate VCenters (multi) after here
    [VirtualCenter "vcenter.openshift.com"]
    insecure-flag           = true
    datacenters             = DEVQEdatacenter
    password                = "xxxxxxxx"
    user                    = "xxxxxxxx@devcluster.openshift.com"
    migration-datastore-url = ds:///vmfs/volumes/vsan:52c842f232751e0d-3253aadeac21ca82/

    この例では、スナップショットのグローバル最大数は設定されていないため、デフォルト値の 3 が適用されます。

  2. 次のコマンドを実行してスナップショットの制限を変更します。

    • global スナップショット制限を設定します。

      $ oc patch clustercsidriver/csi.vsphere.vmware.com --type=merge -p '{"spec":{"driverConfig":{"vSphere":{"globalMaxSnapshotsPerBlockVolume": 10}}}}'
      
      clustercsidriver.operator.openshift.io/csi.vsphere.vmware.com patched

      この例では、グローバル制限が 10 に変更されます (globalMaxSnapshotsPerBlockVolume が 10 に設定されています)。

    • 仮想ボリューム のスナップショット制限を設定します。

      このパラメーターは、仮想ボリュームデータストアのみに制限を設定します。仮想ボリュームの最大スナップショット制限は、設定されている場合はグローバル制約をオーバーライドしますが、設定されていない場合はデフォルトでグローバル制限になります。

      $ oc patch clustercsidriver/csi.vsphere.vmware.com --type=merge -p '{"spec":{"driverConfig":{"vSphere":{"granularMaxSnapshotsPerBlockVolumeInVVOL": 5}}}}'
      clustercsidriver.operator.openshift.io/csi.vsphere.vmware.com patched

      この例では、仮想ボリュームの制限が 5 に変更されます (granularMaxSnapshotsPerBlockVolumeInVVOL が 5 に設定されています)。

    • vSAN スナップショットの制限を設定します。

      このパラメーターは、vSAN データストアのみに制限を設定します。vSAN の最大スナップショット制限は、設定されている場合はグローバル制約をオーバーライドしますが、設定されていない場合はデフォルトでグローバル制限になります。vSAN ESA セットアップでは、最大値 32 を設定できます。

      $ oc patch clustercsidriver/csi.vsphere.vmware.com --type=merge -p '{"spec":{"driverConfig":{"vSphere":{"granularMaxSnapshotsPerBlockVolumeInVSAN": 7}}}}'
      clustercsidriver.operator.openshift.io/csi.vsphere.vmware.com patched

      この例では、vSAN 制限が 7 に変更されます (granularMaxSnapshotsPerBlockVolumeInVSAN が 7 に設定されています)。

検証

  • 次のコマンドを実行して、行った変更が config map に反映されていることを確認します。

    $ oc -n openshift-cluster-csi-drivers get secret/vsphere-csi-config-secret -o jsonpath='{.data.cloud\.conf}' | base64 -d

    出力例

    # Labels with topology values are added dynamically via operator
    [Global]
    cluster-id = vsphere-01-cwv8p
    
    # Populate VCenters (multi) after here
    [VirtualCenter "vcenter.openshift.com"]
    insecure-flag           = true
    datacenters             = DEVQEdatacenter
    password                = "xxxxxxxx"
    user                    = "xxxxxxxx@devcluster.openshift.com"
    migration-datastore-url = ds:///vmfs/volumes/vsan:52c842f232751e0d-3253aadeac21ca82/
    
    [Snapshot]
    global-max-snapshots-per-block-volume = 10

    global-max-snapshots-per-block-volume パラメーターが 10 に設定されました。

6.4. CSI ボリュームグループスナップショット

ボリュームグループのスナップショットは、複数のボリュームのポイントインタイムコピーを同時にキャプチャし、関連するボリューム間でデータを収集します。これにより、マルチボリュームアプリケーションを以前の状態に復元したり、テストまたは開発目的で同じデータを使用して新しいボリュームセットをプロビジョニングしたりできます。

6.4.1. CSI ボリュームグループスナップショットの概要

ボリュームグループスナップショットは、ラベルセレクターを使用して、複数の永続ボリュームクレームのポイントインタイムコピーをキャプチャーします。VolumeGroupSnapshot、VolumeGroupSnapshotContent、VolumeGroupSnapshotClass の 3 つの API オブジェクトがスナップショットを管理します。

重要

CSI ボリュームグループスナップショットは、テクノロジープレビュー機能です。テクノロジープレビュー機能は、Red Hat 製品のサービスレベルアグリーメント (SLA) の対象外であり、機能的に完全ではないことがあります。Red Hat は、実稼働環境でこれらを使用することを推奨していません。テクノロジープレビュー機能は、最新の製品機能をいち早く提供して、開発段階で機能のテストを行い、フィードバックを提供していただくことを目的としています。

Red Hat のテクノロジープレビュー機能のサポート範囲に関する詳細は、テクノロジープレビュー機能のサポート範囲 を参照してください。

このテクノロジープレビュー機能を使用するには、フィーチャーゲートを使用して有効にする必要があります。フィーチャーゲートの使用に関する詳細は、「フィーチャーゲートを使用した機能の有効化」を参照してください。

Snapshot
スナップショットは、特定の時点でのクラスター内のストレージボリュームの状態を表します。ボリュームスナップショットは新規ボリュームのプロビジョニングに使用できます。
ボリュームグループのスナップショット
ボリュームグループスナップショット は、ラベルセレクターを使用して、スナップショット用に複数の永続ボリューム要求をグループ化します。ボリュームグループスナップショットは、同じ時点で取得された複数のボリュームからのコピーを表します。これは、複数のボリュームが含まれるアプリケーションに役立ちます。

ボリュームグループスナップショットを使用するには、永続ボリュームに精通していることを推奨します。永続ボリュームの詳細は、「永続ボリュームについて」を参照してください。

ボリュームグループスナップショットは、スナップショットを管理するための 3 つの新しい API オブジェクトを提供します。

VolumeGroupSnapshot
複数の永続ボリューム要求のボリュームグループスナップショットの作成を要求します。ボリュームグループスナップショットが作成されたタイムスタンプや、使用できる状態かどうかなど、ボリュームグループスナップショットの操作に関する情報を含んでいます。
VolumeGroupSnapshotContent
動的に作成された volumeGroupSnapshot のスナップショットコントローラーによって作成されます。ボリュームグループスナップショット ID を含むボリュームグループスナップショットに関する情報を含んでいます。このオブジェクトは、クラスターにプロビジョニングされたリソース (グループスナップショット) を表します。VolumeGroupSnapshotContent オブジェクトは、1 対 1 のマッピングを使用して作成されたボリュームグループスナップショットにバインドされます。
VolumeGroupSnapshotClass
ドライバー情報、削除ポリシーなど、ボリュームグループスナップショットを作成する方法を記述するために、クラスター管理者によって作成されます。

これら 3 種類の API は、CustomResourceDefinitions (CRD) として定義されます。CSI ドライバーがボリュームグループスナップショットをサポートできるように、これらの CRD を OpenShift Container Platform クラスターにインストールする必要があります。

6.4.2. CSI ボリュームグループスナップショットの制限

ボリュームグループのスナップショットには、データ保護と復元に使用する方法に影響を与える、操作と整合性に関する制限があります。これらの制約を理解することで、マルチボリュームアプリケーションの適切なバックアップおよびリカバリストラテジーを設計できます。

ボリュームグループスナップショットには次の制限があります。

  • 既存の永続ボリューム要求 (PVC) を、スナップショットで表される以前の状態に戻すことはサポートされていません。新しいボリュームはスナップショットからのみプロビジョニングできます。
  • ストレージシステムによって提供されるもの以外のアプリケーションの整合性 (クラッシュ整合性など) の保証は提供されません。アプリケーションの整合性の詳細は、「Quiesce and Unquiesce Hooks」を参照してください。
  • Container Storage Interface (CSI) ドライバーによってボリュームグループスナップショットがサポートされている必要があります。OpenShift Data Foundation は、ボリュームグループスナップショットをサポートしています。

6.4.3. ボリュームグループスナップショットクラスの作成

VolumeGroupSnapshotClass を作成して、Container Storage Interface (CSI) ドライバーや削除ポリシーなど、ボリュームグループスナップショットのプロビジョニング方法を定義します。クラスター管理者は、ユーザーがボリュームグループスナップショットをプロビジョニングする前に、このクラスを作成する必要があります。

前提条件

  • 実行中の OpenShift Container Platform クラスターに管理者権限でログインしている。
  • フィーチャーゲートを使用してこの機能を有効にした。フィーチャーゲートの使用方法は、「フィーチャーゲートを使用した機能セットの有効化」を参照してください。

手順

  1. 次のサンプルファイルを使用して、VolumeGroupSnapshotClass YAML ファイルを作成します。

    ボリュームグループスナップショットクラスの YAML ファイルの例

    apiVersion: groupsnapshot.storage.k8s.io/v1beta2
    kind: VolumeGroupSnapshotClass
    metadata:
      name: csi-hostpath-groupsnapclass
    deletionPolicy: Delete
    driver: hostpath.csi.k8s.io
         …...

    • kind: VolumeGroupSnapshotClass オブジェクトを指定します。
    • metadata.name: VolumeGroupSnapshotClass の名前。
  2. 次のコマンドを実行して、'VolumeGroupSnapshotClass' オブジェクトを作成します。

    $ oc create -f <volume-group-snapshot-class-filename>.yaml

6.4.4. ボリュームグループスナップショットの作成

VolumeGroupSnapshot オブジェクトを作成して、複数の永続ボリューム要求 (PVC) のポイントインタイムコピーを取得します。PVC にラベルを付け、VolumeGroupSnapshotClass を指定すると、個々の VolumeSnapshot オブジェクトが自動的に作成されます。

VolumeGroupSnapshot オブジェクトを作成すると、OpenShift Container Platform によってボリュームグループスナップショットが作成されます。

前提条件

  • 実行中の OpenShift Container Platform クラスターにログインしている。
  • フィーチャーゲートを使用してこの機能を有効にした。フィーチャーゲートの使用方法は、「フィーチャーゲートを使用した機能セットの有効化」を参照してください。
  • スナップショット用にグループ化する永続ボリューム要求 (PVC) が、VolumeGroupSnapshot オブジェクトをサポートする CSI ドライバーを使用して作成されている。
  • ストレージバックエンドをプロビジョニングするストレージクラス。
  • 管理者が VolumeGroupSnapshotClass オブジェクトを作成した。

手順

  1. 次のコマンドを実行して、ボリュームグループスナップショットに含める PVC を検索 (または作成) します。

    $ oc get pvc

    例

    NAME        STATUS    VOLUME                                     CAPACITY   ACCESSMODES   AGE
    pvc-0       Bound     pvc-a42d7ea2-e3df-11ed-b5ea-0242ac120002   1Gi        RWO           48s
    pvc-1       Bound     pvc-a42d81b8-e3df-11ed-b5ea-0242ac120002   1Gi        RWO           48S

    この例では 2 つの PVC を使用します。

  2. PVC にラベルを付けて、スナップショットグループに属するようにします。

    1. 次のコマンドを実行して、pvc-0 という PVC にラベルを付けます。

      $ oc label pvc pvc-0 group=myGroup

      出力例

      persistentvolumeclaim/pvc-0 labeled

    2. 次のコマンドを実行して、pvc-1 という PVC にラベルを付けます。

      出力例

      $ oc label pvc pvc-1 group=myGroup

      出力例

      persistentvolumeclaim/pvc-1 labeled

      この例では、PVC "pvc-0" と "pvc-1" がグループ "myGroup" に属するようにラベルを付けます。

  3. ボリュームグループスナップショットを指定する VolumeGroupSnapshot オブジェクトを作成します。

    1. 次のサンプルファイルを使用して、VolumeGroupSnapshot オブジェクトの YAML ファイルを作成します。

      VolumeGroupSnapshot の YAML ファイルの例

      apiVersion: groupsnapshot.storage.k8s.io/v1beta2
      kind: VolumeGroupSnapshot
      metadata:
        name: <volume-group-snapshot-name>
        namespace: <namespace>
      spec:
        volumeGroupSnapshotClassName: <volume-group-snapshot-class-name>
        source:
          selector:
            matchLabels:
              group: myGroup

      • kind: VolumeGroupSnapshot オブジェクトは、複数の PVC のボリュームグループスナップショットの作成を要求します。
      • metadata.name: ボリュームグループスナップショットの名前。
      • metadata.namespace: ボリュームグループスナップショットの名前空間。
      • spec.volumeGroupSnapshotClassName: VolumeGroupSnapshotClass の名前。このオブジェクトは、管理者によって作成され、ボリュームグループスナップショットを作成する方法を記述したものです。
      • spec.source.selector.matchLabels.group: スナップショットに必要な PVC をグループ化するために使用するラベルの名前。この例では、"myGroup" です。
    2. 次のコマンドを実行して、VolumeGroupSnapshot オブジェクトを作成します。

      $ oc create -f <volume-group-snapshot-filename>.yaml

結果

個別のボリュームスナップショットが、ボリュームグループスナップショットの一部として指定した PVC の数に応じて作成されます。

これらの個別のボリュームスナップショットには、<hash of VolumeGroupSnaphotContentUUID+volumeHandle> という形式で名前が付けられます。

apiVersion: snapshot.storage.k8s.io/v1
kind: VolumeSnapshot
metadata:
  name: snapshot-4dc1c53a29538b36e85003503a4bcac5dbde4cff59e81f1e3bb80b6c18c3fd03
  namespace: default
  ownerReferences:
  - apiVersion: groupsnapshot.storage.k8s.io/v1beta2
    kind: VolumeGroupSnapshot
    name: my-groupsnapshot
    uid: ba2d60c5-5082-4279-80c2-daa85f0af354
  resourceVersion: "124503"
  uid: c0137282-f161-4e86-92c1-c41d36c6d04c
spec:
  source:
    persistentVolumeClaimName:pvc-1
status:
  volumeGroupSnapshotName: volume-group-snapshot-name

上記の例では、ボリュームグループスナップショットの一部として 2 つの個別のボリュームスナップショットが作成されます。

snapshot-4dc1c53a29538b36e85003503a4bcac5dbde4cff59e81f1e3bb80b6c18c3fd03
snapshot-fbfe59eff570171765df664280910c3bf1a4d56e233a5364cd8cb0152a35965b

6.4.5. ボリュームグループスナップショットの復元

個々の VolumeSnapshot オブジェクトから新しい永続ボリューム要求 (PVC) を作成して、ボリュームグループスナップショットからボリュームを復元します。各 PVC は、スナップショットデータが入力されたボリュームをプロビジョニングします。グループ内の各 VolumeSnapshot に対して を繰り返し、すべてのボリュームを以前の状態に復元します。

前提条件

  • 実行中の OpenShift Container Platform クラスターにログインしている。
  • ボリュームグループスナップショットをサポートする Container Storage Interface (CSI) ドライバーを使用して PVC を作成した。
  • ストレージバックエンドをプロビジョニングするストレージクラス。
  • ボリュームグループスナップショットが作成され、使用できる状態である。

手順

  1. 次の例に示すように、PVC のボリュームグループスナップショットから VolumeSnapshot データソースを指定します。

    PVC 復元 YAML ファイルの例

    apiVersion: v1
    kind: PersistentVolumeClaim
    metadata:
      name: <pvc-restore-name>
      namespace: <namespace>
    spec:
      storageClassName: csi-hostpath-sc
      dataSource:
        name: snapshot-fbfe59eff570171765df664280910c3bf1a4d56e233a5364cd8cb0152a35965b
        kind: VolumeSnapshot
        apiGroup: snapshot.storage.k8s.io
      accessModes:
        - ReadWriteOnce
      resources:
        requests:
          storage: 1Gi

    • metadata.name: 復元 PVC の名前。
    • metadata.namespace: namespace の名前。
    • spec.dataSource.name: ソースとして使用するボリュームグループスナップショットの一部である個別のボリュームスナップショットの名前。
    • spec.dataSource.kind: VolumeSnapshot 値に設定する必要があります。
    • spec.dataSource.apiGroup: snapshot.storage.k8s.io 値に設定する必要があります。
  2. 以下のコマンドを実行して PVC を作成します。

    $ oc create -f <pvc-restore-filename>.yaml

    ここで、<pvc-restore-filename>.yaml は、前のステップで指定した PVC 復元ファイルの名前です。

  3. 次のコマンドを実行して、復元された PVC が作成されたことを確認します。

    $ oc get pvc

    最初のステップで指定した名前の新しい PVC が表示されます。

  4. 必要に応じて、ボリュームグループスナップショットの一部であるすべてのスナップショットからすべてのボリュームを作成するまで、この手順を繰り返します。

6.5. CSI ボリュームのクローン作成

Container Storage Interface (CSI) ボリュームクローニングは、既存の永続ボリュームを複製して、データ保護、テスト、デプロイメント用の独立したコピーを作成します。クローン作成を使用すると、手動でのコピーやバックアップ復元を行わずに、既存のデータから新しいボリュームを作成できます。

6.5.1. CSI ボリュームのクローン作成の概要

Container Storage Interface (CSI) ボリュームクローンを使用して、既存の永続ボリュームのポイントインタイム複製を作成できます。

ボリュームのクローン作成はボリュームのスナップショットに似ていますが、より効率的な方法です。たとえば、クラスター管理者は、既存のクラスターボリュームの別のインスタンスを作成してクラスターボリュームを複製できます。

クローン作成により、バックエンドのデバイスでは、新規の空のボリュームが作成されるのではなく、指定したボリュームの複製が作成されます。動的プロビジョニングの後には、標準のボリュームを使用するのと同じように、ボリュームクローンを使用できます。

クローン作成に必要な新しい API オブジェクトはありません。PersistentVolumeClaim オブジェクトの既存の dataSource フィールドは、同じ namespace の既存の PersistentVolumeClaim の名前を許可できるように拡張されます。

CSI ボリュームクローンをプロビジョニングする前に、永続ボリューム を理解しておく必要があります。永続ボリュームの詳細は、関連情報の 永続ボリュームの理解 を参照してください。

6.5.1.1. サポートの制限

デフォルトで、OpenShift Container Platform は以下の制限の下で CSI ボリュームのクローン作成をサポートします。

  • 宛先永続ボリューム要求 (PVC) はソース PVC と同じ namespace に存在する必要があります。
  • クローン作成は、別のストレージクラスでサポートされています。

    • 宛先ボリュームは、ソースと異なるストレージクラスでも同じにすることができます。
    • デフォルトのストレージクラスを使用し、spec で storageClassName を省略できます。
  • サポートは CSI ドライバーでのみ利用可能です。インツリーおよび FlexVolumes はサポートされません。
  • CSI ドライバーは、ボリュームのクローン作成機能を実装していない可能性もあります。詳細は、CSI ドライバーのドキュメントを参照してください。

6.5.2. CSI ボリュームクローンのプロビジョニング

既存の PVC をデータソースとして指定する新しい永続ボリューム要求 (PVC) を作成します。新しいボリュームには、移行元 PVC のデータのコピーが自動的に入力され、移行元と同じ namespace に作成する必要があります。

CSI ボリュームクローンのプロビジョニングは、クローン作成された永続ボリューム要求 (PVC) API オブジェクトの作成によってトリガーされます。クローンは、他の永続ボリュームと同じルールに従って、別の PVC の内容を事前に設定します。例外として、同じ namespace の既存 PVC を参照する dataSource を追加する必要があります。

前提条件

  • 実行中の OpenShift Container Platform クラスターにログインしている。
  • PVC がボリュームのクローン作成をサポートする CSI ドライバーを使用して作成されている。
  • ストレージバックエンドが動的プロビジョニング用に設定されている。静的プロビジョナーのクローン作成のサポートは利用できません。

手順

  1. 以下の YAML によって記述される PersistentVolumeClaim オブジェクトを使用してファイルを作成し、保存します。

    pvc-clone.yaml の例

    apiVersion: v1
    kind: PersistentVolumeClaim
    metadata:
      name: pvc-1-clone
      namespace: mynamespace
    spec:
      storageClassName: csi-cloning
      accessModes:
        - ReadWriteOnce
      resources:
        requests:
          storage: 5Gi
      dataSource:
        kind: PersistentVolumeClaim
        name: pvc-1

    ここで、spec.storageClassName はストレージバックエンドをプロビジョニングするストレージクラスの名前です。デフォルトのストレージクラスを使用でき、storageClassName は仕様で省略できます。

  2. 以下のコマンドを実行して、直前の手順で保存されたオブジェクトを作成します。

    $ oc create -f pvc-clone.yaml

    新規の PVC pvc-1-clone が作成されます。

  3. 以下のコマンドを実行して、ボリュームクローンが作成され、準備状態にあることを確認します。

    $ oc get pvc pvc-1-clone

    pvc-1-clone は、これが Bound であることを示します。

    これで、新たにクローン作成された PVC を使用して Pod を設定する準備が整いました。

  4. YAML によって記述される Pod オブジェクトと共にファイルを作成し、保存します。以下に例を示します。

    pod YAML ファイルの例

    kind: Pod
    apiVersion: v1
    metadata:
      name: mypod
    spec:
      containers:
        - name: myfrontend
          image: dockerfile/nginx
          volumeMounts:
          - mountPath: "/var/www/html"
            name: mypd
      volumes:
        - name: mypd
          persistentVolumeClaim:
            claimName: pvc-1-clone

    ここで、spec.volumes.persistentVolumeClaim.claimName は、CSI ボリュームクローン作成操作中に作成されたクローン PVC です。

結果

作成された Pod オブジェクトは、元の dataSource PVC とは別に、クローンされた PVC の使用、クローン、スナップショット、または削除を実行できるようになりました。

6.6. ボリュームポピュレーター

ボリュームポピュレーターを使用すると、空のボリュームをプロビジョニングする代わりに、動的プロビジョニング中にボリュームにデータを自動で事前にロードできます。

6.6.1. ボリュームポピュレーターの概要

ボリュームポピュレーターを使用すると、dataSourceRef フィールドを使用して、永続ボリューム要求 (PVC) とスナップショットだけでなく、カスタムリソース定義 (CRD) からボリュームを事前入力できます。

OpenShift Container Platform バージョン 4.12 から 4.19 では、PVC 仕様の dataSource フィールドでボリュームポピュレーター機能を指定できます。ただし、ボリュームを作成するためのデータソースとして使用できるのは、PVC とスナップショットのみに制限されています。

OpenShift Container Platform バージョン 4.20 以降では、代わりに dataSourceRef フィールドを使用します。dataSourceRef フィールドを使用すると、適切なカスタムリソース (CR) をデータソースとして使用して、新しいボリュームにデータを事前投入できます。

注記

dataSource フィールドを使用したボリュームポピュレーター機能は、今後のバージョンで非推奨化される可能性があります。このフィールドを使用して作成したボリュームポピュレーターがある場合は、今後の問題を回避するために、dataSourceRef フィールドを使用してボリュームポピュレーターを再作成することを検討してください。

ボリュームへのデータの事前投入はデフォルトで有効になっており、OpenShift Container Platform にはインストール済みの volume-data-source-validator コントローラーが含まれています。ただし、OpenShift Container Platform にはボリュームポピュレーターは同梱されていません。

6.6.2. ボリュームポピュレーターの作成

カスタムボリュームの事前入力動作を実装するには、カスタムリソース定義 (CRD) を定義し、それを使用して事前入力ボリュームを作成してボリュームポピュレーターを作成します。

6.6.2.1. ボリュームポピュレーターの CRD の作成

カスタムボリュームの事前入力を有効にするには、ユーザーが永続ボリューム要求 (PVC) を入力するためにインスタンス化できるデータソースを定義するカスタムリソース定義 (CRD) を作成します。

次の手順では、ボリュームポピュレーターの "hello, world" CRD の例を作成する方法について説明します。

その後、ユーザーはこの CRD のインスタンスを作成して PVC を入力できます。

前提条件

  • OpenShift Container Platform Web コンソールにアクセスできる。
  • クラスター管理者権限でクラスターにアクセスできる。

手順

  1. 次のサンプル YAML ファイルを使用して、ポピュレーターおよび関連リソースの論理グループと操作の namespace を作成します。

    namespace YAML ファイルの例

    apiVersion: v1
    kind: Namespace
    metadata:
      name: hello

  2. 次のサンプル YAML ファイルを使用して、データソースの CRD を作成します。

    CRD YAML ファイルの例

    apiVersion: apiextensions.k8s.io/v1
    kind: CustomResourceDefinition
    metadata:
      name: hellos.hello.example.com
    spec:
      group: hello.example.com
      names:
        kind: Hello
        listKind: HelloList
        plural: hellos
        singular: hello
      scope: Namespaced
      versions:
      - name: v1alpha1
        schema:
          openAPIV3Schema:
            description: Hello is a specification for a Hello resource
            properties:
              apiVersion:
                description: 'APIVersion defines the versioned schema of this representation
                  of an object. Servers should convert recognized schemas to the latest
                  internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
                type: string
              kind:
                description: 'Kind is a string value representing the REST resource this
                  object represents. Servers may infer this from the endpoint the client
                  submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
                type: string
              spec:
                description: HelloSpec is the spec for a Hello resource
                properties:
                  fileContents:
                    type: string
                  fileName:
                    type: string
                required:
                - fileContents
                - fileName
                type: object
            required:
            - spec
            type: object
        served: true
        storage: true

  3. ServiceAccount、ClusterRole、ClusterRoleBindering、および Deployment を作成してコントローラーをデプロイし、データの事前投入を実装するロジックを実行します。

    1. 次のサンプル YAML ファイルを使用して、ポピュレーターのサービスアカウントを作成します。

      サービスアカウント YAML ファイルの例

      apiVersion: v1
      kind: ServiceAccount
      metadata:
        name: hello-account
        namespace: hello

      ここで、metadata.namespace は前に作成した namespace を指します。

    2. 次のサンプル YAML ファイルを使用して、ポピュレーターのクラスターロールを作成します。

      クラスターロールの YAML ファイルの例

      kind: ClusterRole
      apiVersion: rbac.authorization.k8s.io/v1
      metadata:
        name: hello-role
      rules:
        - apiGroups: [hello.example.com]
          resources: [hellos]
          verbs: [get, list, watch]

    3. 次のサンプル YAML ファイルを使用して、クラスターロールバインディングを作成します。

      クラスターロールバインディングの YAML ファイルの例

      kind: ClusterRoleBinding
      apiVersion: rbac.authorization.k8s.io/v1
      metadata:
        name: hello-binding
      subjects:
        - kind: ServiceAccount
          name: hello-account
          namespace: hello
      roleRef:
        kind: ClusterRole
        name: hello-role
        apiGroup: rbac.authorization.k8s.io

      • metadata.name: ロールバインディング名を指定します。
      • subjects.name: 先ほど作成したサービスアカウントの名前を参照します。
      • subjects.namespace: 先ほど作成したサービスアカウントの namespace の名前を参照します。
      • roleRef.name: 以前に作成したクラスターロールを参照します。
    4. 次のサンプル YAML ファイルを使用して、ポピュレーターのデプロイメントを作成します。

      デプロイメント YAML ファイルの例

      kind: Deployment
      apiVersion: apps/v1
      metadata:
        name: hello-populator
        namespace: hello
      spec:
        selector:
          matchLabels:
            app: hello
        template:
          metadata:
            labels:
              app: hello
          spec:
            serviceAccount: hello-account
            containers:
              - name: hello
                image: registry.k8s.io/sig-storage/hello-populator:v1.0.1
                imagePullPolicy: IfNotPresent
                args:
                  - --mode=controller
                  - --image-name=registry.k8s.io/sig-storage/hello-populator:v1.0.1
                  - --http-endpoint=:8080
                ports:
                  - containerPort: 8080
                    name: http-endpoint
                    protocol: TCP

      • metadata.namespace: 以前に作成した namespace を参照します。
      • spec.template.spec.serviceAccount: 以前に作成したサービスアカウントを参照します。
  4. 次のサンプル YAML ファイルを使用して、ボリュームポピュレーターを作成し、kind:Hello リソースをボリュームの有効なデータソースとして登録します。

    ボリュームポピュレーターの YAML ファイルの例

    kind: VolumePopulator
    apiVersion: populator.storage.k8s.io/v1beta1
    metadata:
      name: hello-populator
    sourceKind:
      group: hello.example.com
      kind: Hello

    metadata.name フィールドは、ボリュームポピュレーター名を指定します。

    未登録のポピュレーターを使用する PVC は、"The datasource for this PVC does not match any registered VolumePopulator" というイベントを作成します。これは、未知 (未登録) ポピュレーターを使用しているため、PVC がプロビジョニングされない可能性があることを示します。

次のステップ

  • これで、この CRD の CR インスタンスを作成して PVC にデータを事前投入できるようになりました。

    詳細は、「ボリュームポピュレーターを使用した事前入力ボリュームの作成」を参照してください。

6.6.2.2. ボリュームポピュレーターを使用してデータが事前投入されたボリュームを作成する

プロビジョニング時にデータが自動的に入力されるボリュームを作成するには、カスタムリソース定義 (CRD) をデータソースとして定義し、永続ボリューム要求 (PVC) の作成時に参照します。

次の手順では、以前に作成した hellos.hello.example.com CRD の例を使用して、事前入力された PVC を作成する方法を説明します。

この例では、実際のデータソースを使用するのではなく、ボリュームのルートディレクトリーに文字列 "Hello, world!" が含まれる "example.txt" というファイルを作成します。実際の実装では、独自のボリュームポピュレーターを作成する必要があります。

前提条件

  • 実行中の OpenShift Container Platform クラスターにログインしている。
  • ボリュームポピュレーターには既存の CRD があります。
  • OpenShift Container Platform にボリュームポピュレーターは同梱されていません。必ず 独自のボリュームポピュレーターを作成してください。

手順

  1. 次のコマンドを実行して、fileContents パラメーターとして渡された "Hello, World!" というテキストが含まれる Hello CRD のカスタムリソース (CR) インスタンスを作成します。

    $ oc apply -f  - <<EOF
    apiVersion: hello.example.com/v1alpha1
    kind: Hello
    metadata:
      name: example-hello
    spec:
      fileName: example.txt
      fileContents: Hello, world!
    EOF
  2. 次のサンプルファイルのような、Hello CR を参照する PVC を作成します。

    PVC YAML ファイルの例

    apiVersion: v1
    kind: PersistentVolumeClaim
    metadata:
      name: example-pvc
    spec:
      accessModes:
      - ReadWriteOnce
      resources:
        requests:
          storage: 10Mi
      dataSourceRef:
        apiGroup: hello.example.com
        kind: Hello
        name: example-hello
      volumeMode: Filesystem

    • spec.dataSourceRef: PVC のデータソースを指定します。
    • spec.dataSourceRef.name: データソースとして使用する CR の名前を指定します。この例では、'example-hello' です。

検証

  1. 数分経過したら、次のコマンドを実行して、PVC が作成され、ステータスが Bound になっていることを確認します。

    $ oc get pvc example-pvc -n hello

    この例では、PVC の名前は example-pvc です。

    出力例

    NAME          STATUS    VOLUME        CAPACITY   ACCESS MODES   STORAGECLASS   VOLUMEATTRIBUTESCLASS   AGE
    example-pvc   Bound     my-pv         10Mi       ReadWriteOnce  gp3-csi        <unset>                 14s

  2. 次のサンプルファイルを使用して、PVC を読み取ってデータソース情報が適用されたことを検証するジョブを作成します。

    ジョブ YAML ファイルの例

    apiVersion: batch/v1
    kind: Job
    metadata:
      name: example-job
    spec:
      template:
        spec:
          containers:
            - name: example-container
              image: busybox:latest
              command:
                - cat
                - /mnt/example.txt
              volumeMounts:
                - name: vol
                  mountPath: /mnt
          restartPolicy: Never
          volumes:
            - name: vol
              persistentVolumeClaim:
                claimName: example-pvc

    • spec.template.spec.containers.command: "Hello, world!" テキストでファイルの場所と名前を指定します。この例では、場所は "/mnt/example.txt" です。
    • spec.template.spec.volumes.persistentVolumeClaim: ステップ 2 で作成した PVC の名前を指定します。この例では、example-pvc です。
  3. ジョブマニフェストを example-job.yaml というファイルに保存します。
  4. 次のコマンドを実行してジョブを作成します。

    $ oc apply -f example-job.yaml

    出力例

    job.batch/example-job created

  5. 次のコマンドを実行して、ジョブが完了するまで待ちます。

    $ oc wait --for=condition=Complete job/example-job --timeout=120s
  6. 次のコマンドを実行して、ジョブが収集したコンテンツを検証します。

    $ oc logs job/example-job

    予想される出力例

    Hello, world!

6.6.3. ボリュームポピュレーターのアンインストール

カスタムボリューム事前入力機能を削除するには、作成順序を逆にしてすべてのボリュームポピュレーターリソースを削除します。

前提条件

  • OpenShift Container Platform Web コンソールにアクセスできる。
  • クラスター管理者権限でクラスターにアクセスできる。

手順

  • ボリュームポピュレーターをアンインストールするには、以下の手順でインストールしたすべてのオブジェクトを逆の順序で削除します。

    1. "ボリュームポピュレーターを使用してデータが事前投入されたボリュームを作成する"
    2. "ボリュームポピュレーターの CRD の作成"

      必ず VolumePopulator インスタンスを削除してください。

6.7. デフォルトストレージクラスの管理

多くの Container Storage Interface (CSI) オペレーターは、デフォルトのストレージクラスを積極的に管理できるため、手動による介入が不要になり、誤って削除してしまうことを防ぐことができます。適切な管理を行うことで、アプリケーションに適したストレージバックエンドを使用して、永続的なボリューム要求が正しくプロビジョニングされることが保証されます。

6.7.1. 概要

ClusterCSIDriver オブジェクトの spec.storageClassState フィールドを設定することで、デフォルトのストレージクラスを管理し、動的プロビジョニングを制御したり、自動再作成を防止したり、ストレージクラスの名前を変更したりできます。

デフォルトのストレージクラスを管理すると、複数の異なる目的を達成できます。

  • 動的プロビジョニングを無効にして静的プロビジョニングを強制します。
  • 他の優先ストレージクラスがある場合に、storage operator による最初のデフォルトストレージクラスの作成を阻止します。
  • デフォルトのストレージクラスに名前を付け直すか変更します。

これらの目的を達成するには、ClusterCSIDriver オブジェクトの spec.storageClassState フィールドの設定を変更します。このフィールドで可能な設定は以下のとおりです。

  • 管理対象: (デフォルト)Container Storage Interface (CSI) Operator は、デフォルトのストレージクラスを常時管理します。そのため、クラスター管理者がデフォルトのストレージクラスに対して行ったほとんどの手動変更は削除され、デフォルトのストレージクラスを手動で削除しようとすると、継続的に再作成されます。
  • Unmanaged: デフォルトのストレージクラスを変更できます。CSI Operator はストレージクラスをアクティブに管理しないため、自動的に作成するデフォルトのストレージクラスを調整します。
  • Removed: CSI Operator はデフォルトのストレージクラスを削除します。

デフォルトのストレージクラスの管理は、次の Container Storage Interface (CSI) ドライバー Operator によってサポートされています。

  • Amazon Web Services (AWS) Elastic Block Storage (EBS)
  • Azure Disk
  • Azure File
  • Google Cloud Platform (GCP) 永続ディスク (PD)
  • IBM Cloud® VPC Block
  • OpenStack Cinder
  • VMware vSphere

6.7.2. Web コンソールを使用したデフォルトのストレージクラスの管理

ClusterCSIDriver オブジェクトの storageClassState フィールドを設定することで、Web コンソールを使用してストレージクラスの動作を管理できます。デフォルトのストレージクラスの処理方法を決定するために、状態を管理対象に設定してオペレーターによる制御を、管理対象外に設定して手動制御を、削除済みに設定してストレージクラスを削除します。

前提条件

  • OpenShift Container Platform Web コンソールにアクセスできる。
  • クラスター管理者権限でクラスターにアクセスできる。

手順

  1. Web コンソールにログインします。
  2. Administration > CustomResourceDefinitions をクリックします。
  3. CustomResourceDefinitions ページで、clustercsidriver と入力して、ClusterCSIDriver オブジェクトを見つけます。
  4. ClusterCSIDriver をクリックし、Instances タブをクリックします。
  5. 目的のインスタンスの名前をクリックし、YAML タブをクリックします。
  6. spec.storageClassState フィールドを追加し、値を Managed、Unmanaged、または Removed に設定します。

    例

    ...
    spec:
      driverConfig:
        driverType: ''
      logLevel: Normal
      managementState: Managed
      observedConfig: null
      operatorLogLevel: Normal
      storageClassState: Unmanaged
    ...

    この例では、spec.storageClassState フィールドは Unmanaged に設定されています。

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

6.7.3. CLI を使用したデフォルトのストレージクラスの管理

CLI を使用してストレージクラスの動作を管理するには、ClusterCSIDriver オブジェクトの storageClassState フィールドを設定します。デフォルトのストレージクラスの処理方法を決定するために、状態を管理対象に設定してオペレーターによる制御を、管理対象外に設定して手動制御を、削除済みに設定してストレージクラスを削除します。

前提条件

  • クラスター管理者権限でクラスターにアクセスできる。

手順

  • CLI を使用してストレージクラスを管理するには、次のコマンドを実行します。

    $ oc patch clustercsidriver $DRIVERNAME --type=merge -p "{\"spec\":{\"storageClassState\":\"${STATE}\"}}"
    • ここで、${STATE} は "削除"、"管理"、または "非管理" です。
    • $DRIVERNAME はプロビジョナー名です。コマンド oc get sc を実行すると、プロビジョナー名を見つけることができます。

デフォルトのストレージクラスが存在しない場合、または複数存在する場合、永続的なボリューム要求の問題が発生します。デフォルトストレージクラスが複数存在すると、予測不能な選択やアラートが発生する可能性があり、デフォルトストレージクラスが存在しない場合は、クレームが保留状態になります。ストレージクラスを 1 つだけデフォルトとして指定することで問題を解決します。

6.7.4.1. 複数のデフォルトのストレージクラス

デフォルト以外のストレージクラスをデフォルトとしてマークし、既存のデフォルトストレージクラスの設定を解除しない場合、またはデフォルトのストレージクラスがすでに存在するときにデフォルトのストレージクラスを作成した場合は、複数のデフォルトストレージクラスが発生する可能性があります。複数のデフォルトストレージクラスが存在する場合、デフォルトストレージクラス (pvc.spec.storageClassName =nil) を要求するすべての永続ボリューム要求 (PVC) は、そのストレージクラスのデフォルトステータスと管理者に関係なく、最後に作成されたデフォルトストレージクラスを取得します。アラートダッシュボードで、複数のデフォルトストレージクラス MultipleDefaultStorageClasses があるというアラートを受け取ります。

6.7.4.2. デフォルトのストレージクラスなし

PVC が存在しないデフォルトのストレージクラスの使用を試みる可能性があるシナリオは 2 つあります。

  • 管理者がデフォルトのストレージクラスを削除するか、デフォルト以外としてマークした後、ユーザーがデフォルトのストレージクラスを要求する PVC を作成します。
  • インストール時に、インストーラーは、まだ作成されていないデフォルトのストレージクラスを要求する PVC を作成します。

前述のシナリオでは、PVC は無期限に保留状態のままになります。この状況を解決するには、デフォルトのストレージクラスを作成するか、既存のストレージクラスの 1 つをデフォルトとして宣言します。デフォルトのストレージクラスが作成または宣言されるとすぐに、PVC は新しいデフォルトのストレージクラスを取得します。可能であれば、最終的に PVC は通常どおり静的または動的にプロビジョニングされた PV にバインドされ、保留状態から抜け出します。

6.7.5. デフォルトストレージクラスの変更

デフォルトのストレージクラスを変更して、新しい永続ボリューム要求 (PVC) が、指定したストレージバックエンドを自動的に使用するようにします。

これにより、ユーザーが各クレームに対してストレージクラスを指定する必要なく、コストの最適化、インフラストラクチャーの変更への対応、または新規デプロイメント全体で一貫したストレージタイプの確保が可能になります。

この例では、gp3 と standard という 2 つのストレージクラスが定義されており、デフォルトのストレージクラスを gp3 から standard に変更すると考えています。

前提条件

  • クラスター管理者権限でクラスターにアクセスできる。

手順

  1. 以下のコマンドを実行して、ストレージクラスをリスト表示します。

    $ oc get storageclass

    出力例

    NAME                 TYPE
    gp3 (default)        ebs.csi.aws.com 
    1
    
    standard             ebs.csi.aws.com

    テキスト (default) は、デフォルトのストレージクラスを示します。この例では、gp3 が現在のデフォルトのストレージクラスです。

  2. 目的のストレージクラスをデフォルトにします。

    目的のストレージクラスに、次のコマンドを実行して storageclass.kubernetes.io/is-default-class アノテーションを true に設定します。

    $ oc patch storageclass standard -p '{"metadata": {"annotations": {"storageclass.kubernetes.io/is-default-class": "true"}}}'
    注記

    短期間であれば、複数のデフォルトのストレージクラスを使用できます。ただし、最終的には 1 つのデフォルトのストレージクラスのみが存在することを確認する必要があります。

    複数のデフォルトストレージクラスが存在する場合、デフォルトストレージクラス (pvc.spec.storageClassName =nil) を要求するすべての永続ボリューム要求 (PVC) は、そのストレージクラスのデフォルトステータスと管理者に関係なく、最後に作成されたデフォルトストレージクラスを取得します。アラートダッシュボードで、複数のデフォルトストレージクラス MultipleDefaultStorageClasses があるというアラートを受け取ります。

  3. 古いデフォルトストレージクラスからデフォルトのストレージクラス設定を削除します。

    古いデフォルトのストレージクラスの場合は、次のコマンドを実行して storageclass.kubernetes.io/is-default-class アノテーションの値を false に変更します。

    $ oc patch storageclass gp3 -p '{"metadata": {"annotations": {"storageclass.kubernetes.io/is-default-class": "false"}}}'
  4. 以下のコマンドを実行して変更内容を確認してください。

    $ oc get storageclass

    出力例

    NAME                 TYPE
    gp3                  ebs.csi.aws.com
    standard (default)   ebs.csi.aws.com

    標準 ストレージクラスがデフォルトになりました。

6.8. CSI の自動移行

従来 OpenShift Container Platform に同梱されていた in-tree のストレージドライバーは非推奨となり、同等の Container Storage Interface (CSI) ドライバーに置き換えられます。OpenShift Container Platform は、ツリー内ボリュームプラグインの同等の CSI ドライバーへの自動移行を提供します。

6.8.1. 概要

Container Storage Interface (CSI) 移行は、データ移行や API の変更なしに、ツリー内のストレージボリュームをメモリー内の CSI 相当物に透過的に変換します。

このプロセスはデータ移行を実行しません。OpenShift Container Platform は、メモリー内の永続ボリュームオブジェクトしか変換しません。その結果、変換された永続ボリュームオブジェクトはディスクに保存されず、その内容も変更されません。CSI 自動移行はシームレスに行ってください。この機能により、既存のすべての API オブジェクト (PersistentVolumes、PersistentVolumeClaims、StorageClasses など) を使用する方法が変更されることはありません。

次のツリー内ドライバーから CSI ドライバーが自動的に移行されます。

  • Azure Disk
  • OpenStack Cinder
  • Amazon Web Services (AWS) Elastic Block Storage (EBS)
  • Google Compute Engine Persistent Disk (GCP PD)
  • Azure File
  • VMware vSphere

これらのボリュームタイプの CSI 移行は一般提供 (GA) であるとみなされ、手動の介入は必要ありません。

元のツリー内ストレージプラグインがサポートしていない場合、ツリー内永続ボリューム (PV) または永続ボリュームクレーム (PVC) の CSI 自動移行では、スナップショットや拡張などの新しい CSI ドライバー機能は有効になりません。

6.8.2. ストレージクラスへの影響

OpenShift Container Platform 4.13 以降では、新規インストール時に Container Storage Interface (CSI) ストレージクラスが使用されます。アップグレードされたクラスターには、CSI ストレージクラスが存在しない場合、デフォルトで CSI ストレージクラスが割り当てられます。既存のツリー内クラスは、後方互換性のために残されています。CSI ストレージクラスへの切り替えを推奨します。

新規の OpenShift Container Platform 4.13 以降のインストールでは、デフォルトのストレージクラスは CSI ストレージクラスになります。このストレージクラスを使用してプロビジョニングされるすべてのボリュームは CSI 永続ボリューム (PV) です。

4.12 以前のバージョンから 4.13 以降のバージョンにアップグレードされたクラスターの場合、CSI ストレージクラスが作成され、アップグレード前にデフォルトのストレージクラスが設定されていなかった場合は、それがデフォルトとして設定されます。ごく稀なケースとして、同じ名前のストレージクラスがある場合、既存のストレージクラスは変更されません。既存のインツリーストレージクラスはそのまま残り、既存の in-tree PV で機能するボリューム拡張などの特定の機能で必要になる場合があります。インツリーストレージプラグインを参照するストレージクラスは機能し続けますが、デフォルトのストレージクラスを CSI ストレージクラスに切り替えることが推奨されます。

デフォルトのストレージクラスの変更方法については、関連情報 の デフォルトのストレージクラスの変更を 参照してください。

6.9. AWS Elastic Block Store CSI Driver Operator

AWS EBS Container Storage Interface (CSI) Driver Operator とドライバーを使用すると、OpenShift Container Platform で AWS Elastic Block Storage (EBS) をプロビジョニングおよび管理できます。これにより、動的なボリュームプロビジョニングが可能になり、ストレージの事前プロビジョニングが不要になります。

6.9.1. AWS EBS CSI Driver Operator の概要

OpenShift Container Platform は、AWS Elastic Block Storage (EBS) Container Storage Interface (CSI) ドライバーを使用して永続ボリューム (PV) をプロビジョニングできます。

CSI Operator およびドライバーを使用する場合は、永続ストレージ および CSI ボリュームの設定 を理解しておくことが推奨されます。詳細は、「永続ストレージについて」および「CSI ボリュームの設定」を参照してください。

AWS EBS ストレージアセットにマウントする CSI プロビジョニングされた PV を作成するために、OpenShift Container Platform は、デフォルトで AWS EBS CSI Driver Operator (Red Hat Operator) と AWS EBS CSI ドライバーを openshift-cluster-csi-drivers namespace にインストールします。

AWS EBS CSI Driver Operator
AWS EBS CSI Driver Operator は、永続ボリューム要求 (PVC) の作成に使用できるデフォルトのストレージクラスを提供します。必要に応じて、このデフォルトのストレージクラスを無効にできます (「デフォルトストレージクラスの管理」を参照)。「EBS ストレージクラスの作成」の説明に従って、AWS EBS StorageClass を作成することもできます。
AWS EBS CSI ドライバー
AWS EBS CSI ドライバーを使用すると、AWS EBS PV を作成し、マウントできます。
注記

AWS EBS CSI Operator およびドライバーを OpenShift Container Platform 4.5 クラスターにインストールしている場合、OpenShift Container Platform 4.21 に更新する前に、4.5 Operator およびドライバーをアンインストールする必要があります。

重要

OpenShift Container Platform は、デフォルトで CSI プラグインを使用して Amazon Elastic Block Store (Amazon EBS) ストレージをプロビジョニングします。

OpenShift Container Platform で AWS EBS 永続ボリュームを動的にプロビジョニングする方法については、「動的プロビジョニング」を参照してください。

6.9.2. CSI について

Container Storage Interface (CSI) を使用すると、ストレージベンダーは Kubernetes コアコードを変更することなく、従来の組み込みストレージドライバーの代わりに、標準インターフェイスを介してプラグインを提供できます。

CSI Operator は、インツリーボリュームプラグインでは不可能なボリュームスナップショットなどのストレージオプションを OpenShift Container Platform ユーザーに付与します。

6.9.3. ユーザー管理型の暗号化

ユーザー管理型の暗号化機能を使用すると、インストール時に OpenShift Container Platform ノードのルートボリュームを暗号化するキーを指定でき、すべてのマネージドストレージクラスはこれらのキーを使用してプロビジョニングされたストレージボリュームを暗号化できます。

install-config YAML ファイルの platform.<cloud_type>.defaultMachinePlatform フィールドにカスタムキーを指定する必要があります。

この機能は、次のストレージタイプをサポートします。

  • Amazon Web Services (AWS) Elastic Block storage (EBS)

    注記

    ストレージクラスに暗号化キーが定義されていない場合は、ストレージクラスに encrypted: "true" のみを設定します。AWS EBS CSI ドライバーは、AWS 管理の alias/aws/ebs を使用します。これは、プロビジョニングされたストレージボリュームを暗号化するために、デフォルトで各リージョンで Amazon EBS によって自動的に作成されます。さらに、マネージドストレージクラスはすべて encrypted: "true" 設定になっています。

    AWS EBS のユーザー管理の暗号化を使用したインストールの詳細は、オプションの AWS 設定パラメーター を参照してください。

  • Microsoft Azure Disk ストレージ

    注記

    OS (ルート) ディスクが暗号化されており、ストレージクラスに暗号化キーが定義されていない場合、Azure Disk CSI ドライバーは、デフォルトで OS ディスク暗号化キーを使用して、プロビジョニングされたストレージボリュームを暗号化します。

    ユーザー管理暗号化を使用した Azure Disk のインストールの詳細は、「Azure Disk 暗号化セットの準備」を参照してください。

  • Google Cloud Platform (GCP) 永続ディスク (PD) ストレージ

    ユーザー管理暗号化を使用した GCP PD のインストールの詳細は、「その他の Google Cloud 設定パラメーター」を参照してください。

  • IBM Cloud® Virtual Private Cloud (VPC) Block ストレージ

    IBM Cloud のユーザー管理型の暗号化を使用したインストールの詳細は、IBM Cloud のユーザー管理型の暗号化 および IBM Cloud へのインストール を参照してください。

6.10. AWS Elastic File Service CSI Driver Operator

AWS Elastic File System (EFS) ストレージを OpenShift Container Platform でプロビジョニングおよび管理するには、AWS EFS Container Storage Interface (CSI) Driver Operator と Driver を使用します。これにより、動的なボリュームプロビジョニングが可能になり、ストレージの事前プロビジョニングが不要になります。

6.10.1. 概要

OpenShift Container Platform は、AWS Elastic File Service (EFS) の Container Storage Interface (CSI) ドライバーを使用して永続ボリューム (PV) をプロビジョニングできます。

CSI Operator およびドライバーを使用する場合は、永続ストレージ および CSI ボリュームの設定 を理解しておくことが推奨されます。詳細は、「永続ストレージについて」および「CSI ボリュームの設定」を参照してください。

AWS EFS CSI Driver Operator をインストールすると、OpenShift Container Platform はデフォルトで AWS EFS CSI Operator と AWS EFS CSI ドライバーを openshift-cluster-csi-drivers namespace にインストールします。これにより、AWS EFS CSI Driver Operator は、AWS EFS アセットにマウントする CSI がプロビジョニングする PV を作成することができます。

  • AWS EFS CSI Driver Operator をインストールしても、デフォルトでは、永続ボリューム要求 (PVC) の作成に使用されるストレージクラスは作成されません。ただし、AWS EFS StorageClass を手動で作成することは可能です。AWS EFS CSI Driver Operator は、ストレージボリュームをオンデマンドで作成できるようにし、クラスター管理者がストレージを事前にプロビジョニングする必要がなくすことで、動的ボリュームのプロビジョニングをサポートします。
  • AWS EFS CSI ドライバー を使用すると、AWS EFS PV を作成し、マウントできます。

6.10.2. CSI について

Container Storage Interface (CSI) を使用すると、ストレージベンダーは Kubernetes コアコードを変更することなく、従来の組み込みストレージドライバーの代わりに、標準インターフェイスを介してプラグインを提供できます。

CSI Operator は、インツリーボリュームプラグインでは不可能なボリュームスナップショットなどのストレージオプションを OpenShift Container Platform ユーザーに付与します。

6.10.3. AWS EFS CSI Driver Operator の設定

クラスター内で AWS Elastic File System (EFS) ストレージを有効にするには、必要な認証情報を取得し、Operator をインストールして、ドライバーをインストールしてセットアッププロセスを完了します。

手順

  1. AWS EFS と AWS Secure Token Service (STS) を使用している場合は、STS のロール Amazon Resource Name (ARN) を取得します。これは、AWS EFS CSI Driver Operator をインストールするために必要です。
  2. AWS EFS CSI Driver Operator をインストールします。
  3. AWS EFS CSI ドライバーをインストールします。

6.10.3.1. Security Token Service の Amazon リソース名ロールの取得

Security Token Service (STS) を使用してクラスター上の AWS Elastic File System (EFS) Container Storage Interface (CSI) Driver Operator を設定するには、インストール前に Cloud Credential Operator ユーティリティーを使用して Amazon Resource Name (ARN) ロールを取得します。

重要

AWS EFS CSI Driver Operator をインストールする前に、この手順を実行してください (AWS EFS CSI Driver Operator のインストール に記載された手順を参照)。

ARN ロールは複数の方法で取得できます。次の手順は、クラスターのインストールと同じ概念と CCO ユーティリティー (ccoctl) バイナリーツールを使用する 1 つの方法を示しています。

注記

One Zone ファイルシステムを使用している場合は、コントローラー用とドライバーノード用に 1 つずつ、合計 2 つの CredentialRequests を作成する必要があります。詳細は、STS を使用した One Zone ファイルシステムのセットアップ セクションを参照してください。

前提条件

  • cluster-admin ロールを持つユーザーとしてクラスターにアクセスできる。
  • AWS アカウントの認証情報。

手順

  1. STS でクラスターをインストールするために使用した OpenShift Container Platform リリースイメージから ccoctl を展開します。詳細は、「Cloud Credential Operator ユーティリティーの設定」を参照してください。
  2. 以下の例に示されているように EFS CredentialsRequest YAML ファイルを作成および保存してから、それを credrequests ディレクトリーに配置します。

    例

    apiVersion: cloudcredential.openshift.io/v1
    kind: CredentialsRequest
    metadata:
      name: openshift-aws-efs-csi-driver
      namespace: openshift-cloud-credential-operator
    spec:
      providerSpec:
        apiVersion: cloudcredential.openshift.io/v1
        kind: AWSProviderSpec
        statementEntries:
        - action:
          - elasticfilesystem:*
          effect: Allow
          resource: '*'
      secretRef:
        name: aws-efs-cloud-credentials
        namespace: openshift-cluster-csi-drivers
      serviceAccountNames:
      - aws-efs-csi-driver-operator
      - aws-efs-csi-driver-controller-sa

  3. ccoctl ツールを実行して AWS に新規の IAM ロールを生成し、その YAML ファイルをローカルファイルシステムに作成します (<path_to_ccoctl_output_dir>/manifests/openshift-cluster-csi-drivers-aws-efs-cloud-credentials-credentials.yaml)。

    $ ccoctl aws create-iam-roles --name=<name> --region=<aws_region> --credentials-requests-dir=<path_to_directory_with_list_of_credentials_requests>/credrequests --identity-provider-arn=arn:aws:iam::<aws_account_id>:oidc-provider/<name>-oidc.s3.<aws_region>.amazonaws.com
    • name=<name> は、追跡用に作成されたクラウドリソースにタグを付けるために使用される名前です。
    • region=<aws_region> は、クラウドリソースが作成される AWS リージョンです。
    • dir=<path_to_directory_with_list_of_credentials_requests>/credrequests は、前のステップの EFS CredentialsRequest ファイルが含まれるディレクトリーです。
    • <aws_account_id> は AWS アカウント ID です。

      例

      $ ccoctl aws create-iam-roles --name my-aws-efs --credentials-requests-dir credrequests --identity-provider-arn arn:aws:iam::123456789012:oidc-provider/my-aws-efs-oidc.s3.us-east-2.amazonaws.com

      出力例

      2022/03/21 06:24:44 Role arn:aws:iam::123456789012:role/my-aws-efs -openshift-cluster-csi-drivers-aws-efs-cloud- created
      2022/03/21 06:24:44 Saved credentials configuration to: /manifests/openshift-cluster-csi-drivers-aws-efs-cloud-credentials-credentials.yaml
      2022/03/21 06:24:45 Updated Role policy for Role my-aws-efs-openshift-cluster-csi-drivers-aws-efs-cloud-

  4. 前の手順の 出力例 の最初の行から、ARN ロールをコピーします。ARN ロールは、"Role" と "created" の間にあります。この例では、ARN ロールは "arn:aws:iam::123456789012:role/my-aws-efs -openshift-cluster-csi-drivers-aws-efs-cloud" です。

    AWS EFS CSI Driver Operator をインストールするときに、ARN ロールが必要になります。

次のステップ

AWS EFS CSI Driver Operator をインストールします。詳細は、「AWS EFS CSI Driver Operator のインストール」を参照してください。

6.10.3.2. AWS EFS CSI Driver Operator のインストール

AWS EFS Container Storage Interface (CSI) Driver Operator をインストールして設定し、クラスター内で AWS EFS ストレージを有効にします。この Red Hat Operator はデフォルトではインストールされておらず、手動でインストールする必要があります。

前提条件

  • OpenShift Container Platform Web コンソールにアクセスできる。

手順

  1. Web コンソールにログインします。
  2. AWS EFS CSI Operator をインストールします。

    1. Ecosystem Software Catalog をクリックします。
    2. フィルターボックスに AWS EFS CSI と入力して、AWS EFS CSI Operator を探します。
    3. AWS EFS CSI Driver Operator ボタンをクリックします。
    重要

    AWS EFS Operator ではなく AWS EFS CSI Driver Operator を必ず選択してください。AWS EFS Operator はコミュニティー Operator であり、Red Hat ではサポートしていません。

    1. AWS EFS CSI Driver Operator ページで Install をクリックします。
    2. Install Operator のページで、以下のことを確認してください。

      • AWS EFS と AWS Secure Token Service (STS) を使用している場合は、role ARN フィールドに、Security Token Service のロール Amazon Resource Name の取得 の手順の最後のステップでコピーした ARN ロールを入力します。
      • All namespaces on the cluster (default) が選択されている。
      • Installed Namespace が openshift-cluster-csi-drivers に設定されている。
    3. Install をクリックします。

      インストールが終了すると、AWS EFS CSI Operator が Web コンソールの Installed Operators に表示されます。

次のステップ

AWS EFS CSI ドライバーをインストールします。

6.10.3.3. AWS EFS CSI ドライバーのインストール

Container Storage Interface (CSI) Driver Operator (Red Hat Operator) をインストールした後、AWS EFS CSI ドライバーをインストールする必要があります。

前提条件

  • OpenShift Container Platform Web コンソールにアクセスできる。

手順

  1. Administration CustomResourceDefinitions ClusterCSIDriver をクリックします。
  2. Instances タブで Create ClusterCSIDriver をクリックします。
  3. 以下の YAML ファイルを使用します。

    apiVersion: operator.openshift.io/v1
    kind: ClusterCSIDriver
    metadata:
        name: efs.csi.aws.com
    spec:
      managementState: Managed

    ここで、metadata.name はストレージプロビジョニング担当者名です。

  4. Create をクリックします。
  5. 以下の条件が "True" に変わるのを待ちます。

    • AWSEFSDriverNodeServiceControllerAvailable
    • AWSEFSDriverControllerServiceControllerAvailable

6.10.4. AWS EFS ストレージクラスについて

永続ボリュームの動的プロビジョニングを有効にするには、ストレージ特性を定義し、ユーザーがボリュームをオンデマンドで自動的にプロビジョニングできるようにするストレージクラスを作成します。

AWS Elastic File System (EFS) Container Storage Interface (CSI) Driver Operator (Red Hat Operator) は、インストール後、デフォルトではストレージクラスを作成しません。ただし、AWS EFS ストレージクラスを手動で作成することは可能です。

6.10.4.1. コンソールを使用した AWS EFS ストレージクラスの作成

コンソールを使用して AWS Elastic File System (EFS) ボリュームの動的プロビジョニングを有効にするには、ファイルシステムパラメーター、権限、およびアクセスポイント設定を定義する StorageClass オブジェクトを作成します。

手順

  1. OpenShift Container Platform Web コンソールで、Storage StorageClasses をクリックします。
  2. StorageClasses ページで、Create StorageClass をクリックします。
  3. StorageClass ページで、次の手順を実行します。

    1. ストレージクラスを参照するための名前を入力します。
    2. オプション: 説明を入力します。
    3. 回収ポリシーを選択します。
    4. Provisioner ドロップダウンリストから efs.csi.aws.com を選択します。
    5. オプション: 選択したプロビジョナーの設定パラメーターを設定します。
  4. Create をクリックします。

6.10.4.2. CLI を使用した AWS EFS ストレージクラスの作成

コマンドラインを使用して AWS Elastic File System (EFS) ボリュームの動的プロビジョニングを有効にするには、ファイルシステムのパラメーター、権限、アクセスポイント設定を定義する StorageClass オブジェクトを作成します。

手順

  • 次のサンプル YAML ファイルを使用して StorageClass オブジェクトを作成します。

    kind: StorageClass
    apiVersion: storage.k8s.io/v1
    metadata:
      name: efs-sc
    provisioner: efs.csi.aws.com
    parameters:
      provisioningMode: efs-ap
      fileSystemId: fs-a5324911
      directoryPerms: "700"
      gidRangeStart: "1000"
      gidRangeEnd: "2000"
      basePath: "/dynamic_provisioning"
  • parameters.provisioningMode: 動的プロビジョニングを有効にするには、efs-ap を設定する必要があります。
  • parameters.fileSystemId: 手動で作成した EFS ボリュームの ID にする必要があります。
  • parameters.directoryPerms: ボリュームのルートディレクトリーのデフォルトパーミッションです。この場合、ボリュームには所有者のみがアクセスできます。
  • parameters.gidRangeStart と parameters.gidRangeEnd: AWS アクセスポイントの GID を設定する際に使用する POSIX グループ ID (GID) の範囲を設定します。指定しないと、デフォルトの範囲は 50000 - 7000000 になります。プロビジョニングされた各ボリューム、つまり AWS のアクセスポイントには、この範囲からの固有 GID が割り当てられます。
  • parameters.basePath: 動的にプロビジョニングされたボリュームを作成する際に使用される EFS ボリューム上のディレクトリーです。この場合は、EFS ボリューム上に “/dynamic_provisioning/<random uuid>” として PV がプロビジョニングされます。PV を使用する Pod には、そのサブディレクトリーのみがマウントされます。

    注記

    クラスター管理者は、それぞれが異なる EFS ボリュームを使用する複数の StorageClass オブジェクトを作成することができます。

6.10.5. AWS EFS CSI クロスアカウントのサポート

AWS アカウント間で AWS Elastic File System (EFS) ボリュームをマウントするには、あるアカウントの OpenShift Container Platform クラスターが別のアカウントのファイルシステムにアクセスできるように、クロスアカウントサポートを設定します。

前提条件

  • 管理者権限を持つ OpenShift Container Platform クラスターへのアクセス
  • 2 つの有効な AWS アカウントがある。
  • EFS CSI Operator がインストールされている。EFS CSI Operator のインストール方法は、AWS EFS CSI Driver Operator のインストール セクションを参照してください。
  • OpenShift Container Platform クラスターと EFS ファイルシステムの両方が同じ AWS リージョンに配置されている。
  • 次の手順で使用する 2 つの仮想プライベートクラウド (VPC) が異なるネットワーク Classless Inter-Domain Routing (CIDR) 範囲を使用していることを確認する。
  • OpenShift Container Platform CLI (oc) へのアクセス。
  • AWS CLI へアクセスできる。
  • jq コマンドライン JSON プロセッサーへアクセスできる。

次の手順では、以下のアカウントを設定する方法を説明します。

  • OpenShift Container Platform AWS アカウント A: VPC 内にデプロイされた Red Hat OpenShift Container Platform クラスター (v4.16 以降) が含まれている。
  • AWS アカウント B: VPC (サブネット、ルートテーブル、ネットワーク接続を含む) が含まれている。この VPC に EFS ファイルシステムを作成します。

手順

  1. 環境をセットアップします。

    1. 次のコマンドを実行して環境変数を設定します。

      export CLUSTER_NAME="<CLUSTER_NAME>"
      export AWS_REGION="<AWS_REGION>"
      export AWS_ACCOUNT_A_ID="<ACCOUNT_A_ID>"
      export AWS_ACCOUNT_B_ID="<ACCOUNT_B_ID>"
      export AWS_ACCOUNT_A_VPC_CIDR="<VPC_A_CIDR>"
      export AWS_ACCOUNT_B_VPC_CIDR="<VPC_B_CIDR>"
      export AWS_ACCOUNT_A_VPC_ID="<VPC_A_ID>"
      export AWS_ACCOUNT_B_VPC_ID="<VPC_B_ID>"
      export SCRATCH_DIR="<WORKING_DIRECTORY>"
      export CSI_DRIVER_NAMESPACE="openshift-cluster-csi-drivers"
      export AWS_PAGER=""
      • <CLUSTER_NAME>: 選択したクラスター名。
      • <AWS_リージョン>: 選択した AWS リージョン。
      • <ACCOUNT_A_ID>: AWS アカウント A ID。
      • <ACCOUNT_B_ID>: AWS アカウント B ID。
      • <VPC_A_CIDR>: アカウント A の VPC の CIDR 範囲。
      • <VPC_B_CIDR>: アカウント B の VPC の CIDR 範囲。
      • <VPC_A_ID>: アカウント A (クラスター) の VPC ID
      • <VPC_B_ID>: アカウント B の VPC ID (EFS クロスアカウント)
      • <WORKING_DIRECTORY>: 一時ファイルを保存するために使用する任意の書き込み可能なディレクトリー。
      • CSI_DRIVER_NAMESPACE: ドライバーがデフォルト以外の namespace にインストールされている場合は、この値を変更します。
      • AWS_PAGER: AWS CLI のすべての出力を stdout に直接出力させます。
    2. 次のコマンドを実行して作業ディレクトリーを作成します。

      mkdir -p $SCRATCH_DIR
    3. OpenShift Container Platform CLI で次のコマンドを実行して、クラスターの接続を確認します。

      $ oc whoami
    4. OpenShift Container Platform クラスターのタイプを決定し、ノードセレクターを設定します。

      EFS クロスアカウント機能を使用するには、EFS CSI コントローラー Pod が稼働しているノードに AWS IAM ポリシーを割り当てる必要があります。ただし、割り当て方法は OpenShift Container Platform タイプによって異なります。

      • クラスターが Hosted Control Plane (HyperShift) としてデプロイされている場合は、次のコマンドを実行して、ワーカーノードのラベルを格納するように NODE_SELECTOR 環境変数を設定します。

        export NODE_SELECTOR=node-role.kubernetes.io/worker
      • それ以外の OpenShift Container Platform タイプの場合は、次のコマンドを実行して、マスターノードのラベルを格納するように NODE_SELECTOR 環境変数を設定します。

        export NODE_SELECTOR=node-role.kubernetes.io/master
    5. 次のコマンドを実行して、アカウント切り替え用の環境変数として AWS CLI プロファイルを設定します。

      export AWS_ACCOUNT_A="<ACCOUNT_A_NAME>"
      export AWS_ACCOUNT_B="<ACCOUNT_B_NAME>"
    6. 次のコマンドを実行して、両方のアカウントで AWS CLI のデフォルト出力形式が JSON に設定されていることを確認します。

      export AWS_DEFAULT_PROFILE=${AWS_ACCOUNT_A}
      aws configure get output
      export AWS_DEFAULT_PROFILE=${AWS_ACCOUNT_B}
      aws configure get output

      上記のコマンドが次の結果を返す場合:

      • 値なし: デフォルト出力形式がすでに JSON に設定されており、変更は必要ありません。
      • 何らかの値: JSON 形式を使用するように AWS CLI を再設定します。出力形式の変更方法は、AWS ドキュメントの Setting the output format in the AWS CLI を参照してください。
    7. 次のコマンドを実行して、AWS_DEFAULT_PROFILE との競合を防ぐために、シェルで AWS_PROFILE を設定解除します。

      unset AWS_PROFILE
  2. AWS アカウント B の IAM ロールとポリシーを設定します。

    1. 次のコマンドを実行して、アカウント B のプロファイルに切り替えます。

      export AWS_DEFAULT_PROFILE=${AWS_ACCOUNT_B}
    2. 次のコマンドを実行して、EFS CSI Driver Operator の IAM ロール名を定義します。

      export ACCOUNT_B_ROLE_NAME=${CLUSTER_NAME}-cross-account-aws-efs-csi-operator
    3. 次のコマンドを実行して、IAM 信頼ポリシーファイルを作成します。

      cat <<EOF > $SCRATCH_DIR/AssumeRolePolicyInAccountB.json
      {
          "Version": "2012-10-17",
          "Statement": [
              {
                  "Effect": "Allow",
                  "Principal": {
                      "AWS": "arn:aws:iam::${AWS_ACCOUNT_A_ID}:root"
                  },
                  "Action": "sts:AssumeRole",
                  "Condition": {}
              }
          ]
      }
      EOF
    4. 次のコマンドを実行して、EFS CSI Driver Operator の IAM ロールを作成します。

      ACCOUNT_B_ROLE_ARN=$(aws iam create-role \
        --role-name "${ACCOUNT_B_ROLE_NAME}" \
        --assume-role-policy-document file://$SCRATCH_DIR/AssumeRolePolicyInAccountB.json \
        --query "Role.Arn" --output text) \
      && echo $ACCOUNT_B_ROLE_ARN
    5. 次のコマンドを実行して、IAM ポリシーファイルを作成します。

      cat << EOF > $SCRATCH_DIR/EfsPolicyInAccountB.json
      {
          "Version": "2012-10-17",
          "Statement": [
              {
                  "Sid": "VisualEditor0",
                  "Effect": "Allow",
                  "Action": [
                      "ec2:DescribeNetworkInterfaces",
                      "ec2:DescribeSubnets"
                  ],
                  "Resource": "*"
              },
              {
                  "Sid": "VisualEditor1",
                  "Effect": "Allow",
                  "Action": [
                      "elasticfilesystem:DescribeMountTargets",
                      "elasticfilesystem:DeleteAccessPoint",
                      "elasticfilesystem:ClientMount",
                      "elasticfilesystem:DescribeAccessPoints",
                      "elasticfilesystem:ClientWrite",
                      "elasticfilesystem:ClientRootAccess",
                      "elasticfilesystem:DescribeFileSystems",
                      "elasticfilesystem:CreateAccessPoint",
                      "elasticfilesystem:TagResource"
                  ],
                  "Resource": "*"
              }
          ]
      }
      EOF
    6. 次のコマンドを実行して、IAM ポリシーを作成します。

      ACCOUNT_B_POLICY_ARN=$(aws iam create-policy --policy-name "${CLUSTER_NAME}-efs-csi-policy" \
         --policy-document file://$SCRATCH_DIR/EfsPolicyInAccountB.json \
         --query 'Policy.Arn' --output text) \
      && echo ${ACCOUNT_B_POLICY_ARN}
    7. 次のコマンドを実行して、ポリシーをロールにアタッチします。

      aws iam attach-role-policy \
         --role-name "${ACCOUNT_B_ROLE_NAME}" \
         --policy-arn "${ACCOUNT_B_POLICY_ARN}"
  3. AWS アカウント A の IAM ロールとポリシーを設定します。

    1. 次のコマンドを実行して、アカウント A のプロファイルに切り替えます。

      export AWS_DEFAULT_PROFILE=${AWS_ACCOUNT_A}
    2. 次のコマンドを実行して、IAM ポリシードキュメントを作成します。

      cat << EOF > $SCRATCH_DIR/AssumeRoleInlinePolicyPolicyInAccountA.json
      {
        "Version": "2012-10-17",
        "Statement": [
          {
            "Effect": "Allow",
            "Action": "sts:AssumeRole",
            "Resource": "${ACCOUNT_B_ROLE_ARN}"
          }
        ]
      }
      EOF
    3. AWS アカウント A で、次のコマンドを実行して、AWS 管理ポリシー "AmazonElasticFileSystemClientFullAccess" を OpenShift Container Platform クラスターのマスターロールにアタッチします。

      EFS_CLIENT_FULL_ACCESS_BUILTIN_POLICY_ARN=arn:aws:iam::aws:policy/AmazonElasticFileSystemClientFullAccess
      declare -A ROLE_SEEN
      for NODE in $(oc get nodes --selector="${NODE_SELECTOR}" -o jsonpath='{.items[*].metadata.name}'); do
          INSTANCE_PROFILE=$(aws ec2 describe-instances \
              --filters "Name=private-dns-name,Values=${NODE}" \
              --query 'Reservations[].Instances[].IamInstanceProfile.Arn' \
              --output text | awk -F'/' '{print $NF}' | xargs)
          MASTER_ROLE_ARN=$(aws iam get-instance-profile \
              --instance-profile-name "${INSTANCE_PROFILE}" \
              --query 'InstanceProfile.Roles[0].Arn' \
              --output text | xargs)
          MASTER_ROLE_NAME=$(echo "${MASTER_ROLE_ARN}" | awk -F'/' '{print $NF}' | xargs)
          echo "Checking role: '${MASTER_ROLE_NAME}'"
          if [[ -n "${ROLE_SEEN[$MASTER_ROLE_NAME]:-}" ]]; then
              echo "Already processed role: '${MASTER_ROLE_NAME}', skipping."
              continue
          fi
          ROLE_SEEN["$MASTER_ROLE_NAME"]=1
          echo "Assigning policy ${EFS_CLIENT_FULL_ACCESS_BUILTIN_POLICY_ARN} to role ${MASTER_ROLE_NAME}"
          aws iam attach-role-policy --role-name "${MASTER_ROLE_NAME}" --policy-arn "${EEFS_CLIENT_FULL_ACCESS_BUILTIN_POLICY_ARN}"
      done
  4. ロールの引き受けを許可するために、IAM エンティティーにポリシーをアタッチします。

    この手順はクラスターの設定によって異なります。次のどちらの場合も、EFS CSI Driver Operator はエンティティーを使用して AWS に対して認証します。このエンティティーには、アカウント B でロールを引き受けるための権限を付与する必要があります。

    クラスターで:

    • STS が有効でない場合: EFS CSI Driver Operator は、AWS 認証に IAM ユーザーエンティティーを使用します。「ロールの引き受けを許可するために IAM ユーザーにポリシーをアタッチする」ステップに進んでください。
    • STS が有効な場合: EFS CSI Driver Operator は、AWS 認証に IAM ロールエンティティーを使用します。「ロールの引き受けを許可するために IAM ロールにポリシーをアタッチする」ステップに進んでください。
  5. ロールの引き受けを許可するために IAM ユーザーにポリシーをアタッチします。

    1. 次のコマンドを実行して、EFS CSI Driver Operator によって使用されている IAM ユーザーを特定します。

      EFS_CSI_DRIVER_OPERATOR_USER=$(oc -n openshift-cloud-credential-operator get credentialsrequest/openshift-aws-efs-csi-driver -o json | jq -r '.status.providerStatus.user')
    2. 次のコマンドを実行して、その IAM ユーザーにポリシーをアタッチします。

      aws iam put-user-policy \
          --user-name "${EFS_CSI_DRIVER_OPERATOR_USER}"  \
          --policy-name efs-cross-account-inline-policy \
          --policy-document file://$SCRATCH_DIR/AssumeRoleInlinePolicyPolicyInAccountA.json
  6. ロールの引き受けを許可するために IAM ロールにポリシーをアタッチします。

    1. 次のコマンドを実行して、EFS CSI Driver Operator によって現在使用されている IAM ロール名を特定します。

      EFS_CSI_DRIVER_OPERATOR_ROLE=$(oc -n ${CSI_DRIVER_NAMESPACE} get secret/aws-efs-cloud-credentials -o jsonpath='{.data.credentials}' | base64 -d | grep role_arn | cut -d'/' -f2) && echo ${EFS_CSI_DRIVER_OPERATOR_ROLE}
    2. 次のコマンドを実行して、EFS CSI Driver Operator によって使用されている IAM ロールにポリシーをアタッチします。

       aws iam put-role-policy \
          --role-name "${EFS_CSI_DRIVER_OPERATOR_ROLE}"  \
          --policy-name efs-cross-account-inline-policy \
          --policy-document file://$SCRATCH_DIR/AssumeRoleInlinePolicyPolicyInAccountA.json
  7. VPC ピアリングを設定します。

    1. 次のコマンドを実行して、アカウント A からアカウント B へのピアリングリクエストを開始します。

      export AWS_DEFAULT_PROFILE=${AWS_ACCOUNT_A}
      PEER_REQUEST_ID=$(aws ec2 create-vpc-peering-connection --vpc-id "${AWS_ACCOUNT_A_VPC_ID}" --peer-vpc-id "${AWS_ACCOUNT_B_VPC_ID}" --peer-owner-id "${AWS_ACCOUNT_B_ID}" --query VpcPeeringConnection.VpcPeeringConnectionId --output text)
    2. 次のコマンドを実行して、アカウント B でピアリングリクエストを承認します。

      export AWS_DEFAULT_PROFILE=${AWS_ACCOUNT_B}
      aws ec2 accept-vpc-peering-connection --vpc-peering-connection-id "${PEER_REQUEST_ID}"
    3. 次のコマンドを実行して、アカウント A のルートテーブル ID を取得し、アカウント B の VPC にルートを追加します。

      export AWS_DEFAULT_PROFILE=${AWS_ACCOUNT_A}
      for NODE in $(oc get nodes --selector=node-role.kubernetes.io/worker | tail -n +2 | awk '{print $1}')
      do
          SUBNET=$(aws ec2 describe-instances --filters "Name=private-dns-name,Values=$NODE" --query 'Reservations[*].Instances[*].NetworkInterfaces[*].SubnetId' | jq -r '.[0][0][0]')
          echo SUBNET is ${SUBNET}
          ROUTE_TABLE_ID=$(aws ec2 describe-route-tables --filters "Name=association.subnet-id,Values=${SUBNET}" --query 'RouteTables[*].RouteTableId' | jq -r '.[0]')
          echo Route table ID is $ROUTE_TABLE_ID
          aws ec2 create-route --route-table-id ${ROUTE_TABLE_ID} --destination-cidr-block ${AWS_ACCOUNT_B_VPC_CIDR} --vpc-peering-connection-id ${PEER_REQUEST_ID}
      done
    4. 次のコマンドを実行して、アカウント B のルートテーブル ID を取得し、アカウント A の VPC にルートを追加します。

      export AWS_DEFAULT_PROFILE=${AWS_ACCOUNT_B}
      for ROUTE_TABLE_ID in $(aws ec2 describe-route-tables   --filters "Name=vpc-id,Values=${AWS_ACCOUNT_B_VPC_ID}"   --query "RouteTables[].RouteTableId" | jq -r '.[]')
      do
          echo Route table ID is $ROUTE_TABLE_ID
          aws ec2 create-route --route-table-id ${ROUTE_TABLE_ID} --destination-cidr-block ${AWS_ACCOUNT_A_VPC_CIDR} --vpc-peering-connection-id ${PEER_REQUEST_ID}
      done
  8. アカウント A から EFS への NFS トラフィックを許可するように、アカウント B のセキュリティーグループを設定します。

    1. 次のコマンドを実行して、アカウント B のプロファイルに切り替えます。

      export AWS_DEFAULT_PROFILE=${AWS_ACCOUNT_B}
    2. 次のコマンドを実行して、EFS アクセス用の VPC セキュリティーグループを設定します。

      SECURITY_GROUP_ID=$(aws ec2 describe-security-groups --filters Name=vpc-id,Values="${AWS_ACCOUNT_B_VPC_ID}" | jq -r '.SecurityGroups[].GroupId')
      aws ec2 authorize-security-group-ingress \
       --group-id "${SECURITY_GROUP_ID}" \
       --protocol tcp \
       --port 2049 \
       --cidr "${AWS_ACCOUNT_A_VPC_CIDR}" | jq .
  9. アカウント B にリージョン全体の EFS ファイルシステムを作成します。

    1. 次のコマンドを実行して、アカウント B のプロファイルに切り替えます。

      export AWS_DEFAULT_PROFILE=${AWS_ACCOUNT_B}
    2. 次のコマンドを実行して、リージョン全体の EFS ファイルシステムを作成します。

      CROSS_ACCOUNT_FS_ID=$(aws efs create-file-system --creation-token efs-token-1 \
      --region ${AWS_REGION} \
      --encrypted | jq -r '.FileSystemId') \
      && echo $CROSS_ACCOUNT_FS_ID
    3. 次のコマンドを実行して、EFS のリージョン全体のマウントターゲットを設定します。

      for SUBNET in $(aws ec2 describe-subnets \
        --filters "Name=vpc-id,Values=${AWS_ACCOUNT_B_VPC_ID}" \
        --region ${AWS_REGION} \
        | jq -r '.Subnets.[].SubnetId'); do \
          MOUNT_TARGET=$(aws efs create-mount-target --file-system-id ${CROSS_ACCOUNT_FS_ID} \
          --subnet-id ${SUBNET} \
          --region ${AWS_REGION} \
          | jq -r '.MountTargetId'); \
          echo ${MOUNT_TARGET}; \
      done

      これにより、VPC の各サブネットにマウントポイントが作成されます。

  10. クロスアカウントアクセス用に EFS Operator を設定します。

    1. 次のコマンドを実行して、後のステップで作成するシークレットとストレージクラスのカスタム名を定義します。

      export SECRET_NAME=my-efs-cross-account
      export STORAGE_CLASS_NAME=efs-sc-cross
    2. OpenShift Container Platform CLI で次のコマンドを実行して、アカウント B のロール ARN を参照するシークレットを作成します。

      oc create secret generic ${SECRET_NAME} -n ${CSI_DRIVER_NAMESPACE} --from-literal=awsRoleArn="${ACCOUNT_B_ROLE_ARN}"
    3. OpenShift Container Platform CLI で次のコマンドを実行して、新しく作成したシークレットへのアクセス権を CSI ドライバーコントローラーに付与します。

      oc -n ${CSI_DRIVER_NAMESPACE} create role access-secrets --verb=get,list,watch --resource=secrets
      oc -n ${CSI_DRIVER_NAMESPACE} create rolebinding --role=access-secrets default-to-secrets --serviceaccount=${CSI_DRIVER_NAMESPACE}:aws-efs-csi-driver-controller-sa
    4. OpenShift Container Platform CLI で次のコマンドを実行して、アカウント B の EFS ID と以前に作成したシークレットを参照する新しいストレージクラスを作成します。

      cat << EOF | oc apply -f -
      kind: StorageClass
      apiVersion: storage.k8s.io/v1
      metadata:
        name: ${STORAGE_CLASS_NAME}
      provisioner: efs.csi.aws.com
      parameters:
        provisioningMode: efs-ap
        fileSystemId: ${CROSS_ACCOUNT_FS_ID}
        directoryPerms: "700"
        gidRangeStart: "1000"
        gidRangeEnd: "2000"
        basePath: "/dynamic_provisioning"
        csi.storage.k8s.io/provisioner-secret-name: ${SECRET_NAME}
        csi.storage.k8s.io/provisioner-secret-namespace: ${CSI_DRIVER_NAMESPACE}
      EOF

6.10.6. One Zone ファイルシステム

AWS Elastic File System (EFS) One Zone ファイルシステムを使用して、単一のアベイラビリティーゾーン (AZ) 内にデータを冗長に保存できるため、マルチ AZ リージョンストレージと比較して低コストのストレージオプションが提供されます。

6.10.6.1. One Zone ファイルシステムの概要

AWS Elastic File System (EFS) One Zone は、リージョン内の複数の AZ をまたいでデータを冗長的に保存するデフォルトの EFS ストレージオプションとは対照的です。

OpenShift Container Platform 4.19 からアップグレードされたクラスターは、リージョン EFS ボリュームと互換性があります。

注記

One Zone ボリュームの動的プロビジョニングは、シングルゾーンクラスターでのみサポートされます。クラスター内のすべてのノードは、動的プロビジョニングに使用される EFS ボリュームと同じ AZ に存在する必要があります。

永続ボリューム (PV) に、ボリュームが存在するゾーンを示す正しい spec.nodeAffinity があることを前提として、リージョンクラスターで手動でプロビジョニングされた One Zone ボリュームがサポートされます。

Cloud Credential Operator (CCO) Mint モードまたは Passthrough の場合、追加の設定は必要ありません。ただし、Security Token Service (STS) の場合は、STS を使用した One Zone ファイルシステムのセットアップ セクションの手順を使用します。

6.10.6.2. STS を使用した One Zone ファイルシステムのセットアップ

Security Token Service (STS) 認証で AWS Elastic File System (EFS) One Zone ファイルシステムを使用するには、コントローラーノードとドライバーノードに個別の認証情報要求とロール ARN を設定します。

次の手順では、Security Token Service (STS) を使用して AWS One Zone ファイルシステムを設定する方法を説明します。

前提条件

  • cluster-admin ロールを持つユーザーとしてクラスターにアクセスできる。
  • AWS アカウントの認証情報。

手順

  1. Security Token Service のロール Amazon Resource Name の取得 セクションの手順に従って、credrequests ディレクトリーに 2 つの CredentialsRequests を作成します。

    • コントローラー の CredentialsRequest の場合は、変更せずに手順に従います。
    • ドライバーノード の CredentialsRequest の場合は、次のサンプルファイルを使用します。

      ドライバーノードの CredentialsRequest YAML ファイルの例

      apiVersion: cloudcredential.openshift.io/v1
      kind: CredentialsRequest
      metadata:
        annotations:
          credentials.openshift.io/role-arns-vars: NODE_ROLEARN
        name: openshift-aws-efs-csi-driver-node
        namespace: openshift-cloud-credential-operator
      spec:
        providerSpec:
          apiVersion: cloudcredential.openshift.io/v1
          kind: AWSProviderSpec
          statementEntries:
          - action:
            - elasticfilesystem:DescribeMountTargets
            - ec2:DescribeAvailabilityZones
            effect: Allow
            resource: '*'
        secretRef:
          name: node-aws-efs-cloud-credentials
          namespace: openshift-cluster-csi-drivers
        serviceAccountNames:
        - aws-efs-csi-driver-node-sa

      metadata.annotations.credentials.openshift.io/role-arns-vars を NODE_ROLEARN に設定します。

      ccoctl の出力例

      2025/08/26 14:05:24 Role arn:aws:iam::269733383066:role/my-arn-1-blll6-openshift-cluster-csi-drivers-aws-efs-cloud-cre created
      2025/08/26 14:05:24 Saved credentials configuration to: /home/my-arn/project/go/src/github.com/openshift/myinst/aws-sts-compact-1/manifests/openshift-cluster-csi-drivers-aws-efs-cloud-credentials-credentials.yaml
      2025/08/26 14:05:24 Updated Role policy for Role my-arn-1-blll6-openshift-cluster-csi-drivers-aws-efs-cloud-cre
      2025/08/26 14:05:24 Role arn:aws:iam::269733383066:role/my-arn-1-blll6-openshift-cluster-csi-drivers-node-aws-efs-clou created
      2025/08/26 14:05:24 Saved credentials configuration to: manifests/openshift-cluster-csi-drivers-node-aws-efs-cloud-credentials-credentials.yaml
      2025/08/26 14:05:24 Updated Role policy for Role my-arn-1-blll6-openshift-cluster-csi-drivers-node-aws-efs-clou

      この例では、以下が適用されます。

    • 最初の行は Controller Amazon Resource Name (ARN) を示しています。
    • 5 行目は Driver ノード ARN を示しています。
  2. この手順の前半で作成したコントローラー ARN を使用して、AWS EFS CSI ドライバーをインストールします。
  3. 次のようなコマンドを実行して、Operator のサブスクリプションを編集し、ドライバーノードの ARN と NODE_ROLEARN を追加します。

    $ oc -n openshift-cluster-csi-drivers edit subscription aws-efs-csi-driver-operator
    ...
      config:
        env:
        - name: ROLEARN
          value: arn:aws:iam::269733383066:role/my-arn-1-blll6-openshift-cluster-csi-drivers-aws-efs-cloud-cre
        - name: NODE_ROLEARN
          value: arn:aws:iam::269733383066:role/my-arn-1-blll6-openshift-cluster-csi-drivers-node-aws-efs-clou
    ...
    • ROLEARN 値は、すでに存在する Controller ARN です。
    • NODE_ROLEARN 値はドライバーノードの ARN です。

6.10.7. Amazon Elastic File Storage の動的プロビジョニング

永続ボリューム (PV) を既存の Elastic File System (EFS) ボリュームのサブディレクトリーとして動的にプロビジョニングするには、EFS ストレージクラスを参照する永続ボリューム要求 (PVC) を作成して、同じリソースを共有する複数の独立したボリュームを有効にします。

AWS EFS Container Storage Interface (CSI) ドライバーは、他の CSI ドライバーとは異なる形式の動的プロビジョニングをサポートします。既存の EFS ボリュームのサブディレクトリーとして新しい PV をプロビジョニングします。PV はお互いに独立しています。しかし、これらはすべて同じ EFS ボリュームを共有しています。ボリュームが削除されると、そのボリュームからプロビジョニングされたすべての PV も削除されます。

EFS CSI ドライバーは、そのようなサブディレクトリーごとに AWS アクセスポイントを作成します。AWS AccessPoint の制限により、単一の StorageClass/EFS ボリュームから動的にプロビジョニングできるのは 1000 PV のみです。

重要

なお、PVC.spec.resources は EFS では強制されません。

以下の例では、5 GiB の容量を要求しています。しかし、作成された PV は無限であり、どんな量のデータ (ペタバイトのような) も保存することができます。ボリュームに大量のデータを保存してしまうと、壊れたアプリケーション、あるいは不正なアプリケーションにより、多額の費用が発生します。

AWS の EFS ボリュームサイズのモニタリングを使用することを強く推奨します。

動的プロビジョニングのセットアップに問題がある場合は、AWS EFS のトラブルシューティング を参照してください。

前提条件

  • Amazon Elastic File Storage (Amazon EFS) ボリュームが作成されている。
  • AWS EFS ストレージクラスを作成している。

手順

  • 以前に作成した StorageClass を参照して、通常どおり PVC (または StatefulSet や Template) を作成します。

    apiVersion: v1
    kind: PersistentVolumeClaim
    metadata:
      name: test
    spec:
      storageClassName: efs-sc
      accessModes:
        - ReadWriteMany
      resources:
        requests:
          storage: 5Gi

6.10.8. Amazon Elastic File Storage を使用した静的 PV の作成

Amazon Elastic File Storage (EFS) ボリューム全体を動的プロビジョニングなしで単一の永続ボリュームとしてマウントするには、Pod がフルボリュームにアクセスできる静的永続ボリューム (PV) を作成します。

静的 PV の設定に問題がある場合は、「AWS EFS のトラブルシューティング」を参照してください。

前提条件

  • Amazon EFS ボリュームが作成されている。

手順

  • 以下の YAML ファイルで PV を作成します。

    apiVersion: v1
    kind: PersistentVolume
    metadata:
      name: efs-pv
    spec:
      capacity:
        storage: 5Gi
      volumeMode: Filesystem
      accessModes:
        - ReadWriteMany
        - ReadWriteOnce
      persistentVolumeReclaimPolicy: Retain
      csi:
        driver: efs.csi.aws.com
        volumeHandle: fs-ae66151a
        volumeAttributes:
          encryptInTransit: "false"
  • spec.capacity には意味がなく、CSI ドライバーでは無視されます。PVC へのバインディング時にのみ使用されます。アプリケーションは、ボリュームに任意の量のデータを保存することができます。
  • spec.csi.volumeHandle は、AWS で作成した EFS ボリュームと同じ ID である必要があります。独自のアクセスポイントを提供する場合、volumeHandle は <EFS volume ID>::<access point ID> とします。たとえば、fs-6e633ada::fsap-081a1d293f0004630 です。
  • spec.csi.volumeAttributes.encryptInTransit: 必要に応じて、転送中の暗号化を無効にできます。デフォルトでは、暗号化が有効になっています。

6.10.9. Amazon Elastic File Storage のセキュリティー

アクセスポイントで Amazon Elastic File Storage (EFS) を使用する場合は、ファイル権限が Kubernetes FSGroup 設定ではなくアクセスポイントによって制御され、アクセス権を持つすべての Pod がすべてのファイルを読み取ることができることを理解してください。

前述の動的プロビジョニングなどでアクセスポイントを使用する場合、Amazon はファイルの GID をアクセスポイントの GID に自動的に置き換えます。また、EFS では、ファイルシステムの権限を評価する際に、アクセスポイントのユーザー ID、グループ ID、セカンダリーグループ ID を考慮します。EFS は、NFS クライアントの ID を無視します。アクセスポイントの詳細は、「アクセスポイントの使用」を参照してください。

その結果、EFS ボリュームは FSGroup を静かに無視します。OpenShift Container Platform は、ボリューム上のファイルの GID を FSGroup で置き換えることができません。マウントされた EFS アクセスポイントにアクセスできる Pod は、そこにあるすべてのファイルにアクセスできます。

これとは関係ありませんが、転送中の暗号化はデフォルトで有効になっています。詳細は、「転送中のデータの暗号化」を参照してください。

6.10.10. AWS EFS ストレージ CSI 使用状況メトリクス

Amazon Web Services (AWS) Elastic File System (EFS) Storage Container Storage Interface (CSI) 使用状況メトリクスを使用すると、動的または静的にプロビジョニングされた EFS ボリュームによって使用されているスペースの量を監視できます。

重要

メトリクスを有効にするとパフォーマンスが低下する可能性があるため、この機能はデフォルトで無効になっています。

AWS EFS 使用状況メトリクス機能は、ボリューム内のファイルを再帰的にウォークスルーし、AWS EFS CSI ドライバーのボリュームメトリクスを収集します。この作業によりパフォーマンスが低下する可能性があるため、管理者はこの機能を明示的に有効にする必要があります。

6.10.10.1. Web コンソールを使用した使用状況メトリクスの有効化または無効化

Web コンソールから Elastic File System (EFS) ボリューム領域の消費量を監視するには、再帰ウォークパラメーターを使用して ClusterCSIDriver リソースを設定して、使用メトリクスを有効にします。

前提条件

  • 管理者権限を持つ OpenShift Container Platform クラスターへのアクセス

手順

  1. Administration > CustomResourceDefinitions をクリックします。
  2. CustomResourceDefinitions ページの Name ドロップダウンボックスの横に、clustercsidriver と入力します。
  3. CRD ClusterCSIDriver をクリックします。
  4. YAML タブをクリックします。
  5. spec.aws.efsVolumeMetrics.state の下に以下があります。

    • メトリクスの有効化: 値を RecursiveWalk に設定します。RecursiveWalk` は、AWS EFS CSI ドライバーのボリュームメトリクス収集が、ボリューム内のファイルを再帰的にウォークスルーすることによって実行されることを示します。
    • Disable メトリクス: 値を Disabled に設定します。

      ClusterCSIDriver efs.csi.aws.com YAML ファイルの例

      spec:
          driverConfig:
              driverType: AWS
              aws:
                  efsVolumeMetrics:
                    state: RecursiveWalk
                    recursiveWalk:
                      refreshPeriodMinutes: 100
                      fsRateLimit: 10

  6. オプション: 再帰ウォークの動作を定義するために、次のフィールドを設定することもできます。

    • refreshPeriodMinutes: ボリュームメトリクスの更新頻度を分単位で指定します。このフィールドを空白のままにすると、適切なデフォルトが選択されますが、これは時間の経過とともに変更される可能性があります。現在のデフォルトは 240 分です。有効な範囲は 1 - 43,200 分です。
    • fsRateLimit: ファイルシステムごとに、goroutine でボリュームメトリクスを処理するためのレート制限を定義します。このフィールドを空白のままにすると、適切なデフォルトが選択されますが、これは時間の経過とともに変更される可能性があります。現在のデフォルトは 5 つの goroutine です。有効な範囲は 1 - 100 の goroutine です。
  7. Save をクリックします。

6.10.10.2. CLI を使用した使用状況メトリクスの有効化または無効化

コマンドラインインターフェイスを使用して Elastic File System (EFS) ボリューム領域の消費量を監視するには、再帰ウォークパラメーターを使用して ClusterCSIDriver リソースを設定して、使用メトリクスを有効にします。

必要に応じて、使用状況メトリクスを無効にすることもできます。

前提条件

  • 管理者権限を持つ OpenShift Container Platform クラスターへのアクセス
  • OpenShift Container Platform CLI (oc) へのアクセス

手順

  1. 次のコマンドを実行して、ClusterCSIDriver を編集します。

    $ oc edit clustercsidriver efs.csi.aws.com
  2. spec.aws.efsVolumeMetrics.state の下に以下があります。

    • メトリクスの有効化: 値を RecursiveWalk に設定します。RecursiveWalk は、AWS EFS CSI ドライバーのボリュームメトリクス収集が、ボリューム内のファイルを再帰的にウォークスルーすることによって実行されることを示します。
    • Disable メトリクス: 値を Disabled に設定します。

      ClusterCSIDriver efs.csi.aws.com YAML ファイルの例

      spec:
          driverConfig:
              driverType: AWS
              aws:
                  efsVolumeMetrics:
                    state: RecursiveWalk
                    recursiveWalk:
                      refreshPeriodMinutes: 100
                      fsRateLimit: 10

  3. オプション: 再帰ウォークの動作を定義するために、次のフィールドを設定することもできます。

    • refreshPeriodMinutes: ボリュームメトリクスの更新頻度を分単位で指定します。このフィールドを空白のままにすると、適切なデフォルトが選択されますが、これは時間の経過とともに変更される可能性があります。現在のデフォルトは 240 分です。有効な範囲は 1 - 43,200 分です。
    • fsRateLimit: ファイルシステムごとに、goroutine でボリュームメトリクスを処理するためのレート制限を定義します。このフィールドを空白のままにすると、適切なデフォルトが選択されますが、これは時間の経過とともに変更される可能性があります。現在のデフォルトは 5 つの goroutine です。有効な範囲は 1 - 100 の goroutine です。
  4. efs.csi.aws.com オブジェクトへの変更を保存します。

6.10.11. Amazon Elastic File Storage のトラブルシューティング

AWS Elastic File System (EFS) の問題を診断および解決するには、ログの収集、Operator ステータスの確認、ネットワーク接続の検証などのトラブルシューティング手順を使用します。

次の情報は、Amazon Elastic File Storage (Amazon EFS) に関する問題のトラブルシューティング方法に関するガイダンスです。

  • AWS EFS Operator と CSI ドライバーは、namespace openshift-cluster-csi-drivers で実行されます。
  • AWS EFS Operator と CSI ドライバーのログ収集を開始するには、以下のコマンドを実行します。

    $ oc adm must-gather
    [must-gather      ] OUT Using must-gather plugin-in image: quay.io/openshift-release-dev/ocp-v4.0-art-dev@sha256:125f183d13601537ff15b3239df95d47f0a604da2847b561151fedd699f5e3a5
    [must-gather      ] OUT namespace/openshift-must-gather-xm4wq created
    [must-gather      ] OUT clusterrolebinding.rbac.authorization.k8s.io/must-gather-2bd8x created
    [must-gather      ] OUT pod for plug-in image quay.io/openshift-release-dev/ocp-v4.0-art-dev@sha256:125f183d13601537ff15b3239df95d47f0a604da2847b561151fedd699f5e3a5 created
  • AWS EFS Operator のエラーを表示するには、ClusterCSIDriver のステータスを表示します。

    $ oc get clustercsidriver efs.csi.aws.com -o yaml
  • Pod にボリュームをマウントできない場合 (以下のコマンドの出力に示す):

    $ oc describe pod
    ...
      Type     Reason       Age    From               Message
      ----     ------       ----   ----               -------
      Normal   Scheduled    2m13s  default-scheduler  Successfully assigned default/efs-app to ip-10-0-135-94.ec2.internal
      Warning  FailedMount  13s    kubelet            MountVolume.SetUp failed for volume "pvc-d7c097e6-67ec-4fae-b968-7e7056796449" : rpc error: code = DeadlineExceeded desc = context deadline exceeded
      Warning  FailedMount  10s    kubelet            Unable to attach or mount volumes: unmounted volumes=[persistent-storage], unattached volumes=[persistent-storage kube-api-access-9j477]: timed out waiting for the condition

    error: code = DeadlineExceeded desc = context deadline exceeded というテキストは、ボリュームがマウントされていないことを示す警告メッセージです。

    このエラーは、OpenShift Container Platform ノードと Amazon EFS 間のパケットを AWS がドロップすることで頻繁に発生します。

    以下が正しいことを確認します。

    • AWS のファイアウォールとセキュリティーグループ
    • ネットワーク: ポート番号と IP アドレス

6.10.12. AWS EFS CSI Driver Operator のアンインストール

AWS EFS Container Storage Interface (CSI) Driver Operator と空きクラスターリソースを削除するには、アプリケーションを停止し、永続ボリューム (PV) を削除した後に Operator をアンインストールします。

AWS EFS CSI Driver Operator (Red Hat Operator) をアンインストールすると、すべての EFS PV にアクセスできなくなります。

注記

クラスターを破棄 (openshift-install destroy cluster) する前に、AWS の EFS ボリュームを削除する必要があります。クラスターの VPC を使用する EFS ボリュームがある場合、OpenShift Container Platform クラスターを破棄することはできません。Amazon はこのような VPC の削除を許可していません。

前提条件

  • OpenShift Container Platform Web コンソールにアクセスできる。

手順

  1. Web コンソールにログインします。
  2. AWS EFS PV を使用するすべてのアプリケーションを停止します。
  3. すべての AWS EFS PV を削除します。

    1. Storage PersistentVolumeClaims をクリックします。
    2. AWS EFS CSI Driver Operator が使用している各 PVC を選択し、PVC の右端にあるドロップダウンメニューをクリックして、Delete PersistentVolumeClaims をクリックします。
  4. AWS EFS CSI ドライバーをアンインストールします。

    注記

    Operator をアンインストールする前に、まず CSI ドライバーを削除する必要があります。

    1. Administration CustomResourceDefinitions ClusterCSIDriver をクリックします。
    2. Instances タブの efs.csi.aws.com の左端にあるドロップダウンメニューをクリックし、Delete ClusterCSIDriver をクリックします。
    3. プロンプトが表示されたら、Delete をクリックします。
  5. AWS EFS CSI Operator をアンインストールします。

    1. Ecosystem Installed Operators をクリックします。
    2. Installed Operators ページで、スクロールするか、Search by name ボックスに AWS EFS CSI と入力して Operator を見つけてクリックします。
    3. Installed Operators > Operator details ページの右上にある Actions Uninstall Operator をクリックします。
    4. Uninstall Operator ウィンドウでプロンプトが表示されたら、Uninstall ボタンをクリックして namespace から Operator を削除します。Operator によってクラスターにデプロイされたアプリケーションは手動でクリーンアップする必要があります。

      アンインストールすると、AWS EFS CSI Driver Operator が Web コンソールの Installed Operators セクションにリスト表示されなくなります。

6.11. Azure Disk CSI Driver Operator

Azure Disk Container Storage Interface (CSI) Driver Operator とドライバーを使用すると、OpenShift Container Platform で Azure Disk Storage をプロビジョニングおよび管理できます。これにより、動的なボリュームプロビジョニングが可能になり、ストレージの事前プロビジョニングが不要になります。

6.11.1. Azure Disk CSI Driver Operator の概要

OpenShift Container Platform は、Microsoft Azure Disk Storage の Container Storage Interface (CSI) ドライバーを使用して永続ボリューム (PV) をプロビジョニングできます。

CSI Operator およびドライバーを使用する場合は、永続ストレージ および CSI ボリュームの設定 を理解しておくことが推奨されます。これらのトピックの詳細は、「永続ストレージについて」および「CSI ボリュームの設定」を参照してください。

Azure Disk ストレージアセットにマウントする CSI でプロビジョニングされた永続ボリューム (PV) を作成するには、OpenShift Container Platform は、デフォルトで Azure Disk CSI Driver Operator および Azure Disk CSI ドライバーを openshift-cluster-csi-drivers namespace にインストールします。

Azure Disk CSI Driver Operator
Azure Disk CSI Driver Operator は、永続ボリューム要求 (PVC) の作成に使用できる managed-csi というストレージクラスを提供します。Azure Disk CSI Driver Operator は、ストレージボリュームをオンデマンドで作成できるようにし、クラスター管理者がストレージを事前にプロビジョニングする必要がなくすことで、動的ボリュームのプロビジョニングをサポートします。必要に応じて、このデフォルトのストレージクラスを無効にできます (「デフォルトストレージクラスの管理」を参照)。
Azure Disk CSI ドライバー
Azure Disk CSI ドライバー を使用すると、Azure Disk PV を作成し、マウントできます。
注記

OpenShift Container Platform は、Azure Disk インツリーボリュームプラグインを同等の CSI ドライバーに自動的に移行します。詳細は、「CSI 自動移行」を参照してください。

6.11.2. CSI について

Container Storage Interface (CSI) を使用すると、ストレージベンダーは Kubernetes コアコードを変更することなく、従来の組み込みストレージドライバーの代わりに、標準インターフェイスを介してプラグインを提供できます。

CSI Operator は、インツリーボリュームプラグインでは不可能なボリュームスナップショットなどのストレージオプションを OpenShift Container Platform ユーザーに付与します。

6.11.3. ストレージアカウントタイプを使用したストレージクラスの作成

特定のパフォーマンスと冗長性の特性を持つ永続ボリュームをプロビジョニングするには、SKU 階層に対応する Azure ストレージアカウントタイプを指定するストレージクラスを作成します。

ストレージクラスを使用すると、ストレージのレベルや使用状況を区別し、記述することができます。ストレージクラスを定義することで、動的にプロビジョニングされた永続ボリュームを取得できます。

ストレージクラスを作成するときに、ストレージアカウントの種類を指定できます。これは、Azure ストレージアカウントの SKU の層に対応します。有効なオプションは、Standard_LRS、Premium_LRS、StandardSSD_LRS、UltraSSD_LRS、Premium_ZRS、および StandardSSD_ZRS です。Azure SKU レベルを見つける方法は、「SKU Types」を参照してください。

ゾーン冗長ストレージ (ZRS) と PremiumV2_LRS の両方にリージョン制限があります。これらの制限は、「ZRS の制限」および「Premium_LRS の制限」を参照してください。

前提条件

  • 管理者権限を持つ OpenShift Container Platform クラスターへのアクセス

手順

  1. 次のような YAML ファイルを使用して、ストレージアカウントの種類を指定するストレージクラスを作成します。

    $ oc create -f - << EOF
    apiVersion: storage.k8s.io/v1
    kind: StorageClass
    metadata:
      name: <storage-class>
    provisioner: disk.csi.azure.com
    parameters:
      skuName: <storage-class-account-type>
    reclaimPolicy: Delete
    volumeBindingMode: WaitForFirstConsumer
    allowVolumeExpansion: true
    EOF
    • metadata.name: ストレージクラス名を指定します。
    • parameters.skuName: ストレージアカウントタイプ。これは、Azure ストレージアカウントの SKU 層 (`Standard_LRS`、Premium_LRS、StandardSSD_LRS、UltraSSD_LRS、Premium_ZRS、StandardSSD_ZRS、PremiumV2_LRS) に対応しています。

      注記

      PremiumV2_LRS の場合、storageclass.parameters で cachingMode: None を指定します。

  2. ストレージクラスを一覧表示して、ストレージクラスが作成されたことを確認します。

    $ oc get storageclass

    出力例

    NAME                    PROVISIONER          RECLAIMPOLICY   VOLUMEBINDINGMODE      ALLOWVOLUMEEXPANSION   AGE
    azurefile-csi           file.csi.azure.com   Delete          Immediate              true                   68m
    managed-csi (default)   disk.csi.azure.com   Delete          WaitForFirstConsumer   true                   68m
    sc-prem-zrs             disk.csi.azure.com   Delete          WaitForFirstConsumer   true                   4m25s

    この例では、sc-prem-zrs はストレージアカウントタイプを持つ新しいストレージクラスです。

6.11.4. Azure Disk の Performance Plus

performance plus を有効にすると、特定の Azure ディスクタイプ 513 GiB 以上の IOPS およびスループット制限を向上させることができます。

6.11.4.1. performance plus の概要

パフォーマンスに加えて、特定の Azure ディスクタイプ 513 GiB 以上の Input/Output Operations Per Second (IOPS) とスループット制限が向上します。

次の Azure ディスクタイプは、パフォーマンスに加えて、

  • Azure Premium ソリッドステートドライブ (SSD)
  • 標準 SSD
  • 標準ハードディスクドライブ (HDD)

IOPS とスループットの上限が増えたことを確認する場合は、「仮想マシンディスクのスケーラビリティーとパフォーマンス目標」に記載されている表で、Expanded で始まる列を参照してください。

6.11.4.2. パフォーマンスの制限に加えて

パフォーマンスプラスを正常に有効にするには、この機能を使用する前に、ディスク設定が必要なタイプ、サイズ、プロビジョニング基準を満たしていることを確認してください。

Azure Disk の Performance plus には次の制限があります。

  • 513 GiB 以上の Standard HDD、Standard SSD、および Premium SSD マネージドディスクでのみ有効にできます。

    重要

    これより小さい値を要求すると、ディスクサイズは 513 GiB に調整されます。

  • 新しいディスクでのみ有効にできます。回避策については、「スナップショットまたは複製による Performance Plus の有効化」を参照してください。

6.11.4.3. Performance Plus 拡張ディスクを使用するストレージクラスの作成

IOPS とスループットを強化した Azure ディスクをプロビジョニングするには、永続ボリューム要求に自動的に適用される performance plus が有効なストレージクラスを作成します。

前提条件

  • cluster-admin 特権で Microsoft Azure クラスターにアクセスできる。
  • Performance Plus が有効になっている Azure ディスクにアクセスできる。

    ディスクで Performance Plus を有効にする方法については、Microsoft Azure ストレージのドキュメント を参照してください。

手順

  1. 次のサンプル YAML ファイルを使用してストレージクラスを作成します。

    ストレージクラスの YAML ファイルの例

    apiVersion: storage.k8s.io/v1
    kind: StorageClass
    metadata:
      name: <azure-disk-performance-plus-sc>
    provisioner: disk.csi.azure.com
    parameters:
      skuName: Premium_LRS
      cachingMode: ReadOnly
      enablePerformancePlus: "true"
    reclaimPolicy: Delete
    volumeBindingMode: WaitForFirstConsumer
    allowVolumeExpansion: true

    • metadata.name: ストレージクラスの名前を指定します。
    • provisioner: Azure Disk Container Storage Interface (CSI) ドライバープロビジョナーを指定します。
    • parameters.skuName: Azure ディスクタイプの SKU を指定します。この例では、Premium SSD Locally Redundant Storage の Premium_LRS です。
    • parameters.enablePerformancePlus: Azure Disk パフォーマンスプラスを有効にします。
  2. 次のサンプル YAML ファイルを使用して、このストレージクラスを使用する永続ボリューム要求 (PVC) を作成します。

    PVC YAML ファイルの例

    apiVersion: v1
    kind: PersistentVolumeClaim
    metadata:
      name: <my-azure-pvc>
    spec:
      accessModes:
        - ReadWriteOnce
      storageClassName: <azure-disk-performance-plus-sc>
      resources:
        requests:
          storage: 513Gi

    • metadata.name: PVC 名を指定します。
    • spec.storageClassName: パフォーマンスとストレージクラスを参照します。
    • spec.resources.requests.storage: 513GiB 未満のディスクサイズは自動的に切り上げられます。

6.11.4.4. スナップショットまたは複製による Performance Plus の有効化

パフォーマンスプラスが新しいディスクにのみ適用されるという制限を回避するには、既存のボリュームのスナップショットを作成するか、クローンを作成して、パフォーマンスプラスが有効になっている新しいディスクをプロビジョニングします。

通常、Performance Plus は新しいディスクでのみ有効にできます。回避策として、次の手順を使用できます。

前提条件

  • cluster-admin 特権で Microsoft Azure クラスターにアクセスできる。
  • Performance Plus が有効になっている Azure ディスクにアクセスできる。
  • Performance Plus 拡張 Azure ディスクを使用するストレージクラスを作成した。

    ストレージクラスの作成の詳細は、「Performance Plus 拡張ディスクを使用するストレージクラスの作成」を参照してください。

手順

  1. パフォーマンスプラスを有効にするには、以下のいずれかを実行します。

    • performance plus が有効になっていない既存のボリュームのスナップショットを作成し、enablePerformancePlus が "true" に設定されたストレージクラスを使用して、そのスナップショットから新しいディスクをプロビジョニングします。
    • enablePerformancePlus が "true" に設定されたストレージクラスを使用して永続ボリューム要求 (PVC) を複製し、新しいディスクを複製します。

6.11.5. ユーザー管理型の暗号化

ユーザー管理型の暗号化機能を使用すると、インストール時に OpenShift Container Platform ノードのルートボリュームを暗号化するキーを指定でき、すべてのマネージドストレージクラスはこれらのキーを使用してプロビジョニングされたストレージボリュームを暗号化できます。

install-config YAML ファイルの platform.<cloud_type>.defaultMachinePlatform フィールドにカスタムキーを指定する必要があります。

この機能は、次のストレージタイプをサポートします。

  • Amazon Web Services (AWS) Elastic Block storage (EBS)

    注記

    ストレージクラスに暗号化キーが定義されていない場合は、ストレージクラスに encrypted: "true" のみを設定します。AWS EBS CSI ドライバーは、AWS 管理の alias/aws/ebs を使用します。これは、プロビジョニングされたストレージボリュームを暗号化するために、デフォルトで各リージョンで Amazon EBS によって自動的に作成されます。さらに、マネージドストレージクラスはすべて encrypted: "true" 設定になっています。

    AWS EBS のユーザー管理の暗号化を使用したインストールの詳細は、オプションの AWS 設定パラメーター を参照してください。

  • Microsoft Azure Disk ストレージ

    注記

    OS (ルート) ディスクが暗号化されており、ストレージクラスに暗号化キーが定義されていない場合、Azure Disk CSI ドライバーは、デフォルトで OS ディスク暗号化キーを使用して、プロビジョニングされたストレージボリュームを暗号化します。

    ユーザー管理暗号化を使用した Azure Disk のインストールの詳細は、「Azure Disk 暗号化セットの準備」を参照してください。

  • Google Cloud Platform (GCP) 永続ディスク (PD) ストレージ

    ユーザー管理暗号化を使用した GCP PD のインストールの詳細は、「その他の Google Cloud 設定パラメーター」を参照してください。

  • IBM Cloud® Virtual Private Cloud (VPC) Block ストレージ

    IBM Cloud のユーザー管理型の暗号化を使用したインストールの詳細は、IBM Cloud のユーザー管理型の暗号化 および IBM Cloud へのインストール を参照してください。

6.11.6. PVC を使用して Ultra ディスクと共にマシンをデプロイするマシンセット

Microsoft Azure 上で動作するマシンセットを作成し、ウルトラディスクを搭載したマシンをデプロイすることができます。Ultra ディスクは、最も要求の厳しいデータワークロードでの使用を目的とした高性能ストレージです。

in-tree プラグインおよび CSI ドライバーの両方が、Ultra ディスクを有効にするための PVC の使用をサポートします。PVC を作成せずに、データディスクとしての Ultra デイスクと共にマシンをデプロイすることもできます。

6.11.6.1. マシンセットを使用した Ultra ディスクを持つマシンの作成

マシンセットの YAML ファイルを編集することで、ウルトラディスクを搭載したマシンを Microsoft Azure にデプロイできます。

前提条件

  • 既存の Microsoft Azure クラスターがある。

手順

  1. 既存の Azure MachineSet カスタムリソース (CR) をコピーし、次のコマンドを実行して編集します。

    $ oc edit machineset <machine_set_name>

    各項目の説明:

    < マシンセット名 >
    ウルトラディスクを搭載するマシンセットを指定します。
  2. 示された位置に次の行を追加します。

    apiVersion: machine.openshift.io/v1beta1
    kind: MachineSet
    spec:
      template:
        spec:
          metadata:
            labels:
              disk: ultrassd
          providerSpec:
            value:
              ultraSSDCapability: Enabled

    各項目の説明:

    spec.template.spec.metadata.labels.disk
    このマシンセットによって作成されたノードを選択するために使用するラベルを指定します。この例では、この値として disk.ultrassd を使用しています。
    spec.template.spec.providerSpec.value.ultraSSDCapability
    ウルトラディスクの使用を可能にします。
  3. 次のコマンドを実行して、更新された設定を使用してマシンセットを作成します。

    $ oc create -f <machine_set_name>.yaml
  4. 以下の YAML 定義が含まれるストレージクラスを作成します。

    apiVersion: storage.k8s.io/v1
    kind: StorageClass
    metadata:
      name: ultra-disk-sc
    parameters:
      cachingMode: None
      diskIopsReadWrite: "2000"
      diskMbpsReadWrite: "320"
      kind: managed
      skuname: UltraSSD_LRS
    provisioner: disk.csi.azure.com
    reclaimPolicy: Delete
    volumeBindingMode: WaitForFirstConsumer

    各項目の説明:

    metadata.name
    ストレージクラスの名前を指定します。この例では、この値に ultra-disk-sc を 使用しています。
    パラメーター.diskIopsReadWrite
    ストレージクラスの 1 秒あたりの入出力操作数 (IOPS) を指定します。
    パラメーター.diskMbpsReadWrite
    ストレージクラスのスループットを MBps 単位で指定します。
    provisioner
    Microsoft Azure Kubernetes Service (AKS) バージョン 1.21 以降の場合は、disk.csi.azure.com を使用してください。以前のバージョンの AKS の場合は、kubernetes.io/azure-disk を使用します。
    volumeBindingMode
    オプションのパラメーター。このパラメーターを指定すると、ディスクを使用する Pod の作成が完了するまで待機します。
  5. 以下の YAML 定義が含まれる、ultra-disk-sc ストレージクラスを参照する永続ボリューム要求 (PVC) を作成します。

    apiVersion: v1
    kind: PersistentVolumeClaim
    metadata:
      name: ultra-disk
    spec:
      accessModes:
      - ReadWriteOnce
      storageClassName: ultra-disk-sc
      resources:
        requests:
          storage: 4Gi

    各項目の説明:

    metadata.name
    PVC の名前を指定します。この例では、この値に ウルトラディスク を使用しています。
    spec.storageClassName
    使用するストレージクラスの名前を指定します。この例では 、ultra-disk-sc ストレージクラスを使用しています。
    spec.resources.requests.storage
    ストレージクラスのサイズを指定します。最小値は 4Gi です。
  6. 以下の YAML 定義が含まれる Pod を作成します。

    apiVersion: v1
    kind: Pod
    metadata:
      name: nginx-ultra
    spec:
      nodeSelector:
        disk: ultrassd
      containers:
      - name: nginx-ultra
        image: alpine:latest
        command:
          - "sleep"
          - "infinity"
        volumeMounts:
        - mountPath: "/mnt/azure"
          name: volume
      volumes:
        - name: volume
          persistentVolumeClaim:
            claimName: ultra-disk

    各項目の説明:

    spec.nodeSelector.disk
    ウルトラディスクの使用を可能にするマシンセットのラベルを指定します。この例では、この値として disk.ultrassd を使用しています。
    spec.volumes.persistentVolumeClaim.claimName
    取り付ける PVC パイプの名前を指定します。この Pod は ultra-disk PVC を参照します。

検証

  1. 次のコマンドを実行して、マシンが作成されていることを確認します。

    $ oc get machines

    マシンは Running 状態になっているはずです。

  2. 実行中でノードが接続されているマシンの場合、次のコマンドを実行してパーティションを検証します。

    $ oc debug node/<node_name> -- chroot /host lsblk

    このコマンドでは、oc debug node/<node_name> によりノード <node_name> 上でデバッグシェルを起動し、-- を指定してコマンドを渡します。渡されたコマンド chroot /host は、基盤となるホスト OS バイナリーへのアクセスを提供し、lsblk は、ホスト OS マシンに接続されているブロックデバイスを表示します。

次のステップ

  • Pod 内から Ultra ディスクを使用するには、マウントポイントを使用するワークロードを作成します。次の例のような YAML ファイルを作成します。

    apiVersion: v1
    kind: Pod
    metadata:
      name: ssd-benchmark1
    spec:
      containers:
      - name: ssd-benchmark1
        image: nginx
        ports:
          - containerPort: 80
            name: "http-server"
        volumeMounts:
        - name: lun0p1
          mountPath: "/tmp"
      volumes:
        - name: lun0p1
          hostPath:
            path: /var/lib/lun0p1
            type: DirectoryOrCreate
      nodeSelector:
        disktype: ultrassd

マシンセットでウルトラディスクを有効にした際に発生する可能性のある問題から復旧することができます。ディスク設定などの項目を確認し、パラメーターが正しく設定されていることを確認してください。

6.11.6.2.1. Ultra ディスクがサポートする永続ボリューム要求をマウントできない

Ultra ディスクでサポートされる永続ボリューム要求のマウントに問題がある場合、Pod は ContainerCreating 状態のままになり、アラートがトリガーされます。

たとえば、additionalCapabilities.ultraSSDEnabled パラメーターが Pod をホストするノードをサポートするマシンで設定されていない場合、以下のエラーメッセージが表示されます。

StorageAccountType UltraSSD_LRS can be used only when additionalCapabilities.ultraSSDEnabled is set.
  • この問題を解決するには、以下のコマンドを実行して Pod を記述します。

    $ oc -n <stuck_pod_namespace> describe pod <stuck_pod_name>

6.12. Azure File CSI Driver Operator

Azure File Container Storage Interface (CSI) Driver Operator とドライバーを使用すると、OpenShift Container Platform で Azure File Storage をプロビジョニングおよび管理できます。これにより、動的なボリュームプロビジョニングが可能になり、ストレージの事前プロビジョニングが不要になります。

6.12.1. 概要

OpenShift Container Platform は、Microsoft Azure File Storage の Container Storage Interface (CSI) ドライバーを使用して、永続ボリューム (PV) をプロビジョニングできます。

CSI Operator およびドライバーを使用する場合は、永続ストレージ および CSI ボリュームの設定 を理解しておくことが推奨されます。詳細は、「永続ストレージについて」および「CSI ボリュームの設定」を参照してください。

Azure File ストレージアセットにマウントする CSI でプロビジョニングされた永続ボリューム (PV) を作成するには、OpenShift Container Platform は、デフォルトで Azure File CSI Driver Operator および Azure File CSI ドライバーを openshift-cluster-csi-drivers namespace にインストールします。

Azure File CSI Driver Operator
Azure File CSI Driver Operator は、永続ボリューム要求 (PVC) の作成に使用できる azurefile-csi というストレージクラスを提供します。必要に応じて、このデフォルトのストレージクラスを無効にできます (デフォルトストレージの管理 を参照)。
Azure File CSI ドライバー
Azure File CSI ドライバー を使用すると、Azure File PV を作成し、マウントできます。Azure File CSI ドライバーは、ストレージボリュームをオンデマンドで作成できるようにし、クラスター管理者がストレージを事前にプロビジョニングする必要がなくすことで、動的ボリュームのプロビジョニングをサポートします。

Azure File CSI Driver Operator は以下をサポートしません。

  • 仮想ハードディスク (VHD)
  • Server Message Block (SMB) ファイル共有に対して連邦情報処理標準 (FIPS) モードが有効になっているノードで実行。ただし、Network File System (NFS) は FIPS モードをサポートします。

サポートされる機能の詳細は、「サポートされる CSI ドライバーおよび機能」を参照してください。

6.12.2. CSI について

Container Storage Interface (CSI) を使用すると、ストレージベンダーは Kubernetes コアコードを変更することなく、従来の組み込みストレージドライバーの代わりに、標準インターフェイスを介してプラグインを提供できます。

CSI Operator は、インツリーボリュームプラグインでは不可能なボリュームスナップショットなどのストレージオプションを OpenShift Container Platform ユーザーに付与します。

6.12.3. NFS のサポート

OpenShift Container Platform は、Network File System (NFS) を備えた Azure File Container Storage Interface (CSI) Driver Operator をサポートしています。

以下の制限が適用されます。

  • 100 GiB 未満のボリュームを作成した場合、CSI ドライバーによって 100 GiB に切り上げられます。
  • コントロールプレーンノードにスケジュールされている Azure File NFS ボリュームを含む Pod を作成すると、マウントが拒否されます。

    この問題を回避するには、コントロールプレーンノードがスケジュール可能で、Pod がワーカーノードで実行できる場合は、nodeSelector または Affinity を使用してワーカーノードで Pod をスケジュールします。

  • FS グループポリシーの動作:

    重要

    NFS を使用した Azure File CSI は、Pod によって要求された fsGroupChangePolicy を受け入れません。NFS を使用した Azure File CSI は、Pod によって要求されたポリシーに関係なく、デフォルトの OnRootMismatch FS グループポリシーを適用します。

  • Azure File CSI Operator は、NFS のストレージクラスを自動的に作成しません。手動で作成する必要があります。次のようなファイルを使用します。

    Azure File ストレージクラスの YAML ファイルの例

    apiVersion: storage.k8s.io/v1
    kind: StorageClass
    metadata:
      name: <storage-class-name>
    provisioner: file.csi.azure.com
    parameters:
      protocol: nfs
      skuName: Premium_LRS  # available values: Premium_LRS, Premium_ZRS
    mountOptions:
      - nconnect=4

  • metadata.name: ストレージクラス名を指定します。
  • provisioner: Azure File CSI プロバイダーを指定します。
  • parameters.protocol: ストレージバックエンドプロトコルとして NFS を指定します。

6.12.4. Azure File のクロスサブスクリプションサポート

クロスサブスクリプションサポートにより、1 つの Azure サブスクリプションに OpenShift Container Platform クラスターを配置し、Azure File Container Storage Interface (CSI) ドライバーを使用して、別の Azure サブスクリプションに Azure ファイル共有をマウントできるようになります。

重要

OpenShift Container Platform クラスターと Azure File 共有 (プロビジョニング済みまたはプロビジョニング予定) は両方とも同じテナント内にある必要があります。

6.12.4.1. Azure File のサブスクリプション間での動的プロビジョニング

クラスターの Azure アイデンティティーに別のサブスクリプション内のストレージアカウントへのアクセス権を付与し、ターゲットサブスクリプションを参照するストレージクラスを作成することで、Azure サブスクリプション全体で Azure File の動的プロビジョニングを有効にします。

前提条件

  • 1 つのサブスクリプション (サブスクリプション A とします) で、サービスプリンシパルまたはマネージドアイデンティティーを Azure アイデンティティーとして使用して、Azure に OpenShift Container Platform クラスターをインストールした。
  • クラスターと同じテナント内にあるストレージを持つ別のサブスクリプション (Subscription B とする) へのアクセス
  • Azure CLI にログイン済み

手順

  1. 以下から該当するコマンドを実行して、Azure アイデンティティー (サービスプリンシパルまたはマネージドアイデンティティー) を記録します。Azure アイデンティティーは後の手順で必要になります。

    • クラスターのインストール時に サービスプリンシパル を Azure アイデンティティーとして使用する場合は、以下を実行します。

      $ sp_id=$(oc -n openshift-cluster-csi-drivers get secret azure-file-credentials -o jsonpath='{.data.azure_client_id}' | base64 --decode)
      $ az ad sp show --id ${sp_id} --query displayName --output tsv
    • クラスターのインストール時に マネージドアイデンティティー を Azure アイデンティティーとして使用する場合は、以下を実行します。

      $ mi_id=$(oc -n openshift-cluster-csi-drivers get secret azure-file-credentials -o jsonpath='{.data.azure_client_id}' | base64 --decode)
      $ az identity list --query "[?clientId=='${mi_id}'].{Name:name}" --output tsv
  2. 次のいずれかの方法で、Azure File 共有のプロビジョニング先である Subscription B 内のリソースグループにアクセスするためのアクセスパーミッションを Azure アイデンティティー (サービスプリンシパルまたはマネージドアイデンティティー) に付与します。

    • 次の Azure CLI コマンドを実行します。

      az role assignment create \
        --assignee <object-id-or-app-id> \
        --role <role-name> \
        --scope /subscriptions/<subscription-id>/resourceGroups/<resource-group>/providers/Microsoft.Storage/storageAccounts/<storage-account-name>
      • <object-id-or-app-id>: 前の手順で取得したサービスプリンシパルまたはマネージドアイデンティティー (sp_id または mi_id)。
      • <role-name>: ロール名を指定します。コントリビューター、または必要なパーミッションを持つ独自のロール。
      • <subscription-id>: Subscription B の ID。
      • <resource-group-name>: Subscription B のリソースグループ名。

        または、以下を実行します。

    • Azure ポータルにログインし、左側のメニューで Resource groups をクリックします。

      1. Subscription B で、ロールを割り当てるリソースグループを選択します。そのためには、resource group Access control (IAM) Role assignments タブをクリックして現在の割り当てを表示し、Add > Add role assignment をクリックします。
      2. Role タブで、割り当てるコントリビューターロールを選択し、Next をクリックします。必要なパーミッションを持つ独自のロールを作成し、それを選択することもできます。
      3. Members タブで次の操作を行います。

        1. 割り当て先のタイプ (ユーザー、グループ、サービスプリンシパル (またはマネージドアイデンティティー)) を選択して、割り当て先を選択します。
        2. Select members をクリックします。
        3. 前の手順で記録したサービスプリンシパルまたはマネージドアイデンティティーを検索して選択します。
        4. Select をクリックして確定します。
      4. Review + assign タブで設定を確認します。
      5. Review + assign をクリックしてロールの割り当てを完了します。

        注記

        特定のストレージアカウントのみを使用して Azure File 共有をプロビジョニングする場合は、同様の手順で、ストレージアカウントにアクセスするための Azure アイデンティティー (サービスプリンシパルまたはマネージドアイデンティティー) のアクセス権を取得することもできます。

  3. 次のような設定を使用して、Azure File ストレージクラスを作成します。

    Azure File ストレージクラスの YAML ファイルの例

    allowVolumeExpansion: true
    apiVersion: storage.k8s.io/v1
    kind: StorageClass
    metadata:
      name: <sc-name>
    mount options:
      - mfsymlinks
      - cache=strict
      - nosharesock
      - actimeo=30
    parameters:
      subscriptionID: <xxxx-xxxx-xxxx-xxxx-xxxx>
      resourceGroup: <resource group name>
      storageAccount: <storage account>
      skuName: <skuName>
    provisioner: file.csi.azure.com
    reclaimPolicy: Delete
    volumeBindingMode: Immediate

    • metadata.name: ストレージクラスの名前を指定します。
    • parameters.subscriptionID: サブスクリプション B ID を指定します。
    • parameters.resourceGroup: サブスクリプション B リソースグループ名を指定します。
    • parameters.storageAccount: 独自のストレージアカウント名を指定する場合は、ストレージアカウント名を指定します。
    • parameters.skuName: SKU タイプの名前を指定します。
  4. 次のような設定を使用して、前の手順で作成した Azure File ストレージクラスを指定する永続ボリューム要求 (PVC) を作成します。

    PVC YAML ファイルの例

    apiVersion: v1
    kind: PersistentVolumeClaim
    metadata:
      name: <pvc-name>
    spec:
      storageClassName: <sc-name-cross-sub>
      accessModes:
        - ReadWriteMany
      resources:
        requests:
          storage: 5Gi

    • metadata.name: PVC の名前を指定します。
    • spec.storageClassName: 前のステップで作成したストレージクラスの名前を指定します。

ストレージ認証情報を含むシークレットを作成し、別のサブスクリプション内の Azure ファイル共有を参照する永続ボリューム (PV) および永続ボリューム要求 (PVC) を作成することで、静的プロビジョニングを使用してサブスクリプション全体に Azure File Storage をプロビジョニングします。

ストレージクラスの使用を推奨
次のサブスクリプション間の静的プロビジョニング例では、静的プロビジョニングを達成するためにストレージクラスは必要ないため、PV および PVC で参照されるストレージクラスは厳密には必要ありません。しかし、手動で作成された PVC が手動で作成された PV と意図せず一致しないために、新しい PV の動的プロビジョニングがトリガーされる可能性を回避するために、ストレージクラスを使用することが推奨されます。この問題の別の回避方法としては、provisioner: kubernetes.io/no-provisioner を使用してストレージクラスを作成するか、存在しないストレージクラスを参照できます。どちらの場合も、動的プロビジョニングは確実に実行されません。これらのストラテジーのいずれかを使用する場合、PV と PVC の不一致が発生すると PVC は保留状態のままになるため、エラーを修正できます。

前提条件

  • 1 つのサブスクリプション (サブスクリプション A とします) で、サービスプリンシパルまたはマネージドアイデンティティーを Azure アイデンティティーとして使用して、Azure に OpenShift Container Platform クラスターをインストールした。
  • クラスターと同じテナント内にあるストレージを持つ別のサブスクリプション (Subscription B とする) へのアクセス
  • Azure CLI にログイン済み

手順

  1. Azure File 共有のリソースグループ、ストレージアカウント、ストレージアカウントキー、Azure File 名を記録します。これらの値は次のステップで使用されます。
  2. 次のコマンドを実行して、永続ボリュームパラメーター spec.csi.nodeStageSecretRef.name のシークレットを作成します。

    $ oc create secret generic azure-storage-account-<storageaccount-name>-secret --from-literal=azurestorageaccountname="<azure-storage-account-name>" --from-literal azurestorageaccountkey="<azure-storage-account-key>" --type=Opaque

    <azure-storage-account-name> と <azure-storage-account-key> は、ステップ 1 でそれぞれ記録した Azure ストレージアカウントの名前とキーです。

  3. 次のサンプルファイルと同様の設定を使用して、永続ボリューム (PV) を作成します。

    PV YAML ファイルの例

    apiVersion: v1
    kind: PersistentVolume
    metadata:
      annotations:
        pv.kubernetes.io/provisioned-by: file.csi.azure.com
      name: <pv-name>
    spec:
      capacity:
        storage: 10Gi
      accessModes:
        - ReadWriteMany
      persistentVolumeReclaimPolicy: Retain
      storageClassName: <sc-name>
      mountOptions:
        - cache=strict
        - nosharesock
        - actimeo=30
        - nobrl
      csi:
        driver: file.csi.azure.com
        volumeHandle: "{resource-group-name}#{storage-account-name}#{file-share-name}"
        volumeAttributes:
          shareName: <existing-file-share-name>
        nodeStageSecretRef:
          name: <secret-name>
          namespace: <secret-namespace>

    • metadata.name: PV の名前を指定します。
    • spec.capacity.storage: PV のサイズを指定します。
    • spec.storageClassName: ストレージクラス名を指定します。
    • spec.csi.volumeHandle: volumeHandle パラメーターを指定します。クラスター内の同一の共有で、それぞれの volumeHandle が一意であることを確認します。
    • spec.csi.volumeAttributes.shareName: <existing-file-share-name>` には、ファイル共有名のみを使用し、フルパスは使用しないでください。
    • spec.csi.nodeStageSecretRef.name: 前のステップで作成したシークレット名を指定します。
    • spec.csi.nodeStageSecretRef.namespace: シークレットが存在する namespace を指定します。
  4. 次のような設定を使用して、ステップ 1 で参照された既存の Azure File 共有を指定する永続値要求 (PVC) を作成します。

    PVC YAML ファイルの例

    apiVersion: v1
    kind: PersistentVolumeClaim
    metadata:
      name: <pvc-name>
    spec:
      storageClassName: <sc-name>
      accessModes:
        - ReadWriteMany
      resources:
        requests:
          storage: 5Gi

    • metadata.name: PVC の名前を指定します。
    • spec.storageClassName: 前のステップで PV に指定したストレージクラスの名前を指定します。

6.12.5. Azure File の静的プロビジョニング

静的プロビジョニングを使用して、既存の Azure ファイル共有の永続ボリューム (PV) を手動で作成します。ストレージ認証情報を使用してシークレットを作成し、共有を参照する PV を定義し、ストレージを使用する永続ボリューム要求 (PVC) を作成します。

前提条件

  • 管理者権限を持つ OpenShift Container Platform クラスターへのアクセス

手順

  1. Azure ストレージアカウントのシークレットをまだ作成していない場合は、ここで作成します。

    このシークレットには、次の 2 つのキーと値のペアを含む非常に特殊な形式の Azure ストレージアカウント名とキーが含まれている必要があります。

    • azurestorageaccountname: <storage_account_name>
    • azurestorageaccountkey: <account_key>

      azure-secret という名前のシークレットを作成するには、次のコマンドを実行します。

      oc create secret generic azure-secret  -n <namespace_name> --type=Opaque --from-literal=azurestorageaccountname="<storage_account_name>" --from-literal=azurestorageaccountkey="<account_key>"
      • <namespace_name> は、PV が消費される namespace に設定します。
      • <storage_account_name> と <account_key> の値を指定します。
  2. 次の YAML サンプルファイルを使用して PV を作成します。

    PV YAML ファイルの例

    apiVersion: v1
    kind: PersistentVolume
    metadata:
      annotations:
        pv.kubernetes.io/provisioned-by: file.csi.azure.com
      name: pv-azurefile
    spec:
      capacity:
        storage: 5Gi
      accessModes:
        - ReadWriteMany
      persistentVolumeReclaimPolicy: Retain
      storageClassName: <sc-name>
      mountOptions:
        - dir_mode=0777
        - file_mode=0777
        - uid=0
        - gid=0
        - cache=strict
        - nosharesock
        - actimeo=30
        - nobrl
      csi:
        driver: file.csi.azure.com
        volumeHandle: "{resource-group-name}#{account-name}#{file-share-name}"
        volumeAttributes:
          shareName: EXISTING_FILE_SHARE_NAME
        nodeStageSecretRef:
          name: azure-secret
          namespace: <my-namespace>

    • spec.capacity.storage: ボリュームサイズを指定します。
    • spec.accessModes: 読み取り/書き込みおよびマウントパーミッションを定義します。詳細は、「アクセスモード」を参照してください。
    • spec.persistentVolumeReclaimPolicy: 回収ポリシーを指定します。回収ポリシーは、ボリュームがリリースされた後にどのように処理するかをクラスターに指示します。受け入れられる値は、Retain、Recycle、または Delete です。
    • spec.storageClassName: ストレージクラス名を指定します。この名前は、この特定の PV にバインドするために PVC によって使用されます。静的プロビジョニングの場合、StorageClass オブジェクトが存在する必要はありませんが、PV と PVC 内の名前は一致する必要があります。
    • spec.mountOPtions.dir_mode=0777: セキュリティーを強化する場合は、この権限を変更します。
    • spec.mountOPtions.cache: キャッシュモードを指定します。受け入れられる値は none、strict、loose です。デフォルトは strict です。
    • spec.mountOPtions..nosharesock: 再接続競合の可能性を低減するために使用します。
    • spec.mountOPtions.actimeo: CIFS クライアントがサーバーから属性情報を要求する前に、ファイルまたはディレクトリーの属性をキャッシュする時間 (秒単位)。
    • spec.mountOPtions.nobrl: サーバーへのバイト範囲ロック要求の送信を無効化し、POSIX ロックの扱いに課題を持つアプリケーションに対応します。
    • csi.volumeHandle: volumeHandle を指定します。volumeHandle がクラスター全体で一意であることを確認します。resource-group-name は、ストレージアカウントが存在する Azure リソースグループです。
    • csi.volumeAttributes.shareName: ファイル共有名を指定します。ファイル共有名のみを使用し、フルパスは使用しないでください。
    • csi.nodeStageSecretRef.name: この手順のステップ 1 で作成したシークレットの名前を指定します。この例では、azure-secret です。
    • csi.nodeStageSecretRef.namespace: シークレットが作成された namespace を指定します。これは、PV が消費される namespace である必要があります。
  3. 次のサンプルファイルを使用して、PV を参照する PVC を作成します。

    PVC YAML ファイルの例

    apiVersion: v1
    kind: PersistentVolumeClaim
    metadata:
      name: <pvc-name>
      namespace: <my-namespace>
    spec:
      volumeName: pv-azurefile
      storageClassName: <sc-name>
      accessModes:
        - ReadWriteMany
      resources:
        requests:
          storage: 5Gi

    • metadata.name: PVC 名を指定します。
    • metadata.namespace: PVC の namespace を指定します。
    • spec.volumeName: 前の手順で作成した PV の名前を指定します。
    • spec.storageClassName: ストレージクラス名を指定します。この名前は、この特定の PV にバインドするために PVC によって使用されます。静的プロビジョニングの場合、StorageClass オブジェクトが存在する必要はありませんが、PV と PVC 内の名前は一致する必要があります。
    • spec.accessModes: アクセスモードを指定します。PVC に対して要求された読み取り/書き込みアクセスを定義します。要求は、特定のアクセスモードのストレージを要求する際にボリュームと同じ規則を使用します。詳細は、「アクセスモード」を参照してください。
    • spec.resources.requests.storage: PVC サイズを指定します。
  4. 次のコマンドを実行して、PVC が作成され、しばらくしてから Bound ステータスになっていることを確認します。

    $ oc get pvc <pvc-name>

    ここで、<pvc-name> は PVC の名前です。

    出力例

    NAME       STATUS    VOLUME         CAPACITY   ACCESS MODES   STORAGECLASS   AGE
    pvc-name   Bound     pv-azurefile   5Gi        ReadWriteMany  my-sc          7m2s

6.13. Azure Stack Hub CSI Driver Operator

Azure Stack Hub Container Storage Interface (CSI) Driver Operator とドライバーを使用すると、OpenShift Container Platform で Azure Stack Hub Storage をプロビジョニングおよび管理できます。これにより、動的なボリュームプロビジョニングが可能になり、ストレージの事前プロビジョニングが不要になります。

6.13.1. Azure Stack Hub の概要

OpenShift Container Platform は、Azure Stack Hub Storage の Container Storage Interface (CSI) ドライバーを使用して永続ボリューム (PV) をプロビジョニングできます。これにより、オンプレミス環境でアプリケーションを実行し、データセンターで Azure サービスを提供できます。

CSI Operator およびドライバーを使用する場合は、永続ストレージ および CSI ボリュームの設定 を理解しておくことが推奨されます。詳細は、「永続ボリュームについて」および「CSI ボリュームの設定」を参照してください。

Azure Stack Hub ストレージアセットにマウントする CSI でプロビジョニングされた永続ボリューム (PV) を作成するには、OpenShift Container Platform は、デフォルトで Azure Stack Hub CSI Driver Operator および Azure Stack Hub CSI ドライバーを openshift-cluster-csi-drivers namespace にインストールします。

Azure Stack Hub CSI Driver Operator
Azure Stack CSI Driver Operator は、デフォルトのストレージアカウントタイプとして "Standard_LRS" が設定されたストレージクラス (managed-csi) を提供します。このストレージクラスは、永続ボリューム要求 (PVC) の作成に使用できます。Azure Stack Hub CSI Driver Operator は、ストレージボリュームをオンデマンドで作成できるようにし、クラスター管理者がストレージを事前にプロビジョニングする必要がなくすことで、動的ボリュームのプロビジョニングをサポートします。
Azure Stack Hub CSI ドライバー
Azure Stack Hub CSI ドライバーを使用すると、Azure Stack Hub PV を作成し、マウントできます。

6.13.2. CSI について

Container Storage Interface (CSI) を使用すると、ストレージベンダーは Kubernetes コアコードを変更することなく、従来の組み込みストレージドライバーの代わりに、標準インターフェイスを介してプラグインを提供できます。

CSI Operator は、インツリーボリュームプラグインでは不可能なボリュームスナップショットなどのストレージオプションを OpenShift Container Platform ユーザーに付与します。

6.14. GCP PD CSI Driver Operator

GCP PD Container Storage Interface (CSI) Driver Operator とドライバーを使用すると、OpenShift Container Platform で Google Cloud Platform (GCP) persistent disk (PD) ストレージをプロビジョニングおよび管理できます。これにより、動的なボリュームプロビジョニングが可能になり、ストレージの事前プロビジョニングが不要になります。

6.14.1. GCP PD CSI Driver Operator の概要

デフォルトでインストールされている GCP PD Container Storage Interface (CSI) Driver Operator とドライバーを使用して、OpenShift Container Platform で Google Cloud Platform (GCP) 永続ディスク (PD) ストレージをプロビジョニングおよび管理できます。

CSI Operator およびドライバーを使用する場合は、永続ストレージ および CSI ボリュームの設定 を理解しておくことが推奨されます。詳細は、「永続ストレージについて」および「CSI ボリュームの設定」を参照してください。

GCP PD ストレージアセットにマウントする CSI でプロビジョニングされた永続ボリューム (PV) を作成するには、OpenShift Container Platform はデフォルトで GCP PD CSI Driver Operator および GCP PD CSI ドライバーを openshift-cluster-csi-drivers namespace にインストールします。

GCP PD CSI Driver Operator
デフォルトで、GCP PD CSI Driver Operator は PVC の作成に使用できるストレージクラスを提供します。必要に応じて、このデフォルトのストレージクラスを無効にできます (「デフォルトストレージクラスの管理」を参照)。「GCE Persistent Disk を使用した永続ストレージ」で説明されているように、GCP PD ストレージクラスを作成するオプションもあります。
GCP PD ドライバー

GCP PD ドライバーを使用すると、GCP PD PV を作成し、マウントできます。

GCP PD CSI ドライバーは、ベアメタルおよび N4 マシンシリーズ用の C3 インスタンスタイプをサポートします。C3 インスタンスタイプと N4 マシンシリーズは、hyperdisk-balanced ディスクをサポートします。詳細は、「ベアメタルおよび N4 マシンシリーズ用の C3 インスタンスタイプ」を参照してください。

注記

OpenShift Container Platform では、GCE Persistent Disk in-tree ボリュームプラグインと同等の CSI ドライバーに自動的に移行できます。詳細は、「CSI 自動移行」を参照してください。

6.14.2. CSI について

Container Storage Interface (CSI) を使用すると、ストレージベンダーは Kubernetes コアコードを変更することなく、従来の組み込みストレージドライバーの代わりに、標準インターフェイスを介してプラグインを提供できます。

CSI Operator は、インツリーボリュームプラグインでは不可能なボリュームスナップショットなどのストレージオプションを OpenShift Container Platform ユーザーに付与します。

6.14.3. GCP PD CSI Driver Operator 使用時の権限削減

デフォルトでは、Google Cloud Platform (GCP) 永続ディスク (PD) Container Storage Interface (CSI) ドライバーが、Google Cloud プロジェクト内の任意のサービスアカウントになりすますことができます。権限の範囲を必要なノードサービスアカウントのみに縮小できます。

権限を制限するには、コントロールプレーンとコンピュートノードのサービスアカウントに iam.serviceAccountUser ロールを付与し、その後、プロジェクト全体のサービスアカウントから iam.serviceAccountUser ロールを削除して、権限の範囲を縮小します。

注記

権限の削減は、Workload Identity Federation (WIF) を使用している GCP クラスターにのみ適用されます。

手順

  1. 以下の Bash コマンドを実行して、ノードサービスアカウントにスコープ付きの iam.serviceAccountUser ロールを付与します。

    gcloud iam service-accounts add-iam-policy-binding "${MASTER_NODE_SA}" --project="${GOOGLE_PROJECT_ID}" --member="serviceAccount:${SERVICE_ACCOUNT_EMAIL}" --role="roles/iam.serviceAccountUser" --condition=None
    gcloud iam service-accounts add-iam-policy-binding "${WORKER_NODE_SA}" --project="${GOOGLE_PROJECT_ID}" --member="serviceAccount:${SERVICE_ACCOUNT_EMAIL}" --role="roles/iam.serviceAccountUser" --condition=None
    • GOOGLE_PROJECT_ID:Google Cloud プロジェクトの一意の ID。
    • SERVICE_ACCOUNT_EMAIL: 新しい権限が付与される「メンバー」 (個人またはサービスアカウント) のメールアドレス。サービスアカウントを見つけるには、WIF クラスターでは、クラスター名に基づいて CSI ドライバー用のデフォルトのサービスアカウントが GCP 上に存在します。たとえば、${CLUSTER_NAME}-openshift-gcp-pd-csi-* です。
    • MASTER_NODE_SA: クラスターのマスターノードで使用されるサービスアカウントのメールアドレス。
    • WORKER_NODE_SA: クラスターのワーカーノードが使用するサービスアカウントのメールアドレス。
  2. 以下の Bash コマンドを実行して、インストールプログラムによって作成されたバインディングからプロジェクトレベルの iam.serviceAccountUser ロールを削除します。

    gcloud projects remove-iam-policy-binding "${GOOGLE_PROJECT_ID}" --member="serviceAccount:${SERVICE_ACCOUNT_EMAIL}" --role="roles/iam.serviceAccountUser" --condition=None
    • SERVICE_ACCOUNT_EMAIL: 権限を失ったアカウントのメールアドレス。たとえば、my-app-sa@my-project.iam.gserviceaccount.com などです。サービスアカウントを見つけるには、WIF クラスターでは、クラスター名に基づいて CSI ドライバー用のデフォルトのサービスアカウントが GCP 上に存在します。たとえば、${CLUSTER_NAME}-openshift-gcp-pd-csi-* です。
    • GOOGLE_PROJECT_ID: この現象が発生している Google Cloud プロジェクトの一意の ID。たとえば、prod-data-789 です。

6.14.4. GCP PD CSI ドライバーストレージクラスパラメーター

Google Cloud Platform (GCP) 永続ディスク (PD) の永続ボリュームプロビジョニング動作を設定するには、ディスクタイプ、レプリケーション、暗号化設定を制御するストレージクラスパラメーターを使用します。

GCP PD Container Storage Interface (CSI) ドライバーは、CSI external-provisioner サイドカーをコントローラーとして使用します。これは、CSI ドライバーでデプロイされる別のヘルパーコンテナーです。サイドカーは、CreateVolume 操作をトリガーして永続ボリューム (PV) を管理します。

GCP PD CSI ドライバーは、csi.storage.k8s.io/fstype パラメーターキーを使用して動的プロビジョニングをサポートします。以下の表は、OpenShift Container Platform がサポートするすべての GCP PD CSI ストレージクラスパラメーターを説明しています。

表6.5 CreateVolume パラメーター
パラメーター値デフォルト説明

type

pd-ssd、pd-standard、pd-balanced、または hyperdisk-balanced

pd-standard

標準の PV または solid-state-drive PV を選択できます。

ドライバーは値を検証しないため、可能なすべての値が受け入れられます。

hyperdisk-balanced の場合は、「C3 および N4 インスタンスタイプの制限」セクションの制限事項を必ず確認してください。

replication-type

none または regional-pd

none

zonal またはリージョン PV を選択できます。

disk-encryption-kms-key

新規ディスクの暗号化に使用するキーの完全修飾リソース識別子。

空の文字列

顧客管理の暗号鍵 (CMEK) を使用して新規ディスクを暗号化します。

6.14.5. ベアメタル向けの C3 インスタンスタイプおよび N4 マシンシリーズ

Google Cloud Platform (GCP) C3 ベアメタルおよび N4 マシンシリーズインスタンスで hyperdisk-balanced ストレージを使用すると、高いパフォーマンスを実現できます。

6.14.5.1. C3 および N4 インスタンスタイプの制限

hyperdisk-balanced ディスクを C3 ベアメタルまたは N4 マシンシリーズインスタンスにデプロイする前に、ボリュームサイズ、クローン作成、サイズ変更、ストレージクラスの要件を確認して、設定を確実に成功させます。

ベアメタルおよび N4 マシンシリーズ用の C3 インスタンスタイプに対する GCP PD CSI ドライバーのサポートには、次の制限があります。

  • hyperdisk-balanced ディスクを作成する際は、ボリュームサイズを少なくとも 4Gi に設定する必要があります。OpenShift Container Platform は最小サイズに切り上げないので、正しいサイズを自分で指定する必要があります。
  • ストレージプールを使用する場合、ボリュームのクローン作成はサポートされません。
  • クローン作成またはサイズ変更を行うには、hyperdisk-balanced ディスクのサイズは 6Gi 以上である必要があります。
  • デフォルトストレージクラスは standard-csi です。

    重要

    ストレージクラスを手動で作成する必要があります。

    ストレージクラスの作成に関する詳細は、「hyperdisk-balanced ディスクのセットアップ」セクションのステップ 2 を参照してください。

  • N2 や N4 など、異なるストレージタイプを使用する仮想マシン (VM) が混在するクラスターはサポートされていません。これは、ハイパーディスク分散ディスクがほとんどのレガシー VM で使用できないためです。同様に、N4/C3 仮想マシンでは、通常の永続ディスクは使用できません。
  • c3-standard-2、c3-standard-4、n4-standard-2、および n4-standard-4 ノードを持つ GCP クラスターは、アタッチ可能な最大ディスク番号 (16) を誤って超過する可能性があります。詳細は、"OCPBUGS-39258" を参照してください。
  • その他の制限事項は、Google Cloud ドキュメントの "Limitations for Hyperdisk" を参照してください。

6.14.5.2. hyperdisk-balanced ディスクのストレージプールの概要

ハイパーディスクストレージプールを使用して、容量、スループット、IOPS を単一のプールに集約することで、個々のディスクを管理する代わりに、ストレージ管理を簡素化し、コストを削減できます。

ハイパーディスクストレージプールは、大規模なストレージ用に Compute Engine で使用できます。ハイパーディスクストレージプールは、購入した容量、スループット、および IOPS のコレクションであり、必要に応じてアプリケーションにプロビジョニングできます。ハイパーディスクストレージプールを使用すると、プールにディスクを作成して管理し、複数のワークロードでディスクを使用できます。ディスクをまとめて管理することで、期待される容量とパフォーマンスの向上を実現しながらコストを節約できます。ハイパーディスクストレージプールに必要なストレージのみを使用することで、数百のディスクの管理から単一のストレージプールの管理に至るまでに、容量の予測や管理の複雑さを軽減できます。

6.14.5.3. hyperdisk-balanced ディスクの設定

高性能の hyperdisk-balanced ストレージボリュームをプロビジョニングするには、ストレージクラスを設定し、永続ボリューム要求を作成して、ハイパーディスクストレージを使用するアプリケーションをデプロイします。

前提条件

  • 管理者権限でクラスターにアクセスできる。

手順

  1. hyperdisk-balanced ディスクによってプロビジョニングされたアタッチ済みディスクを使用して GCP クラスターを作成します。
  2. インストール時に hyperdisk-balanced ディスクを指定するストレージクラスを作成します。

    1. 「カスタマイズを使用した GCP へのクラスターのインストール」の手順に従います。

      install-config.yaml ファイルとして、次のサンプルファイルを使用します。

      install-config YAML ファイルの例

      apiVersion: v1
      metadata:
        name: ci-op-9976b7t2-8aa6b
      
      sshKey: |
        XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
      baseDomain: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
      platform:
        gcp:
          projectID: XXXXXXXXXXXXXXXXXXXXXX
          region: us-central1
      controlPlane:
        architecture: amd64
        name: master
        platform:
          gcp:
            type: n4-standard-4
            osDisk:
              diskType: hyperdisk-balanced
              diskSizeGB: 200
        replicas: 3
      compute:
      - architecture: amd64
        name: worker
        replicas: 3
        platform:
          gcp:
            type: n4-standard-4
            osDisk:
              diskType: hyperdisk-balanced

      • controlPlane.platform.gcp.type および compute.platform.gcp.type: ノードタイプを n4-standard-4 として指定します。
      • controlPlane.platform.gcp.osDisk.diskType および compute.platform.osDisk.diskType: ノードに hyperdisk-balanced ディスクタイプに裏付けられたルートディスクがあることを指定します。クラスター内のすべてのノードが、同じディスクタイプ (hyperdisks-balanced または pd-* のどちらか) を使用する必要があります。

        注記

        クラスター内のすべてのノードが、hyperdisk-balanced ボリュームをサポートする必要があります。hyperdisk-balanced ディスクを使用する N2 と N3 など、混合ノードを持つクラスターはサポートされていません。

    2. 「Cloud Credential Operator ユーティリティーマニフェストの組み込み」のステップ 3 の実行後、インストールプログラムによって作成されたマニフェストディレクトリーに次のマニフェストをコピーします。

      • cluster_csi_driver.yaml - デフォルトのストレージクラスを作成しないことを指定します。
      • storageclass.yaml - ハイパーディスク固有のストレージクラスを作成します。

        クラスター CSI ドライバーの YAML ファイルの例

        apiVersion: operator.openshift.io/v1
        kind: "ClusterCSIDriver"
        metadata:
          name: "pd.csi.storage.gke.io"
        spec:
          logLevel: Normal
          managementState: Managed
          operatorLogLevel: Normal
          storageClassState: Unmanaged

        spec.storageClassState は、デフォルトの OpenShift Container Platform ストレージクラスの作成を無効にすることを指定します。

        ストレージクラスの YAML ファイルの例

        apiVersion: storage.k8s.io/v1
        kind: StorageClass
        metadata:
          name: hyperdisk-sc
          annotations:
            storageclass.kubernetes.io/is-default-class: "true"
        provisioner: pd.csi.storage.gke.io
        volumeBindingMode: WaitForFirstConsumer
        allowVolumeExpansion: true
        reclaimPolicy: Delete
        parameters:
          type: hyperdisk-balanced
          replication-type: none
          provisioned-throughput-on-create: "140Mi"
          provisioned-iops-on-create: "3000"
          storage-pools: projects/my-project/zones/us-east4-c/storagePools/pool-us-east4-c
        allowedTopologies:
        - matchLabelExpressions:
          - key: topology.kubernetes.io/zone
            values:
            - us-east4-c
        ...

      • metadata.name: ストレージクラスの名前を指定します。この例では、hyperdisk-sc です。
      • provisioner: pd.csi.storage.gke.io は GCP CSI プロビジョナーを指定します。
      • parameters.type: hyperdisk-balanced ディスクの使用を指定します。
      • parameters.provisioned-throughput-on-create: "Mi" 修飾子を使用して、スループット値を MiBps 単位で指定します。たとえば、必要なスループットが 250 MiBps の場合は、"250Mi" と指定します。値を指定しない場合、ディスクタイプのデフォルトに基づいて容量が決定されます。
      • parameters.provisioned-iops-on-create: 修飾子なしで IOPS 値を指定します。たとえば、7,000 IOPS が必要な場合は、"7000" と指定します。値を指定しない場合、ディスクタイプのデフォルトに基づいて容量が決定されます。
      • parameters.storage-pools: ストレージプールを使用する場合は、使用する特定のストレージプールのリストを projects/PROJECT_ID/zones/ZONE/storagePools/STORAGE_POOL_NAME という形式で指定します。
      • parameters.allowedTopologies: ストレージプールを使用する場合は、allowedTopologies を設定して、プロビジョニングされるボリュームのトポロジーをストレージプールが存在する場所に制限します。この例では、us-east4-c です。
  3. 次のサンプル YAML ファイルを使用して、ハイパーディスク固有のストレージクラスを使用する永続ボリューム要求 (PVC) を作成します。

    PVC YAML ファイルの例

    apiVersion: v1
    kind: PersistentVolumeClaim
    metadata:
      name: my-pvc
    spec:
      storageClassName: hyperdisk-sc
      accessModes:
      - ReadWriteOnce
      resources:
        requests:
          storage: 2048Gi

    • spec.storageClassName: PVC はストレージプール固有のストレージクラスを参照します。この例では、hyperdisk-sc です。
    • spec.resources.requests.storage: hyperdisk-balanced ボリュームのターゲットストレージ容量。この例では 2048Gi です。
  4. 作成した PVC を使用するデプロイメントを作成します。デプロイメントを使用すると、Pod が再起動して再スケジュールされた後でも、アプリケーションが永続ストレージにアクセスできるようになります。

    1. デプロイメントを作成する前に、指定されたマシンシリーズのノードプールが稼働していることを確認します。稼働していない場合は、Pod はスケジュールに失敗します。
    2. 以下の YAML ファイルの例を使用してデプロイメントを作成します。

      デプロイメント YAML ファイルの例

      apiVersion: apps/v1
      kind: Deployment
      metadata:
        name: postgres
      spec:
        selector:
          matchLabels:
            app: postgres
        template:
          metadata:
            labels:
              app: postgres
          spec:
            nodeSelector:
              cloud.google.com/machine-family: n4
            containers:
            - name: postgres
              image: postgres:14-alpine
              args: [ "sleep", "3600" ]
              volumeMounts:
              - name: sdk-volume
                mountPath: /usr/share/data/
            volumes:
            - name: sdk-volume
              persistentVolumeClaim:
                claimName: my-pvc

      • spec.template.spec.nodeSelector: マシンファミリーを指定します。この例では n4 です。
      • spec.template.spec.volumes.persistentVolumeClaim.claimName: 前のステップで作成した PVC の名前を指定します。この例では my-pfc です。
    3. 以下のコマンドを実行して、デプロイメントが正常に作成されたことを確認します。

      $ oc get deployment

      出力例

      NAME       READY   UP-TO-DATE   AVAILABLE   AGE
      postgres   0/1     1            0           42s

      ハイパーディスクインスタンスがプロビジョニングを完了し、READY ステータスが表示されるまで数分かかる場合があります。

    4. 次のコマンドを実行して、PVC my-pvc が永続ボリューム (PV) に正常にバインドされていることを確認します。

      $ oc get pvc my-pvc

      出力例

      NAME          STATUS   VOLUME                                     CAPACITY   ACCESS MODES   STORAGECLASS       VOLUMEATTRIBUTESCLASS  AGE
      my-pvc        Bound    pvc-1ff52479-4c81-4481-aa1d-b21c8f8860c6   2Ti        RWO            hyperdisk-sc       <unset>                2m24s

    5. hyperdisk-balanced ディスクの想定の設定を確認します。

      $ gcloud compute disks list

      出力例

      NAME                                        LOCATION        LOCATION_SCOPE  SIZE_GB  TYPE                STATUS
      instance-20240914-173145-boot               us-central1-a   zone            150      pd-standard         READY
      instance-20240914-173145-data-workspace     us-central1-a   zone            100      pd-balanced         READY
      c4a-rhel-vm                                 us-central1-a   zone            50       hyperdisk-balanced  READY

      ここでの c4a-rhel.vm は、hyperdisk-balanced ディスクになります。

    6. ストレージプールを使用している場合は、次のコマンドを実行して、ボリュームがストレージクラスと PVC で指定されたとおりにプロビジョニングされていることを確認します。

      $ gcloud compute storage-pools list-disks pool-us-east4-c --zone=us-east4-c

      出力例

      NAME                                      STATUS  PROVISIONED_IOPS  PROVISIONED_THROUGHPUT  SIZE_GB
      pvc-1ff52479-4c81-4481-aa1d-b21c8f8860c6  READY   3000              140                     2048

6.14.6. カスタムで暗号化された永続ボリュームの作成

デフォルトの暗号化よりもデータセキュリティーを強化するには、暗号化制御に Google Cloud Key Management Service を利用するお客様管理暗号鍵 (CMEK) を使用して永続ボリュームを作成します。

PersistentVolumeClaim オブジェクトの作成時に、OpenShift Container Platform は新規永続ボリューム (PV) をプロビジョニングし、PersistentVolume オブジェクトを作成します。新規に作成された PV を暗号化することで、Google Cloud Platform (GCP) にカスタム暗号化キーを追加し、クラスター内の PV を保護することができます。

暗号化の場合、作成した新たに割り当てられる PV は、新規または既存の Google Cloud Key Management Service (KMS) キーを使用してクラスターで顧客管理の暗号鍵 (CMEK) を使用します。

前提条件

  • 実行中の OpenShift Container Platform クラスターにログインしている。
  • Cloud KMS キーリングとキーのバージョンを作成している。

CMEK および Cloud KMS リソースの詳細については、Google Cloud のドキュメントの "Using customer-managed encryption keys (CMEK)" を参照してください。

手順

  1. Cloud KMS キーを使用してストレージクラスを作成します。以下の例では、暗号化されたボリュームの動的プロビジョニングを有効にします。

    例

    apiVersion: storage.k8s.io/v1
    kind: StorageClass
    metadata:
      name: csi-gce-pd-cmek
    provisioner: pd.csi.storage.gke.io
    volumeBindingMode: "WaitForFirstConsumer"
    allowVolumeExpansion: true
    parameters:
      type: pd-standard
      disk-encryption-kms-key: projects/<key-project-id>/locations/<location>/keyRings/<key-ring>/cryptoKeys/<key>

    parameters.disk-encryption-kms-key フィールドは、新規ディスクの暗号化に使用されるキーのリソース ID である必要があります。値では、大文字と小文字が区別されます。キー ID の値を指定する方法に関する詳細は、Google Cloud ドキュメントの "Retrieving a resource’s ID" and "Getting a Cloud KMS resource ID" を参照してください。

    注記

    disk-encryption-kms-key パラメーターは既存のストレージクラスに追加することはできません。ただし、ストレージクラスを削除し、同じ名前および異なるパラメーターセットでこれを再作成できます。これを実行する場合、既存クラスのプロビジョナーは pd.csi.storage.gke.io である必要があります。

  2. oc コマンドを使用して、ストレージクラスを OpenShift Container Platform クラスターにデプロイします。

    $ oc describe storageclass csi-gce-pd-cmek

    出力例

    Name:                  csi-gce-pd-cmek
    IsDefaultClass:        No
    Annotations:           None
    Provisioner:           pd.csi.storage.gke.io
    Parameters:            disk-encryption-kms-key=projects/key-project-id/locations/location/keyRings/ring-name/cryptoKeys/key-name,type=pd-standard
    AllowVolumeExpansion:  true
    MountOptions:          none
    ReclaimPolicy:         Delete
    VolumeBindingMode:     WaitForFirstConsumer
    Events:                none

  3. 直前の手順で作成したストレージクラスオブジェクトの名前に一致する pvc.yaml という名前のファイルを作成します。

    kind: PersistentVolumeClaim
    apiVersion: v1
    metadata:
      name: podpvc
    spec:
      accessModes:
        - ReadWriteOnce
      storageClassName: csi-gce-pd-cmek
      resources:
        requests:
          storage: 6Gi
    注記

    新規ストレージクラスをデフォルトとしてマークした場合は、storageClassName フィールドを省略できます。

  4. PVC をクラスターに適用します。

    $ oc apply -f pvc.yaml
  5. PVC のステータスを取得し、これが作成され、新規にプロビジョニングされた PV にバインドされていることを確認します。

    $ oc get pvc

    出力例

    NAME      STATUS    VOLUME                                     CAPACITY   ACCESS MODES   STORAGECLASS     AGE
    podpvc    Bound     pvc-e36abf50-84f3-11e8-8538-42010a800002   10Gi       RWO            csi-gce-pd-cmek  9s

    注記

    ストレージクラスで volumeBindingMode フィールドが WaitForFirstConsumer に設定されている場合、これを検証する前に PVC を使用するために Pod を作成する必要があります。

    CMEK で保護される PV が OpenShift Container Platform クラスターで使用できるようになります。

6.14.7. ユーザー管理型の暗号化

ユーザー管理型の暗号化機能を使用すると、インストール時に OpenShift Container Platform ノードのルートボリュームを暗号化するキーを指定でき、すべてのマネージドストレージクラスはこれらのキーを使用してプロビジョニングされたストレージボリュームを暗号化できます。

install-config YAML ファイルの platform.<cloud_type>.defaultMachinePlatform フィールドにカスタムキーを指定する必要があります。

この機能は、次のストレージタイプをサポートします。

  • Amazon Web Services (AWS) Elastic Block storage (EBS)

    注記

    ストレージクラスに暗号化キーが定義されていない場合は、ストレージクラスに encrypted: "true" のみを設定します。AWS EBS CSI ドライバーは、AWS 管理の alias/aws/ebs を使用します。これは、プロビジョニングされたストレージボリュームを暗号化するために、デフォルトで各リージョンで Amazon EBS によって自動的に作成されます。さらに、マネージドストレージクラスはすべて encrypted: "true" 設定になっています。

    AWS EBS のユーザー管理の暗号化を使用したインストールの詳細は、オプションの AWS 設定パラメーター を参照してください。

  • Microsoft Azure Disk ストレージ

    注記

    OS (ルート) ディスクが暗号化されており、ストレージクラスに暗号化キーが定義されていない場合、Azure Disk CSI ドライバーは、デフォルトで OS ディスク暗号化キーを使用して、プロビジョニングされたストレージボリュームを暗号化します。

    ユーザー管理暗号化を使用した Azure Disk のインストールの詳細は、「Azure Disk 暗号化セットの準備」を参照してください。

  • Google Cloud Platform (GCP) 永続ディスク (PD) ストレージ

    ユーザー管理暗号化を使用した GCP PD のインストールの詳細は、「その他の Google Cloud 設定パラメーター」を参照してください。

  • IBM Cloud® Virtual Private Cloud (VPC) Block ストレージ

    IBM Cloud のユーザー管理型の暗号化を使用したインストールの詳細は、IBM Cloud のユーザー管理型の暗号化 および IBM Cloud へのインストール を参照してください。

6.15. Google Cloud Filestore CSI Driver Operator

Google Cloud Platform (GCP) Filestore Container Storage Interface (CSI) Driver Operator は、動的ボリュームプロビジョニングを使用して OpenShift Container Platform の GCP Filestore Storage をプロビジョニングおよび管理するため、ストレージを事前にプロビジョニングする必要がありません。

6.15.1. 概要

OpenShift Container Platform は、Google Compute Platform (GCP) Filestore Storage の Container Storage Interface (CSI) ドライバーを使用して永続ボリューム (PV) をプロビジョニングできます。

CSI Operator およびドライバーを使用する場合は、永続ストレージ および CSI ボリュームの設定 を理解しておくことが推奨されます。詳細は、「永続ストレージについて」および「CSI ボリュームの設定」を参照してください。

Google Cloud Filestore のストレージアセットにマウントする、CSI によってプロビジョニングされた PV を作成するために、openshift-cluster-csi-drivers namespace に、Google Cloud Filestore CSI Driver Operator と Google Cloud Filestore CSI Driver をインストールします。

  • Google Cloud Filestore CSI Driver Operator はデフォルトでストレージクラスを提供しませんが、必要に応じてストレージクラスを作成できます (詳細は、「GCP Filestore ストレージのストレージクラスの作成」を参照してください)。Google Cloud Filestore CSI Driver Operator は、ストレージボリュームをオンデマンドで作成可能にすることで、動的なボリュームプロビジョニングをサポートしています。これにより、クラスター管理者がストレージを事前にプロビジョニングする必要がなくなります。
  • Google Cloud Filestore CSI ドライバー を使用すると、Google Cloud Filestore PV を作成してマウントできます。

OpenShift Container Platform Google Cloud Filestore は、Workload Identity をサポートしています。これにより、ユーザーはサービスアカウントキーの代わりにフェデレーションアイデンティティーを使用して Google Cloud リソースにアクセスできます。GCP Workload Identity は、インストール時にグローバルに有効にしてから、Google Cloud Filestore CSI Driver Operator 用に設定する必要があります。

6.15.2. CSI について

Container Storage Interface (CSI) を使用すると、ストレージベンダーは Kubernetes コアコードを変更することなく、従来の組み込みストレージドライバーの代わりに、標準インターフェイスを介してプラグインを提供できます。

CSI Operator は、インツリーボリュームプラグインでは不可能なボリュームスナップショットなどのストレージオプションを OpenShift Container Platform ユーザーに付与します。

6.15.3. Google Cloud Filestore CSI Driver Operator のインストール

Google コンピュートプラットフォーム (Google Cloud) Filestore Container Storage Interface (CSI) Driver Operator は、デフォルトでは OpenShift Container Platform にインストールされていないため、クラスターに Google Cloud Filestore CSI Driver Operator をインストールする必要があります。

6.15.3.1. Workload Identity を使用して Google Cloud Filestore CSI Driver Operator をインストールする準備

GCP Workload Identity を Google Compute Platform Filestore とともに使用する予定の場合は、Google Cloud Filestore Container Storage Interface (CSI) Driver Operator のインストール中に使用する特定のパラメーターを取得する必要があります。

前提条件

  • cluster-admin ロールを持つユーザーとしてクラスターにアクセスできる。

手順

  1. プロジェクト番号を取得します。

    1. 以下のコマンドを実行してプロジェクト ID を取得します。

      $ export PROJECT_ID=$(oc get infrastructure/cluster -o jsonpath='{.status.platformStatus.gcp.projectID}')
    2. 以下のコマンドを実行し、プロジェクト ID を使用してプロジェクト番号を取得します。

      $ gcloud projects describe $PROJECT_ID --format="value(projectNumber)"
  2. ID プール ID とプロバイダー ID を検索します。

    クラスターのインストール中に、これらのリソースの名前は、--name parameter を使用して Cloud Credential Operator ユーティリティー (ccoctl) に渡されます。「Cloud Credential Operator ユーティリティーを使用した Google Cloud リソースの作成」を参照してください。

  3. Google Cloud Filestore Operator 用の Workload Identity リソースを作成します。

    1. 次のサンプルファイルを使用して CredentialsRequest ファイルを作成します。

      Credentials Request YAML ファイルの例

      apiVersion: cloudcredential.openshift.io/v1
      kind: CredentialsRequest
      metadata:
        name: openshift-gcp-filestore-csi-driver-operator
        namespace: openshift-cloud-credential-operator
        annotations:
          include.release.openshift.io/self-managed-high-availability: "true"
          include.release.openshift.io/single-node-developer: "true"
      spec:
        serviceAccountNames:
        - gcp-filestore-csi-driver-operator
        - gcp-filestore-csi-driver-controller-sa
        secretRef:
          name: gcp-filestore-cloud-credentials
          namespace: openshift-cluster-csi-drivers
        providerSpec:
          apiVersion: cloudcredential.openshift.io/v1
      	kind: GCPProviderSpec
          predefinedRoles:
          - roles/file.editor
          - roles/resourcemanager.tagUser
          skipServiceCheck: true

    2. 次のコマンドを実行して、CredentialsRequest ファイルを使用して Google Cloud サービスアカウントを作成します。

      $ ./ccoctl gcp create-service-accounts --name=<filestore-service-account> \//
        --workload-identity-pool=<workload-identity-pool> \//
        --workload-identity-provider=<workload-identity-provider> \//
        --project=<project-id> \//
        --credentials-requests-dir=/tmp/credreq
      • <filestore-service-account> は、ユーザーが選択した名前です。
      • <workload-アイデンティティープール> は、上記のステップ 2 から取得されます。
      • <workload-identity-provider> は、上記のステップ 2 から取得されます。
      • <project-id> は上記のステップ 1.a から取得されます。
      • credentials-requests-dir は、CredentialsRequest ファイルが存在するディレクトリーの名前です。

      出力例

      2025/02/10 17:47:39 Credentials loaded from gcloud CLI defaults
      2025/02/10 17:47:42 IAM service account filestore-service-account-openshift-gcp-filestore-csi-driver-operator created
      2025/02/10 17:47:44 Unable to add predefined roles to IAM service account, retrying...
      2025/02/10 17:47:59 Updated policy bindings for IAM service account filestore-service-account-openshift-gcp-filestore-csi-driver-operator
      2025/02/10 17:47:59 Saved credentials configuration to: /tmp/install-dir/
      openshift-cluster-csi-drivers-gcp-filestore-cloud-credentials-credentials.yaml

      ここで、/tmp/install-dir/ はカレントディレクトリーです。

    3. 次のコマンドを実行して、新しく作成されたサービスアカウントのサービスアカウントメールを見つけます。

      $ cat /tmp/install-dir/manifests/openshift-cluster-csi-drivers-gcp-filestore-cloud-credentials-credentials.yaml | yq '.data["service_account.json"]' | base64 -d | jq '.service_account_impersonation_url'

      出力例

      https://iamcredentials.googleapis.com/v1/projects/-/serviceAccounts/filestore-se-openshift-g-ch8cm@openshift-gce-devel.iam.gserviceaccount.com:generateAccessToken

      この出力例では、サービスアカウントのメールは filestore-se-openshift-g-ch8cm@openshift-gce-devel.iam.gserviceaccount.com です。

結果

これで、Google Cloud Filestore CSI Driver Operator をインストールするために必要な次のパラメーターの準備ができました。

  • プロジェクト番号 - ステップ 1.b
  • プール ID - ステップ 2
  • プロバイダー ID - ステップ 2
  • サービスアカウントのメールアドレス - ステップ 3.c

6.15.3.2. Google Cloud Filestore CSI Driver Operator のインストール

Google コンピュートプラットフォーム (Google Cloud) Filestore Container Storage Interface (CSI) Driver Operator は、デフォルトでは OpenShift Container Platform にインストールされていないため、クラスターに Google Cloud Filestore CSI Driver Operator をインストールする必要があります。

前提条件

  • OpenShift Container Platform Web コンソールにアクセスできる。
  • GCP Workload Identity を使用する場合は、GCP Workload Identity の特定のパラメーターがある。前述のセクション Workload Identity を使用して Google Cloud Filestore CSI Driver Operator をインストールする準備 を参照してください。

手順

  1. Web コンソールにログインします。
  2. 次のコマンドを実行して、GCE プロジェクトで Filestore API を有効にします。

    $ gcloud services enable file.googleapis.com  --project <my_gce_project>

    <my_gce_project> を Google Cloud プロジェクトに置き換えます。

    これは、Google Cloud Web コンソールを使用して行うこともできます。

  3. Google Cloud Filestore CSI Operator をインストールします。

    1. Ecosystem Software Catalog をクリックします。
    2. フィルターボックスに Google Cloud Filestore と入力して、Google Cloud Filestore CSI Operator を見つけます。
    3. Google Cloud Filestore CSI Driver Operator ボタンをクリックします。
    4. Google Cloud Filestore CSI Driver Operator ページで、Install をクリックします。
    5. Install Operator のページで、以下のことを確認してください。

      • All namespaces on the cluster (default) が選択されている。
      • Installed Namespace が openshift-cluster-csi-drivers に設定されている。

        GCP Workload Identity を使用する場合は、Workload Identity を使用した Google Cloud Filestore CSI Driver Operator のインストールの準備 セクションの手順で取得した次のフィールドの値を入力します。

      • Google Cloud Project Number
      • Google Cloud Pool ID
      • Google Cloud Provider ID
      • Google Cloud Service Account Email
    6. Install をクリックします。

      インストールが完了すると、Google Cloud Filestore CSI Operator が Web コンソールの Installed Operators セクションに表示されます。

  4. Google Cloud Filestore CSI Driver をインストールします。

    1. administration CustomResourceDefinitions ClusterCSIDriver をクリックします。
    2. Instances タブで Create ClusterCSIDriver をクリックします。

      以下の YAML ファイルを使用します。

      apiVersion: operator.openshift.io/v1
      kind: ClusterCSIDriver
      metadata:
          name: filestore.csi.storage.gke.io
      spec:
        managementState: Managed
    3. Create をクリックします。
    4. 以下の条件が "true" に変わるのを待ちます。

      • GCPFilestoreDriverCredentialsRequestControllerAvailable
      • GCPFilestoreDriverNodeServiceControllerAvailable
      • GCPFilestoreDriverControllerServiceControllerAvailable

6.15.4. GCP Filestore Storage のストレージクラスの作成

GCP Filestore ボリュームの動的プロビジョニングを有効にするには、VPC ネットワーク設定と接続モード設定を指定するストレージクラスを作成します。

Google コンピュートプラットフォーム (GCP) Filestore ボリュームの動的プロビジョニング用のストレージクラスを作成する前に、Operator がインストールされていることを確認します。

前提条件

  • 実行中の OpenShift Container Platform クラスターにログインしている。

手順

  1. 次のサンプル YAML ファイルを使用してストレージクラスを作成します。

    サンプル YAML ファイル

    kind: StorageClass
    apiVersion: storage.k8s.io/v1
    metadata:
      name: filestore-csi
    provisioner: filestore.csi.storage.gke.io
    parameters:
      connect-mode: DIRECT_PEERING
      network: network-name
    allowVolumeExpansion: true
    volumeBindingMode: WaitForFirstConsumer

    • parameters.connect-mode: 共有 VPC の場合は、connect-mode パラメーターを PRIVATE_SERVICE_ACCESS に設定して使用します。非共有 VPC の場合、この値はデフォルト設定の DIRECT_PEERING になります。
    • parameters.network: Filestore インスタンスを作成する GCP Virtual Private Cloud (VPC) ネットワークの名前を指定します。
  2. Filestore インスタンスを作成する VPC ネットワークの名前を指定します。

    Filestore インスタンスを作成する VPC ネットワークを指定することを推奨します。VPC ネットワークが指定されていないと、Container Storage Interface (CSI) ドライバーは、プロジェクトのデフォルト VPC ネットワークにインスタンスを作成しようとします。

    IPI インストールでは、VPC ネットワーク名は通常、クラスター名に接尾辞 "-network" を付けたものです。ただし、UPI インストールでは、VPC ネットワーク名はユーザーが選択した任意の値にすることができます。

    共有 VPC (connect-mode = PRIVATE_SERVICE_ACCESS) の場合、ネットワークは完全な VPC 名である必要があります。たとえば projects/shared-vpc-name/global/networks/gcp-filestore-network です。

    次のコマンドを使用して MachineSets オブジェクトを調べると、VPC ネットワーク名を確認できます。

    $ oc -n openshift-machine-api get machinesets -o yaml | grep "network:"
                - network: gcp-filestore-network
    (...)

    この例では、このクラスターの VPC ネットワーク名は "gcp-filestore-network" です。

6.15.5. NFS エクスポートオプション

デフォルトのプロジェクト全体の権限を超えて Google Cloud Filestore ボリュームへのアクセスを制限するには、IP 範囲とユーザー/グループ ID によってアクセスを制限する NFS エクスポートオプションを設定します。

デフォルトでは、Filestore インスタンスは、同じ Google Cloud プロジェクトと Virtual Private Cloud (VPC) ネットワークを共有するすべてのクライアントにルートレベルの読み取り/書き込みアクセス権を付与します。ネットワークファイルシステム (NFS) エクスポートオプションを使用すると、Filestore インスタンスの特定の IP 範囲と特定のユーザー/グループ ID へのアクセスを制限できます。ストレージクラスを作成するときに、nfs-export-options-on-create パラメーターを使用して、これらのオプションを設定できます。

前提条件

  • cluster-admin ロールを持つユーザーとしてクラスターにアクセスできる。
  • Google Cloud Filestore CSI Driver Operator と Google Cloud Filestore CSI Driver がインストールされている。

手順

  1. 次のサンプル YAML ファイルのようなファイルを使用してストレージクラスを作成します。

    注記

    ストレージクラスの作成の詳細は、GCP Filestore Operator のストレージクラスの作成 セクションを参照してください。

    NFS エクスポートオプションが含まれるストレージクラス YAML ファイルの例

    kind: StorageClass
    apiVersion: storage.k8s.io/v1
    metadata:
     name: SC-name
    provisioner: filestore.csi.storage.gke.io
    parameters:
     connect-mode: DIRECT_PEERING
     network: project-network
     nfs-export-options-on-create: '[
       {
         "accessMode": "READ_WRITE",
         "squashMode": "NO_ROOT_SQUASH",
         "anonUid": 65534
         "anonGid": 65534
         "ipRanges": [
           "10.0.0.0/16"
         ]
       }]'
    allowVolumeExpansion: true

    parameters.nfs-export-options-on-create 引数の場合:

    • AccessMode: エクスポートされたディレクトリーに対する読み取り要求のみを許可する READ_ONLY、または読み取り要求と書き込み要求の両方を許可する READ_WRITE のいずれか。デフォルトは READ_WRITE です。
    • SquashMode: エクスポートされたディレクトリーでのルートアクセスを許可する NO_ROOT_SQUASH、またはルートアクセスを許可しない ROOT_SQUASH のいずれか。デフォルトは NO_ROOT_SQUASH です。
    • AnonUid: 匿名ユーザー ID を表す整数。デフォルト値は 65534 です。AnonUid は、squashMode を ROOT_SQUASH に設定した場合にのみ設定できます。それ以外の場合は、エラーが発生します。
    • AnonGid: 匿名グループ ID を表す整数。デフォルト値は 65534 です。AnonGid は、
    • ipRanges: ファイル共有をマウントできる、{octet1}.{octet2}.{octet3}.{octet4} 形式の IPv4 アドレスのリスト、または {octet1}.{octet2}.{octet3}.{octet4}/{mask size} 形式の CIDR 範囲のリスト。NfsExportOptions 内および NfsExportOptions 間で重複する IP 範囲は許可されません。許可されない場合、エラーが返されます。すべての NFS エクスポートオプションで、FileShareConfig ごとの IP 範囲またはアドレスは 64 個に制限されています。

6.15.6. クラスターと GCP Filestore の破棄

孤立したリソースと潜在的なコストを防ぐには、クラスターの破棄後にすべての Google Cloud Filestore リソースが削除されることを確認します。自動クリーンアップではすべてのリソースが削除されない可能性があります。

通常、クラスターを破棄すると、OpenShift Container Platform インストーラーはそのクラスターに属するすべてのクラウドリソースを削除します。ただし、Google Compute Platform (GCP) Filestore リソースの特殊な性質により、自動クリーンアッププロセスでは、すべてのリソースが削除されない場合がまれに発生します。

したがって、Red Hat では、アンインストールプロセスによってクラスター所有のすべての Filestore リソースが削除済みであることを確認するよう推奨しています。

手順

  1. GUI または CLI を使用して Google Cloud アカウントにアクセスします。
  2. kubernetes-io-cluster-${CLUSTER_ID}=owned ラベルを持つリソースを検索します。

    クラスター ID は削除されたクラスターに固有であるため、そのクラスター ID を持つリソースは残っていないはずです。

  3. 万が一リソースが残っている場合は、削除してください。

6.16. IBM Cloud® VPC Block CSI Driver Operator

OpenShift Container Platform で IBM Cloud® Virtual Private Cloud (VPC) Block Storage をプロビジョニングおよび管理するには、動的ボリュームプロビジョニングを提供する IBM Cloud® VPC Block Container Storage Interface (CSI) Driver Operator とドライバーを使用します。

6.16.1. IBM Cloud® VPC Block CSI Driver Operator の概要

Container Storage Interface (CSI) ドライバーを使用すると、IBM Cloud® Virtual Private Cloud (VPC) インフラストラクチャー上でブロックストレージボリュームを動的にプロビジョニングできます。CSI ドライバーは、ワークロードのパフォーマンス要件に合わせて複数の IOPS 階層をサポートします。

CSI Operator およびドライバーを使用する場合は、永続ストレージ および CSI ボリュームの設定 を理解しておくことが推奨されます。詳細は、「永続ストレージについて」および「CSI ボリュームの設定」を参照してください。

IBM Cloud® VPC Block ストレージアセットにマウントする CSI でプロビジョニングされた永続ボリューム (PV) を作成するには、OpenShift Container Platform は、デフォルトで IBM Cloud® VPC Block CSI Driver Operator および IBM Cloud® VPC Block CSI ドライバーを openshift-cluster-csi-drivers namespace にインストールします。

IBM Cloud® VPC Block CSI Driver Operator
IBM Cloud® VPC Block CSI Driver Operator は、永続ボリューム要求 (PVC) の作成に使用できる異なるレイヤー用に、ibmc-vpc-block-10iops-tier (デフォルト)、ibmc-vpc-block-5iops-tier、および ibmc-vpc-block-custom という 3 つのストレージクラスを提供します。IBM Cloud® VPC Block CSI Driver Operator は、ストレージボリュームをオンデマンドで作成できるようにすることで動的なボリュームプロビジョニングをサポートするので、クラスター管理者はストレージを事前にプロビジョニングする必要がありません。必要に応じて、このデフォルトのストレージクラスを無効にできます (「デフォルトストレージクラスの管理」を参照)。
IBM Cloud® VPC Block CSI ドライバー
IBM Cloud® VPC Block CSI ドライバー を使用すると、IBM Cloud® VPC Block PV を作成してマウントできます。

6.16.2. CSI について

Container Storage Interface (CSI) を使用すると、ストレージベンダーは Kubernetes コアコードを変更することなく、従来の組み込みストレージドライバーの代わりに、標準インターフェイスを介してプラグインを提供できます。

CSI Operator は、インツリーボリュームプラグインでは不可能なボリュームスナップショットなどのストレージオプションを OpenShift Container Platform ユーザーに付与します。

6.16.3. ユーザー管理型の暗号化

ユーザー管理型の暗号化機能を使用すると、インストール時に OpenShift Container Platform ノードのルートボリュームを暗号化するキーを指定でき、すべてのマネージドストレージクラスはこれらのキーを使用してプロビジョニングされたストレージボリュームを暗号化できます。

install-config YAML ファイルの platform.<cloud_type>.defaultMachinePlatform フィールドにカスタムキーを指定する必要があります。

この機能は、次のストレージタイプをサポートします。

  • Amazon Web Services (AWS) Elastic Block storage (EBS)

    注記

    ストレージクラスに暗号化キーが定義されていない場合は、ストレージクラスに encrypted: "true" のみを設定します。AWS EBS CSI ドライバーは、AWS 管理の alias/aws/ebs を使用します。これは、プロビジョニングされたストレージボリュームを暗号化するために、デフォルトで各リージョンで Amazon EBS によって自動的に作成されます。さらに、マネージドストレージクラスはすべて encrypted: "true" 設定になっています。

    AWS EBS のユーザー管理の暗号化を使用したインストールの詳細は、オプションの AWS 設定パラメーター を参照してください。

  • Microsoft Azure Disk ストレージ

    注記

    OS (ルート) ディスクが暗号化されており、ストレージクラスに暗号化キーが定義されていない場合、Azure Disk CSI ドライバーは、デフォルトで OS ディスク暗号化キーを使用して、プロビジョニングされたストレージボリュームを暗号化します。

    ユーザー管理暗号化を使用した Azure Disk のインストールの詳細は、「Azure Disk 暗号化セットの準備」を参照してください。

  • Google Cloud Platform (GCP) 永続ディスク (PD) ストレージ

    ユーザー管理暗号化を使用した GCP PD のインストールの詳細は、「その他の Google Cloud 設定パラメーター」を参照してください。

  • IBM Cloud® Virtual Private Cloud (VPC) Block ストレージ

    IBM Cloud のユーザー管理型の暗号化を使用したインストールの詳細は、IBM Cloud のユーザー管理型の暗号化 および IBM Cloud へのインストール を参照してください。

6.17. IBM Power Virtual Server Block CSI Driver Operator

OpenShift Container Platform で IBM Power® Virtual Server Block ストレージをプロビジョニングおよび管理するには、動的ボリュームプロビジョニングを提供する Container Storage Interface (CSI) Driver Operator と Driver を使用します。

6.17.1. IBM Power® Virtual Server Block CSI Driver Operator の概要

IBM Power® Virtual Server Block CSI ドライバーは、IBM Power® Virtual Server Block CSI Driver Operator を通じてインストールされ、その Operator は library-go をベースとしています。

OpenShift Container Platform library-go フレームワークは、ユーザーによる OpenShift Operator の構築を容易にする関数のコレクションです。CSI Driver Operator の機能のほとんどは、このコレクションで提供されています。IBM Power® Virtual Server Block CSI Driver Operator は、Cluster Storage Operator によってインストールされます。プラットフォームのタイプが Power Virtual Servers の場合、Cluster Storage Operator は IBM Power® Virtual Server Block CSI Driver Operator をインストールします。

6.17.2. IBM Power® Virtual Server Block CSI Driver Operator の概要

OpenShift Container Platform は、IBM Power® Virtual Server Block Storage の Container Storage Interface (CSI) ドライバーを使用して永続ボリューム (PV) をプロビジョニングできます。

CSI Operator およびドライバーを使用する場合、永続ストレージ および CSI ボリュームの設定 を理解しておくことが推奨されます。詳細は、「永続ストレージについて」および「CSI ボリュームの設定」を参照してください。

IBM Power® Virtual Server Block アセットにマウントする CSI でプロビジョニングされた永続ボリューム (PV) を作成するには、OpenShift Container Platform は、デフォルトで IBM Power® Virtual Server Block CSI Driver Operator および IBM Power® Virtual Server Block CSI ドライバーを openshift-cluster-csi-drivers namespace にインストールします。

  • IBM Power® Virtual Server ブロック CSI Driver Operator は、永続ボリューム要求 (PVC) の作成に使用できる、ibm-powervs-tier1 (デフォルト) とさまざまな層用の ibm-powervs-tier3 という名前の 2 つのストレージクラスを提供します。IBM Power® Virtual Server Block CSI Driver Operator は、ストレージボリュームをオンデマンドで作成できるようにすることで動的なボリュームプロビジョニングをサポートするので、クラスター管理者はストレージを事前にプロビジョニングする必要がありません。
  • IBM Power® Virtual Server Block CSI ドライバー を使用すると、IBM Power® Virtual Server Block PV を作成およびマウントできます。

6.17.3. CSI について

Container Storage Interface (CSI) を使用すると、ストレージベンダーは Kubernetes コアコードを変更することなく、従来の組み込みストレージドライバーの代わりに、標準インターフェイスを介してプラグインを提供できます。

CSI Operator は、インツリーボリュームプラグインでは不可能なボリュームスナップショットなどのストレージオプションを OpenShift Container Platform ユーザーに付与します。

6.18. OpenStack Cinder CSI Driver Operator

OpenShift Container Platform で OpenStack Cinder ストレージをプロビジョニングおよび管理するには、動的ボリュームプロビジョニングを提供する OpenStack Cinder Container Storage Interface (CSI) Driver Operator と Driver を使用します。

6.18.1. 概要

OpenShift Container Platform は、OpenStack Cinder の Container Storage Interface (CSI) ドライバーを使用して永続ボリューム (PV) をプロビジョニングできます。

CSI Operator およびドライバーを使用する場合は、永続ストレージ および CSI ボリュームの設定 を理解しておくことが推奨されます。詳細は、「永続ストレージについて」および「CSI ボリュームの設定」を参照してください。

OpenStack Cinder ストレージアセットにマウントする CSI でプロビジョニングされる PV を作成するには、OpenShift Container Platform は openshift-cluster-csi-drivers namespace に OpenStack Cinder CSI Driver Operator および OpenStack Cinder CSI ドライバーをインストールします。

  • OpenStack Cinder CSI Driver Operator は、PVC の作成に使用できる CSI ストレージクラスを提供します。必要に応じて、このデフォルトのストレージクラスを無効にできます (「デフォルトストレージクラスの管理」を参照)。
  • OpenStack Cinder CSI ドライバー を使用すると、OpenStack Cinder PV を作成し、マウントすることができます。
注記

OpenShift Container Platform では、Cinder インツリーボリュームプラグインと同等の CSI ドライバーに自動的に移行できます。詳細は、「CSI 自動移行」を参照してください。

重要

OpenShift Container Platform は、デフォルトで CSI プラグインを使用して Cinder ストレージをプロビジョニングします。

6.18.2. CSI について

Container Storage Interface (CSI) を使用すると、ストレージベンダーは Kubernetes コアコードを変更することなく、従来の組み込みストレージドライバーの代わりに、標準インターフェイスを介してプラグインを提供できます。

CSI Operator は、インツリーボリュームプラグインでは不可能なボリュームスナップショットなどのストレージオプションを OpenShift Container Platform ユーザーに付与します。

6.18.3. OpenStack Cinder CSI をデフォルトのストレージクラスに設定する

動的プロビジョニングにツリー内ドライバーの代わりに OpenStack Cinder Container Storage Interface (CSI) ドライバーを使用するには、ストレージクラスのアノテーションを更新して、デフォルトのストレージクラスを standard から standard-csi に変更します。

OpenStack Cinder CSI ドライバーは、cinder.csi.openstack.org パラメーターキーを使用して動的プロビジョニングをサポートします。

OpenShift Container Platform で OpenStack Cinder CSI プロビジョニングを有効にするには、デフォルトのインツリーストレージクラスを standard-csi で上書きすることが推奨されます。または、永続ボリューム要求 (PVC) を作成し、ストレージクラスを "standard-csi" として指定できます。

OpenShift Container Platform では、デフォルトのストレージクラスはインツリー Cinder ドライバーを参照します。ただし、CSI の自動移行が有効な場合に、デフォルトのストレージクラスを使用して作成されたボリュームは実際には CSI ドライバーを使用します。

以下の手順に従ってデフォルトのインツリーストレージクラスを上書きし、standard-csi ストレージクラスを適用します。

手順

  1. 次のコマンドを実行してストレージクラスをリスト表示します。

    $ oc get storageclass

    出力例

    NAME                   PROVISIONER                RECLAIMPOLICY   VOLUMEBINDINGMODE      ALLOWVOLUMEEXPANSION   AGE
    standard(default)      cinder.csi.openstack.org   Delete          WaitForFirstConsumer   true                   46h
    standard-csi           kubernetes.io/cinder       Delete          WaitForFirstConsumer   true                   46h

  2. 以下の例に示されるように、デフォルトストレージクラスについてアノテーション storageclass.kubernetes.io/is-default-class の値を false に変更します。

    $ oc patch storageclass standard -p '{"metadata": {"annotations": {"storageclass.kubernetes.io/is-default-class": "false"}}}'
  3. アノテーションを追加するか、アノテーションを storageclass.kubernetes.io/is-default-class=true として変更することで、別のストレージクラスをデフォルトにします。

    $ oc patch storageclass standard-csi -p '{"metadata": {"annotations": {"storageclass.kubernetes.io/is-default-class": "true"}}}'
  4. デフォルトで PVC が CSI ストレージクラスを参照していることを確認します。

    $ oc get storageclass

    出力例

    NAME                   PROVISIONER                RECLAIMPOLICY   VOLUMEBINDINGMODE      ALLOWVOLUMEEXPANSION   AGE
    standard               kubernetes.io/cinder       Delete          WaitForFirstConsumer   true                   46h
    standard-csi(default)  cinder.csi.openstack.org   Delete          WaitForFirstConsumer   true                   46h

  5. オプション: ストレージクラスを指定することなく新規 PVC を定義できます。

    apiVersion: v1
    kind: PersistentVolumeClaim
    metadata:
      name: cinder-claim
    spec:
      accessModes:
        - ReadWriteOnce
      resources:
        requests:
          storage: 1Gi

    特定のストレージクラスを指定しない PVC は、デフォルトのストレージクラスを使用して自動的にプロビジョニングされます。

  6. オプション: 新規ファイルを設定した後に、クラスター内にこのファイルを作成します。

    $ oc create -f cinder-claim.yaml

6.19. OpenStack Manila CSI Driver Operator

OpenShift Container Platform では、OpenStack Manila Container Storage Interface (CSI) Driver Operator および Driver を使用して OpenStack Manila ストレージをプロビジョニングおよび管理でき、動的ボリュームプロビジョニングが実現します。

6.19.1. Manila CSI Driver Operator の概要

OpenShift Container Platform は、OpenStack Manila 共有ファイルシステムサービスの Container Storage Interface (CSI) ドライバーを使用して永続ボリューム (PV) をプロビジョニングできます。

CSI Operator およびドライバーを使用する場合は、永続ストレージ および CSI ボリュームの設定 を理解しておくことが推奨されます。詳細は、「永続ストレージについて」および「CSI ボリュームの設定」を参照してください。

Manila ストレージアセットにマウントされる CSI でプロビジョニングされる PV を作成するには、OpenShift Container Platform は Manila CSI Driver Operator および Manila CSI ドライバーを Manila サービスが有効にされている OpenStack クラスターにデフォルトでインストールします。

Manila CSI Driver Operator
Manila CSI Driver Operator は、利用可能なすべての Manila 共有タイプの永続ボリューム要求 (PVC) の作成に必要なストレージクラスを作成します。Operator は openshift-cluster-csi-drivers namespace にインストールされます。
Manila CSI ドライバー
Manila CSI ドライバー を使用すると、Manila PV を作成し、マウントできます。ドライバーは openshift-manila-csi-driver namespace にインストールされます。

6.19.2. CSI について

Container Storage Interface (CSI) を使用すると、ストレージベンダーは Kubernetes コアコードを変更することなく、従来の組み込みストレージドライバーの代わりに、標準インターフェイスを介してプラグインを提供できます。

CSI Operator は、インツリーボリュームプラグインでは不可能なボリュームスナップショットなどのストレージオプションを OpenShift Container Platform ユーザーに付与します。

6.19.3. Manila CSI Driver Operator の制限事項

Manila CSI Driver Operator をデプロイする前に、OpenStack ストレージ設定との互換性を確保するために、プロトコル、スナップショット、FSGroup の制限を理解してください。

次の制限は、Manila Container Storage Interface (CSI) Driver Operator に適用されます。

NFS のみがサポートされています
OpenStack Manila は、NFS、CIFS、CEPHFS など、多くのネットワーク接続ストレージプロトコルをサポートしており、これらは OpenStack クラウドで選択的に有効にすることができます。OpenShift Container Platform の Manila CSI Driver Operator は、NFS プロトコルの使用のみをサポートします。基盤となる OpenStack クラウドで NFS が利用可能でなく、有効化されていない場合は、Manila CSI Driver Operator を使用して OpenShift Container Platform のストレージをプロビジョニングすることはできません。
バックエンドが CephFS-NFS の場合、スナップショットはサポートされません
永続ボリューム (PV) のスナップショットを作成し、ボリュームをスナップショットに戻すには、使用している Manila 共有タイプがこれらの機能をサポートしていることを確認する必要があります。Red Hat OpenStack 管理者は、使用するストレージクラスに関連付けられた共有タイプで、スナップショットのサポート (share type extra-spec snapshot_support) およびスナップショットからの共有の作成 (share type extra-spec create_share_from_snapshot_support) を有効にする必要があります。
FSGroup はサポートされていません
Manila CSI は、複数のリーダーおよび複数のライターによるアクセス用の共有ファイルシステムを提供するため、FSGroup の使用をサポートしていません。これは、ReadWriteOnce アクセスモードで作成された永続ボリュームにも当てはまります。したがって、Manila CSI Driver で使用するために手動で作成するストレージクラスでは、fsType 属性を指定しないことが重要です。
重要

Red Hat OpenStack Platform 16.x および 17.x では、NFS を介した CephFS を使用する Shared File Systems サービス (Manila) は、Manila CSI を介した OpenShift Container Platform への共有の提供を完全にサポートします。ただし、このソリューションは大規模なスケールを意図したものではありません。「CephFS NFS Manila-CSI Workload Recommendations for Red Hat OpenStack Platform」の重要な推奨事項を必ず確認してください。

6.19.4. Manila CSI ボリュームの動的プロビジョニング

OpenShift Container Platform は利用可能な Manila 共有タイプ別にストレージクラスをインストールします。複数の Pod からの同時アクセスをサポートする共有ストレージボリュームを動的にプロビジョニングするには、Manila Container Storage Interface CSI ストレージクラスを使用して永続ボリューム要求 (PVC) を作成する必要があります。

作成される YAML ファイルは Manila およびその Container Storage Interface (CSI) プラグインから完全に切り離されます。アプリケーション開発者は、ReadWriteMany (RWX) ストレージを動的にプロビジョニングし、YAML マニフェストを使用してストレージを安全に使用するアプリケーションと共に Pod をデプロイできます。

AWS、Google Cloud、Azure、その他のプラットフォーム上の OpenShift Container Platform で使用するものと同じ Pod 定義および永続ボリューム要求 (PVC) 定義を、オンプレミスでも使用できます (PVC 定義内のストレージクラス参照を除く)。

重要

デフォルトでは、すべての IPv4 クライアントからのアクセスを許可するアクセスルール 0.0.0.0/0 がボリュームに割り当てられます。クライアントアクセスを制限するには、特定のクライアント IP アドレスまたはサブネットを使用するカスタムストレージクラスを作成します。詳細は、「Manila 共有アクセスルールのカスタマイズ」を参照してください。

注記

Manila サービスはオプションです。サービスが Red Hat OpenStack Platform (RHOSP) で有効にされていない場合には、Manila CSI ドライバーがインストールされず、Manila のストレージクラスが作成されません。

6.19.4.1. Web コンソールを使用した Manila CSI ボリュームの動的プロビジョニング

OpenShift Container Platform Web コンソールを使用して共有ストレージボリュームを動的にプロビジョニングするには、Manila CSI ストレージクラスを選択して永続ボリューム要求 (PVC) を作成します。

前提条件

  • RHOSP は適切な Manila 共有インフラストラクチャーでデプロイされ、OpenShift Container Platform でボリュームを動的にプロビジョニングし、マウントするために使用できます。

手順

  1. OpenShift Container Platform Web コンソールで、Storage Persistent Volume Claims をクリックします。
  2. 永続ボリューム要求の概要で、Create Persistent Volume Claim をクリックします。
  3. 結果のページで必要なオプションを定義します。

    1. 適切なストレージクラスを選択します。
    2. ストレージ要求の一意の名前を入力します。
    3. アクセスモードを選択し、作成する PVC の読み取りおよび書き込みアクセスを指定します。

      重要

      この PVC を満たす PV をクラスター内の複数のノードにある複数の Pod にマウントする場合は、RWX を使用してください。

  4. ストレージ要求のサイズを定義します。
  5. Create をクリックして PVC を作成し、PV を生成します。

結果

新規 PVC を使用して Pod を設定できるようになりました。

6.19.4.2. CLI を使用した Manila CSI ボリュームの動的プロビジョニング

CLI を使用して共有ストレージボリュームを動的にプロビジョニングするには、Manila CSI ストレージクラスを参照する永続ボリューム要求 (PVC) YAML ファイルを作成して適用します。

前提条件

  • RHOSP は適切な Manila 共有インフラストラクチャーでデプロイされ、OpenShift Container Platform でボリュームを動的にプロビジョニングし、マウントするために使用できます。

手順

  1. 以下の YAML によって記述される PersistentVolumeClaim オブジェクトを使用してファイルを作成し、保存します。

    pvc-manila.yaml

    apiVersion: v1
    kind: PersistentVolumeClaim
    metadata:
      name: pvc-manila
    spec:
      accessModes:
        - ReadWriteMany
      resources:
        requests:
          storage: 10Gi
      storageClassName: csi-manila-gold

    • spec.accessModes: この PVC を満たす PV をクラスター内の複数のノードにある複数の Pod にマウントする場合は、RWX を使用してください。
    • spec.storageClassName: ストレージバックエンドをプロビジョニングするストレージクラスの名前を指定します。Manila ストレージクラスは Operator によってプロビジョニングされ、これには csi-manila- 接頭辞があります。
  2. 以下のコマンドを実行して、直前の手順で保存されたオブジェクトを作成します。

    $ oc create -f pvc-manila.yaml

    新規 PVC が作成されます。

  3. ボリュームが作成され、準備状態にあることを確認するには、以下のコマンドを実行します。

    $ oc get pvc pvc-manila

    pvc-manila は、これが Bound であることを示します。

結果

新規 PVC を使用して Pod を設定できるようになりました。

6.19.5. Manila 共有アクセスルールのカスタマイズ

ボリュームをマウントできるクライアントを制御してストレージのセキュリティを向上させるには、特定の IP アドレスまたはサブネットへのアクセスを制限するカスタム Manila ストレージクラスを作成します。

デフォルトでは、OpenShift Container Platform はすべての IPv4 クライアントへのアクセスを提供する Manila ストレージクラスを作成します。クライアントアクセスを制限するには、nfs-ShareClient パラメーターを使用して、特定のクライアント IP アドレスまたはサブネットを使用するカスタムストレージクラスを定義できます。

重要

アクセスルールが制限されたカスタムストレージクラスを使用する場合は、次の点を確認してください。

  • 指定された IP アドレスまたはサブネットには、ストレージにアクセスする必要があるすべての OpenShift Container Platform ノードが含まれている。
  • RHOSP の Manila サービスは、ストレージクラスで指定された共有タイプをサポートする。
  • 許可されたクライアントと Manila 共有サーバーの間にネットワーク接続が存在する。

前提条件

  • 適切な Manila 共有インフラストラクチャーを使用して Red Hat OpenStack Platform (RHOSP) がデプロイされた。
  • 管理者特権でクラスターにアクセスできる。

手順

  1. 次の例に基づいて、カスタムストレージクラスの YAML ファイルを作成します。

    カスタムストレージクラスファイルの例

    apiVersion: storage.k8s.io/v1
    kind: StorageClass
    metadata:
      name: csi-manila-gold-restricted
    provisioner: manila.csi.openstack.org
    parameters:
      type: gold
      nfs-ShareClient: "10.0.0.0/24,192.168.1.100"
      csi.storage.k8s.io/provisioner-secret-name: manila-csi-secret
      csi.storage.k8s.io/provisioner-secret-namespace: openshift-manila-csi-driver
      csi.storage.k8s.io/controller-expand-secret-name: manila-csi-secret
      csi.storage.k8s.io/controller-expand-secret-namespace: openshift-manila-csi-driver
      csi.storage.k8s.io/node-stage-secret-name: manila-csi-secret
      csi.storage.k8s.io/node-stage-secret-namespace: openshift-manila-csi-driver
      csi.storage.k8s.io/node-publish-secret-name: manila-csi-secret
      csi.storage.k8s.io/node-publish-secret-namespace: openshift-manila-csi-driver
    allowVolumeExpansion: true

    • metadata.name: カスタムストレージクラスのわかりやすい名前を指定します。
    • parameters.type: Manila 共有タイプを指定します。このタイプは、RHOSP 環境内の既存の共有タイプと一致する必要があります。
    • parameters.nfs.ShareClient: NFS 共有へのアクセスが許可される IP アドレスまたは CIDR サブネットのコンマ区切りリスト。nfs-ShareClient パラメーターはさまざまな形式を受け入れます。

      • 単一の IP アドレス: 192.168.1.100
      • CIDR サブネット: 10.0.0.0/24
      • 複数のエントリー: 10.0.0.0/24,192.168.1.100,172.16.0.0/16

        永続ボリュームを適切にマウントできるように、指定された IP アドレスまたはサブネットに OpenShift Container Platform クラスターノードが含まれていることを確認します。

        この例では、アクセスは 10.0.0.0/24 サブネットに制限されており、指定された IP アドレスは 192.168.1.100 です。

  2. 次のコマンドを実行して、ファイルからストレージクラスを適用します。

    $ oc apply -f custom-manila-storageclass.yaml
  3. 次のコマンドを実行して、ストレージクラスが作成されたことを確認します。

    $ oc get storageclass csi-manila-gold-restricted

    出力例

    NAME                 		    PROVISIONER                RECLAIMPOLICY   VOLUMEBINDINGMODE   ALLOWVOLUMEEXPANSION   AGE
    csi-manila-gold-restricted	manila.csi.openstack.org   Delete          Immediate           true                   43m

  4. 次の例に基づいて、カスタムストレージクラスを使用する永続ボリューム要求 (PVC) を作成します。

    PVC ファイルの例

    apiVersion: v1
    kind: PersistentVolumeClaim
    metadata:
      name: pvc-manila-restricted
    spec:
      accessModes:
        - ReadWriteMany
      resources:
        requests:
          storage: 10Gi
      storageClassName: csi-manila-gold-restricted

    spec.storageClassName は、アクセスが制限されているカスタムストレージクラスの名前です。この例では、csi-manila-gold-restricted という名前です。

  5. 次のコマンドを実行して、ファイルから PVC を適用します。

    $ oc apply -f pvc-manila-restricted.yaml

6.20. Secrets Store Container Storage Interface Driver Operator

シークレットのセキュリティーを強化し、エンタープライズシークレット管理システムと統合するには、Secrets Store CSI Driver Operator を使用して、Pod の終了後にクラスターにシークレットを永続化せずに外部ストアからシークレットをマウントします。

6.20.1. Secrets Store CSI Driver Operator の概要

Secrets Store CSI ドライバー Operator は、プロバイダープラグインを使用して、Azure Key Vault などの外部のシークレット管理システムからシークレットを Pod にマウントします。シークレットは、Pod の終了後にシステムで保持されません。

シークレットオブジェクトは Base64 エンコーディングで保存されます。etcd は、これらのシークレットの保存時に暗号化しますが、シークレットの取得時に、シークレットが復号化されてユーザーに表示されます。クラスターでロールベースのアクセス制御が適切に設定されていない場合、API または etcd へのアクセス権を持つユーザーは誰でもシークレットを取得または変更できます。さらに、namespace で Pod を作成する権限を持つ人は誰でも、そのアクセス権を使用して、その namespace 内の任意のシークレットを読み取ることができます。

Secrets Store CSI Driver Operator (secrets-store.csi.k8s.io) を使用すると、OpenShift Container Platform で、エンタープライズグレードの外部シークレットストアに保存されている複数のシークレット、キー、証明書をボリュームとして Pod にマウントできます。Secrets Store CSI Driver Operator は、gRPC を使用してプロバイダーと通信し、指定された外部シークレットストアからマウントコンテンツを取得します。ボリュームがアタッチされると、その中のデータがコンテナーのファイルシステムにマウントされます。シークレットストアボリュームはインラインでマウントされます。

CSI インラインボリュームの詳細は、「CSI インラインエフェメラルボリューム」を参照してください。

CSI ドライバーを使用する場合、永続ストレージ および CSI ボリュームの設定 を理解しておくことが推奨されます。詳細は、「永続ストレージについて」および「CSI ボリュームの設定」を参照してください。

6.20.1.1. シークレットストアプロバイダー

機密アプリケーションデータを外部のシークレット管理システムに保存し、Secrets Store CSI ドライバー Operator を使用して、シークレットコンテンツを Pod ボリュームとしてマウントできます。

Secrets Store CSI Driver Operator は、次のシークレットストアプロバイダーでテストされています。

  • AWS Secrets Manager
  • AWS Systems Manager Parameter Store
  • Azure Key Vault
  • Google Secret Manager
  • HashiCorp Vault
注記

Red Hat は、サードパーティーのシークレットストアプロバイダーの機能に関連するすべての要素をテストしているわけではありません。サードパーティーのサポートの詳細は、「Red Hat サードパーティーサポートポリシー」を参照してください。

6.20.2. CSI について

Container Storage Interface (CSI) を使用すると、ストレージベンダーは Kubernetes コアコードを変更することなく、従来の組み込みストレージドライバーの代わりに、標準インターフェイスを介してプラグインを提供できます。

CSI Operator は、インツリーボリュームプラグインでは不可能なボリュームスナップショットなどのストレージオプションを OpenShift Container Platform ユーザーに付与します。

6.20.3. 切断された環境へのサポート

非接続 OpenShift Container Platform クラスターで特定のシークレットストアプロバイダーを使用するには、VPC エンドポイントまたは同等の接続を設定して、ドライバーと外部シークレット管理システム間の通信を有効にします。

次のシークレットストアプロバイダーは、非接続クラスターでのシークレットストア CSI ドライバーの使用をサポートしています。

  • AWS Secrets Manager
  • Azure Key Vault
  • Google Secret Manager
  • HashiCorp Vault

Secrets Store CSI ドライバーとシークレットストアプロバイダー間の通信を有効にするには、対応するシークレットストアプロバイダー、OpenID Connect (OIDC) 発行者、および Secure Token Service (STS) への Virtual Private Cloud (VPC) エンドポイントまたは同等の接続を設定します。設定の詳細は、シークレットストアプロバイダー、認証方法、非接続クラスターの種類により異なります。

注記

非接続環境の詳細は、「非接続環境について」を参照してください。

6.20.4. ネットワークポリシーのサポート

Secrets Store CSI Driver Operator は、事前定義の NetworkPolicies を使用して Ingress および Egress トラフィックを制御し、Operator および Driver コンポーネントのセキュリティーを強化します。

次の表は、デフォルトの Ingress ルールと Egress ルールをまとめたものです。

コンポーネントIngress ポートEgress ポート説明

Secrets Store CSI Driver Operator

8443

6443

メトリクスにアクセスし、API サーバーと通信する

Secrets Store CSI ドライバー

8095

6443

メトリクスにアクセスし、API サーバーと通信する

6.20.5. Secrets Store CSI ドライバーのインストール

OpenShift Container Platform が外部シークレット管理システムからシークレットをマウントできるようにするには、Secrets Store CSI Driver Operator をインストールし、ClusterCSIDriver インスタンスを作成します。

前提条件

  • OpenShift Container Platform Web コンソールにアクセスできる。
  • 管理者としてクラスターにアクセスできる。

手順

  1. Secrets Store CSI Driver Operator をインストールします。

    1. Web コンソールにログインします。
    2. Ecosystem Software Catalog をクリックします。
    3. フィルターボックスに "Secrets Store CSI" と入力し、Secrets Store CSI Driver Operator を見つけます。
    4. Secrets Store CSI Driver Operator ボタンをクリックします。
    5. Secrets Store CSI Driver Operator ページで、Install をクリックします。
    6. Install Operator のページで、以下のことを確認してください。

      • All namespaces on the cluster (default) が選択されている。
      • Installed Namespace が openshift-cluster-csi-drivers に設定されている。
    7. Install をクリックします。

      インストールが終了すると、Web コンソールの Installed Operators セクションに Secrets Store CSI Driver Operator がリストされます。

  2. ドライバーの ClusterCSIDriver インスタンス (secrets-store.csi.k8s.io) を作成します。

    1. Administration CustomResourceDefinitions ClusterCSIDriver をクリックします。
    2. Instances タブで Create ClusterCSIDriver をクリックします。

      以下の YAML ファイルを使用します。

      apiVersion: operator.openshift.io/v1
      kind: ClusterCSIDriver
      metadata:
          name: secrets-store.csi.k8s.io
      spec:
        managementState: Managed
    3. Create をクリックします。

6.20.6. Secrets Store CSI ドライバー Operator のアンインストール

Secrets Store CSI Driver Operator を削除し、クラスターリソースを解放するには、アプリケーションを停止して CSI ドライバーを削除した後に Operator をアンインストールします。

前提条件

  • OpenShift Container Platform Web コンソールにアクセスできる。
  • 管理者としてクラスターにアクセスできる。

手順

  1. secrets-store.csi.k8s.io プロバイダーを使用するすべてのアプリケーション Pod を停止します。
  2. 選択したシークレットストアのサードパーティープロバイダープラグインをすべて削除します。
  3. Container Storage Interface (CSI) ドライバーと関連するマニフェストを削除します。

    1. Administration CustomResourceDefinitions ClusterCSIDriver をクリックします。
    2. Instances タブの左端にある secrets-store.csi.k8s.io でドロップダウンメニューをクリックし、Delete ClusterCSIDriver をクリックします。
    3. プロンプトが表示されたら、Delete をクリックします。
  4. CSI ドライバー Pod が稼働していないことを確認します。
  5. Secrets Store CSI Driver Operator をアンインストールします。

    注記

    Operator をアンインストールする前に、まず CSI ドライバーを削除する必要があります。

    1. Ecosystem Installed Operators をクリックします。
    2. Installed Operators ページで、スクロールするか、Search by name ボックスに "Secrets Store CSI" と入力して Operator を見つけ、クリックします。
    3. Installed Operators > Operator details ページの右上に表示される Actions Uninstall Operator をクリックします。
    4. Uninstall Operator ウィンドウでプロンプトが表示されたら、Uninstall ボタンをクリックして namespace から Operator を削除します。Operator によってクラスターにデプロイされたアプリケーションは手動でクリーンアップする必要があります。

      アンインストールすると、Secrets Store CSI Driver Operator は Web コンソールの Installed Operators セクションにリストされなくなります。

6.21. CIFS/SMB CSI Driver Operator

OpenShift Container Platform で Common Internet File System (CIFS)/Server Message Block (SMB) ネットワーク共有をプロビジョニングおよび管理するには、動的ボリュームプロビジョニングをサポートする CIFS/SMB Container Storage Interface (CSI) Driver Operator を使用します。

6.21.1. CIFS/SMB Driver Operator の概要

オンデマンドストレージの動的ボリュームプロビジョニングをサポートする CIFS/SMB CSI Driver Operator を使用して、ネットワークファイル共有にマウントする永続ボリューム (PV) をプロビジョニングできます。

CSI Operator およびドライバーを使用する場合は、永続ストレージ および CSI ボリュームの設定 を理解しておくことが推奨されます。詳細は、「永続ボリュームについて」および「CSI ボリュームの設定」を参照してください。

CIFS/SMB CSI Driver Operator をインストールした後、OpenShift Container Platform は、Operator とドライバーに対応する Pod をデフォルトで openshift-cluster-csi-drivers namespace にインストールします。これにより、CIFS/SMB CSI ドライバーは、CIFS/SMB 共有にマウントされる CSI プロビジョニングされた永続ボリューム (PV) を作成できるようになります。

CIFS/SMB CSI Driver Operator
CIFS/SMB CSI Driver Operator をインストールしても、デフォルトでは、永続ボリューム要求 (PVC) の作成に使用されるストレージクラスは作成されません。ただし、動的プロビジョニング用の CIFS/SMB StorageClass を手動で作成できます (「動的プロビジョニング」を参照)。CIFS/SMB CSI Driver Operator は、ストレージボリュームをオンデマンドで作成できるようにすることで、動的なボリュームプロビジョニングをサポートします。クラスター管理者がストレージを事前にプロビジョニングする必要がなくすことで、動的ボリュームのプロビジョニングをサポートします。
CIFS/SMB CSI ドライバー
CIFS/SMB CSI ドライバー を使用すると、CIFS/SMB PV の作成およびマウントが可能です。

6.21.2. CSI について

Container Storage Interface (CSI) を使用すると、ストレージベンダーは Kubernetes コアコードを変更することなく、従来の組み込みストレージドライバーの代わりに、標準インターフェイスを介してプラグインを提供できます。

CSI Operator は、インツリーボリュームプラグインでは不可能なボリュームスナップショットなどのストレージオプションを OpenShift Container Platform ユーザーに付与します。

6.21.3. CIFS/SMB Driver Operator の制限

Common Internet File System (CIFS)/Server Message Block (SMB) ストレージをデプロイする前に、FIPS モード、HTTP プロキシー、DFS、Kerberos 認証のサポートなど、CSI ドライバーの制限事項を確認してください。

CIFS/SMB CSI Driver Operator には次の制限が適用されます。

  • FIPS モードはサポートされていません。

    Federal Information Processing Standards (FIPS) モードが有効になっている場合、md4 および md5 の使用は無効になり、ユーザーは ntlm、ntlmv2、または ntlmssp 認証を使用できなくなります。また、署名は md5 を使用しているため、使用できません。FIPS モードが有効になっていると、これらのメソッドを使用する CIFS マウントは失敗します。

  • HTTP プロキシー設定を使用してクラスター SMB サーバーの外部に接続することは、CSI ドライバーではサポートされていません。

    CIFS/SMB は LAN プロトコルであり、サブネットにルーティングすることはできますが、WAN 経由で拡張するようには設計されておらず、HTTP プロキシー設定はサポートされていません。

  • CIFS/SMB CSI Driver Operator は、Windows 分散ファイルシステム (DFS) をサポートして いません。
  • Kerberos 認証はサポートされていません。
  • SMB CSI は、Samba v4.21.2 および Windows Server 2019 および Windows Server 2022 でテストされました。

6.21.4. CIFS/SMB CSI Driver Operator のインストール

クラスター内で CIFS/SMB ストレージを有効にするには、CIFS/SMB Container Storage Interface (CSI) Driver Operator をインストールして設定します。この Red Hat Operator はデフォルトではインストールされておらず、手動でインストールする必要があります。

前提条件

  • OpenShift Container Platform Web コンソールにアクセスできる。

手順

  1. Web コンソールにログインします。
  2. CIFS/SMB CSI Operator をインストールします。

    1. Ecosystem Software Catalog をクリックします。
    2. フィルターボックスに CIFS/SMB CSI と入力して、CIFS/SMB CSI Operator を見つけます。
    3. CIFS/SMB CSI Driver Operator ボタンをクリックします。
    4. CIFS/SMB CSI Driver Operator ページで、Install をクリックします。
    5. Install Operator のページで、以下のことを確認してください。

      • All namespaces on the cluster (default) が選択されている。
      • Installed Namespace が openshift-cluster-csi-drivers に設定されている。
    6. Install をクリックします。

      インストールが終了すると、CIFS/SMB CSI Operator が Web コンソールの Installed Operators に表示されます。

次のステップ

CIFS/SMB CSI ドライバーをインストールします。

6.21.5. CIFS/SMB CSI ドライバーのインストール

ネットワークファイル共有をクラスター内の永続ボリューム (PV) として使用するには、CIFS/SMB CSI Driver Operator をインストールした後に ClusterCSIDriver リソースを作成します。

前提条件

  • OpenShift Container Platform Web コンソールにアクセスできる。
  • CIFS/SMB CSI Driver Operator がインストールされている。

手順

  1. Administration CustomResourceDefinitions ClusterCSIDriver をクリックします。
  2. Instances タブで Create ClusterCSIDriver をクリックします。
  3. 以下の YAML ファイルを使用します。

    apiVersion: operator.openshift.io/v1
    kind: ClusterCSIDriver
    metadata:
        name: smb.csi.k8s.io
    spec:
      managementState: Managed
  4. Create をクリックします。
  5. 以下の条件が "True" に変わるのを待ちます。

    • SambaDriverControllerServiceControllerAvailable
    • SambaDriverNodeServiceControllerAvailable

6.21.6. CIFS/SMB の動的プロビジョニング

共有を事前に作成せずに Common Internet File System (CIFS)/Server Message Block (SMB) ボリュームを自動的にプロビジョニングするには、サーバー認証情報、SMB ソースのストレージクラス、および永続ボリューム要求 (PVC) のシークレットを作成します。

ボリュームを動的にプロビジョニングすると、ストレージクラスで定義された source の下に永続ボリューム (PV) 名を持つサブディレクトリーが作成されます。

前提条件

  • CIFS/SMB CSI Driver Operator およびドライバーがインストールされている。
  • 実行中の OpenShift Container Platform クラスターにログインしている。
  • SMB サーバーをインストールしており、サーバーに関する次の情報を把握している。

    • ホスト名
    • 共有名
    • ユーザー名およびパスワード

手順

  1. 以下のサンプル YAML ファイルを使用して、次のコマンドを実行して Samba サーバーにアクセスするためのシークレットを作成します。

    $ oc create -f <file_name>.yaml

    シークレット YAML ファイルの例

    apiVersion: v1
    kind: Secret
    metadata:
      name: smbcreds
      namespace: samba-server
    stringData:
      username: <username>
      password: <password>

    • metadata.name: Samba サーバーのシークレットの名前を指定します。
    • metadata.namespace: Samba サーバーのシークレットの namespace を指定します。
    • stringData.username: Samba サーバーのシークレットのユーザー名を指定します。
    • stringData.password: Samba サーバーのシークレットのパスワードを指定します。
  2. 次のサンプル YAML ファイルを使用して次のコマンドを実行して、ストレージクラスを作成します。

    $ oc create -f <sc_file_name>.yaml

    ここで、<sc_file_name>.yaml はストレージクラス YAML ファイルの名前です。

    ストレージクラスの YAML ファイルの例

    apiVersion: storage.k8s.io/v1
    kind: StorageClass
    metadata:
      name: <sc_name>
    provisioner: smb.csi.k8s.io
    parameters:
      source: //<hostname>/<shares>
      csi.storage.k8s.io/provisioner-secret-name: smbcreds
      csi.storage.k8s.io/provisioner-secret-namespace: samba-server
      csi.storage.k8s.io/node-stage-secret-name: smbcreds
      csi.storage.k8s.io/node-stage-secret-namespace: samba-server
    reclaimPolicy: Delete
    volumeBindingMode: Immediate
    mountOptions:
      - dir_mode=0777
      - file_mode=0777
      - uid=1001
      - gid=1001

    • metadata.name: ストレージクラスの名前を指定します。
    • parameters.source: Samba サーバーをインストールし、クラスターからアクセスできるようにする必要があります。<hostname> は Samba サーバーのホスト名、<shares> はエクスポートされた共有で使用するために設定したパスを表します。
    • parameters.csi.storage.k8s.io/provisioner-secret-name: 前のステップで設定した Samba サーバーのシークレットの名前を指定します。csi.storage.k8s.io/provisioner-secret が指定されている場合は、source の下に PV 名を持つサブディレクトリーが作成されます。
    • parameters.csi.storage.k8s.io/provisioner-secret-namespace: 前のステップで設定した Samba サーバーのシークレットの namespace を指定します。
  3. PVC を作成します。

    1. 次のサンプル YAML ファイルを使用して次のコマンドを実行し、PVC を作成します。

      $ oc create -f <pv_file_name>.yaml

      ここで、<pv_file_name>.yaml は PVC YAML ファイルの名前です。

      PVC YAML ファイルの例

      kind: PersistentVolumeClaim
      apiVersion: v1
      metadata:
        name: <pvc_name>
      spec:
        accessModes:
          - ReadWriteMany
        resources:
          requests:
            storage: <storage_amount>
        storageClassName: <sc_name>

      • metadata.name: PVC の名前を指定します。
      • spec.resources.requests.storage: ストレージ要求量を指定します。
      • spec.storage.ClassName: 前のステップで作成した CIFS/SMB ストレージクラスの名前を指定します。
    2. 次のコマンドを実行して、PVC が作成され、"バインド" ステータスになっていることを確認します。

      $ oc describe pvc <pvc_name>

      ここで、<pvc_name> は前の手順で作成した PVC の名前です。

      出力例

      Name:          pvc-test
      Namespace:     default
      StorageClass:  samba
      Status:        Bound
      ...

      PVC のステータスは Bound です。

6.21.7. CIFS/SMB の静的プロビジョニング

静的プロビジョニングを使用して、永続ボリューム (PV) と永続ボリューム要求 (PVC) を作成し、既存のサーバーメッセージブロックプロトコル (SMB) 共有を使用することができます。

前提条件

  • OpenShift Container Platform Web コンソールにアクセスできる。
  • CIFS/SMB CSI Driver Operator およびドライバーがインストールされている。
  • SMB サーバーをインストールしており、サーバーに関する次の情報を把握している。

    • ホスト名
    • 共有名
    • ユーザー名およびパスワード

手順

  1. 以下のサンプル YAML ファイルを使用して、次のコマンドを実行して Samba サーバーにアクセスするためのシークレットを作成します。

    $ oc create -f <file_name>.yaml

    シークレット YAML ファイルの例

    apiVersion: v1
    kind: Secret
    metadata:
      name: smbcreds
      namespace: samba-server
    stringData:
      username: <username>
      password: <password>

    • metadata.name: Samba サーバーのシークレットの名前を指定します。
    • metadata.namespace: Samba サーバーのシークレットの namespace を指定します。
    • stringData.username: Samba サーバーのシークレットのユーザー名を指定します。
    • stringData.password: Samba サーバーのシークレットのパスワードを指定します。
  2. 次のサンプル YAML ファイルを使用して次のコマンドを実行し、PV を作成します。

    $ oc create -f <pv_file_name>.yaml

    ここで、<pv_file_name>.yaml は PV YAML ファイルの名前です。

    PV YAML ファイルの例

    apiVersion: v1
    kind: PersistentVolume
    metadata:
      annotations:
        pv.kubernetes.io/provisioned-by: smb.csi.k8s.io
      name: <pv_name>
    spec:
      capacity:
        storage: 100Gi
      accessModes:
        - ReadWriteMany
      persistentVolumeReclaimPolicy: Retain
      storageClassName: ""
      mountOptions:
        - dir_mode=0777
        - file_mode=0777
      csi:
        driver: smb.csi.k8s.io
        volumeHandle: smb-server.default.svc.cluster.local/share##
        volumeAttributes:
          source: //<hostname>/<shares>
        nodeStageSecretRef:
          name: <secret_name_shares>
          namespace: <namespace>

    • metadata.name: PV の名前を指定します。
    • spec.csi.volumeHandle の形式は、{smb-server-address}#{sub-dir-name}#{share-name} です。この値がクラスター内のすべての共有に対して一意であることを確認してください。
    • spec.csi.volumeAttributes.source: Samba サーバーをインストールし、クラスターからアクセスできるようにする必要があります。<hostname> は Samba サーバーのホスト名、<shares> はエクスポートされた共有で使用するために設定したパスを表します。
    • spec.csi.nodeStageSecretRef.name: 共有のシークレットの名前を指定します。
    • spec.csi.nodeStageSecretRef.namespace: 該当する namespace を指定します。
  3. PVC を作成します。

    1. 次のサンプル YAML ファイルを使用して次のコマンドを実行し、PVC を作成します。

      $ oc create -f <pv_file_name>.yaml

      ここで、<pv_file_name>.yaml は PVC YAML ファイルの名前です。

      PVC YAML ファイルの例

      kind: PersistentVolumeClaim
      apiVersion: v1
      metadata:
        name: <pvc_name>
      spec:
        accessModes:
          - ReadWriteMany
        resources:
          requests:
            storage: <storage_amount>
        storageClassName: ""
        volumeName: <pv_name>

      • metadata.name: PVC の名前を指定します。
      • spec.resources.requests.storage: ストレージ要求量を指定します。
      • spec.volumeName: 最初のステップから PV の名前を指定します。
    2. 次のコマンドを実行して、PVC が作成され、"バインド" ステータスになっていることを確認します。

      $ oc describe pvc <pvc_name>

      ここで、<pvc_name> は前の手順で作成した PVC の名前です。

      出力例

      Name:          pvc-test
      Namespace:     default
      StorageClass:
      Status:        Bound
      ...

      PVC のステータスは Bound です。

  4. 次のサンプル YAML ファイルを使用して次のコマンドを実行し、Linux 上にデプロイメントを作成します。

    注記

    前の手順で作成した PV と PVC を使用する場合、次のデプロイメントは必須ではありません。これらはどのように使用できるかの例です。

    $ oc create -f <deployment_file_name>.yaml

    ここで、<deployment_file_name>.yaml はデプロイメント YAML ファイルの名前です。

    デプロイメント YAML ファイルの例

    apiVersion: apps/v1
    kind: Deployment
    metadata:
      labels:
        app: nginx
      name: <deployment_name>
    spec:
      replicas: 1
      selector:
        matchLabels:
          app: nginx
      template:
        metadata:
          labels:
            app: nginx
          name: <deployment_name>
        spec:
          nodeSelector:
            "kubernetes.io/os": linux
          containers:
            - name: <deployment_name>
              image: quay.io/centos/centos:stream8
              command:
                - "/bin/bash"
                - "-c"
                - set -euo pipefail; while true; do echo $(date) >> <mount_path>/outfile; sleep 1; done 
    1
    
              volumeMounts:
                - name: <vol_mount_name>
                  mountPath: <mount_path>
                  readOnly: false
          volumes:
            - name: <vol_mount_name>
              persistentVolumeClaim:
                claimName: <pvc_name>
      strategy:
        rollingUpdate:
          maxSurge: 0
          maxUnavailable: 1
        type: RollingUpdate

    • metadata.name および spec.template.name: デプロイメントの名前を指定します。
    • spec.template.spec.containers.command.set および spec.template.spec.containers.volumeMounts.mountpath: ボリュームマウントパスを指定します。
    • spec.template.spec.containers.volumeMounts.mountpath および spec.template.spec.volumes.name: ボリュームマウントの名前を指定します。
    • spec.template.spec.volumes.persistentVolumeClaim.claimName: 前のステップで作成した PVC の名前を指定します。
  5. コンテナーで df -h コマンドを実行して、設定を確認します。

    $ oc exec -it <pod_name> -- df -h

    <pod_name> は Pod の名前です。

    出力例

    Filesystem            Size  Used Avail Use% Mounted on
    ...
    /dev/sda1              97G   21G   77G  22% /etc/hosts
    //20.43.191.64/share   97G   21G   77G  22% /mnt/smb
    ...

    この例では、Common Internet File System (CIFS) ファイルシステムとしてマウントされた /mnt/smb ディレクトリーがあります。

6.22. VMware vSphere CSI Driver Operator

OpenShift Container Platform で vSphere Container Storage Interface (CSI) Driver Operator と Driver を使用すると、vSphere ストレージをプロビジョニングおよび管理できます。これにより、動的ボリュームプロビジョニングが可能になり、ストレージの事前プロビジョニングが不要になります。

6.22.1. vSphere CSI Driver Operator の概要

OpenShift Container Platform は、Virtual Machine Disk (VMDK) ボリュームの Container Storage Interface (CSI) VMware vSphere ドライバーを使用して永続ボリューム (PV) をプロビジョニングできます。

CSI Operator およびドライバーを使用する場合は、永続ストレージ および CSI ボリュームの設定 を理解しておくことが推奨されます。詳細は、「永続ボリュームについて」および「CSI ボリュームの設定」を参照してください。

vSphere ストレージアセットにマウントする CSI でプロビジョニングされた永続ボリューム (PV) を作成するには、OpenShift Container Platform は、デフォルトで vSphere CSI Driver Operator および vSphere CSI ドライバーを openshift-cluster-csi-drivers namespace にインストールします。

vSphere CSI Driver Operator
Operator は、永続ボリューム要求 (PVC) の作成に使用できる thin-csi というストレージクラスを提供します。vSphere CSI Driver Operator は、ストレージボリュームをオンデマンドで作成できるようにし、クラスター管理者がストレージを事前にプロビジョニングする必要がなくすことで、動的ボリュームのプロビジョニングをサポートします。必要に応じて、このデフォルトのストレージクラスを無効にできます (「デフォルトストレージクラスの管理」を参照)。
vSphere CSI ドライバー
このドライバーを使用すると、vSphere PV を作成し、マウントできます。OpenShift Container Platform 4.20 以降では、ドライバーバージョンは 3.6.0 です。vSphere CSI ドライバーは、XFS や Ext4 など、基盤となる Red Hat Enterprise Linux CoreOS (RHCOS) リリースでサポートされているすべてのファイルシステムをサポートします。サポートされているファイルシステムの詳細は、「利用可能なファイルシステムの概要」を参照してください。
注記

新規インストールの場合、OpenShift Container Platform 4.13 以降では、vSphere インツリーボリュームプラグインと同等の CSI ドライバーに自動的に移行できます。OpenShift Container Platform 4.15 以降に更新した場合も、自動移行が可能になります。更新と移行の詳細は、「CSI の自動移行」を参照してください。

CSI 自動移行はシームレスに行ってください。移行をしても、永続ボリューム、永続ボリューム要求、ストレージクラスなどの既存の API オブジェクトを使用する方法は変更されません。

6.22.2. CSI について

Container Storage Interface (CSI) を使用すると、ストレージベンダーは Kubernetes コアコードを変更することなく、従来の組み込みストレージドライバーの代わりに、標準インターフェイスを介してプラグインを提供できます。

CSI Operator は、インツリーボリュームプラグインでは不可能なボリュームスナップショットなどのストレージオプションを OpenShift Container Platform ユーザーに付与します。

6.22.3. vSphere CSI の制限

vSphere ストレージボリュームをデプロイする前に、互換性の問題を回避するために、設定が静的プロビジョニングとスナップショット復元の要件を満たしていることを確認してください。

次の制限は、vSphere Container Storage Interface (CSI) Driver Operator に適用されます。

  • vSphere CSI Driver は、動的および静的なプロビジョニングをサポートします。ただし、PV 仕様で静的プロビジョニングを使用する場合は、csi.volumeAttributes でキー storage.kubernetes.io/csiProvisionerIdentity を使用しないでください。このキーは動的にプロビジョニングされた PV を示すためです。

6.22.4. vSphere ストレージポリシー

vSphere CSI Driver Operator ストレージクラスは、vSphere のストレージポリシーを使用します。OpenShift Container Platform は、クラウド設定で設定されるデータストアをターゲットにするストレージポリシーを自動的に作成します。

kind: StorageClass
apiVersion: storage.k8s.io/v1
metadata:
  name: thin-csi
provisioner: csi.vsphere.vmware.com
parameters:
  StoragePolicyName: "$openshift-storage-policy-xxxx"
volumeBindingMode: WaitForFirstConsumer
allowVolumeExpansion: false
reclaimPolicy: Delete

6.22.5. ReadWriteMany vSphere ボリュームのサポート

vSphere 環境で vSAN ファイルサービスが設定されている場合、複数の Pod が同じストレージに同時にアクセスできる ReadWriteMany (RWX) ボリュームをプロビジョニングできます。

vSAN ファイルサービスが設定されていない場合、使用可能なアクセスモードは ReadWriteOnce (RWO) のみです。vSAN ファイルサービスが設定されていない場合に RWX を要求すると、ボリュームの作成に失敗し、エラーがログに記録されます。

ご使用の環境で vSAN ファイルサービスを設定する方法の詳細は、「vSAN File Service」を参照してください。

次の永続ボリューム要求 (PVC) を行うことで、RWX ボリュームを要求できます。

kind: PersistentVolumeClaim
apiVersion: v1
metadata:
  name: myclaim
spec:
  resources:
    requests:
      storage: 1Gi
  accessModes:
     - ReadWriteMany
  storageClassName: thin-csi

RWX ボリュームタイプの PVC を要求すると、vSAN ファイルサービスによってサポートされる永続ボリューム (PV) がプロビジョニングされます。

6.22.6. VMware vSphere CSI Driver Operator の要件

vSphere CSI Driver Operator を正常にインストールおよび操作するには、環境が VMware vSphere、vCenter、および仮想マシンの最小バージョン要件を満たしていることを確認します。

vSphere Container Storage Interface (CSI) Driver Operator をインストールするには、次の要件を満たす必要があります。

  • VMware vSphere バージョン 8.0 Update 1 以降、または VMware vSphere Foundation (VVF) 9、あるいは VMware Cloud Foundation (VCF) 5 以降
  • vCenter バージョン 8.0 Update 1 以降、または VVF 9、あるいは VCF 5 以降
  • ハードウェアバージョン 15 以降の仮想マシン
  • クラスターにサードパーティーの vSphere CSI ドライバーがインストールされていない

サードパーティーの vSphere CSI ドライバーがクラスターに存在する場合、OpenShift Container Platform はそれを上書きしません。サードパーティーの vSphere CSI ドライバーが存在すると、OpenShift Container Platform を OpenShift Container Platform 4.13 以降にアップグレードできなくなります。

注記

VMware vSphere CSI Driver Operator は、インストールマニフェストの platform: vsphere でデプロイされたクラスターでのみサポートされます。

Container Storage Interface (CSI) ドライバー、vSphere CSI Driver Operator、および vSphere Problem Detector Operator のカスタムロールを作成できます。カスタムロールには、各 vSphere オブジェクトに最小限の権限セットを割り当てる特権セットを含めることができます。つまり、CSI ドライバー、vSphere CSI Driver Operator、および vSphere Problem Detector Operator はこれらのオブジェクトとの基本的な対話を確立できます。

重要

vCenter への OpenShift Container Platform クラスターのインストールは、「必要な vCenter アカウントの特権」セクションで説明されているすべての特権のリストに対してテストされています。完全な権限リストに従うことで、一連の制限された権限を持つカスタムロールの作成時に発生する可能性のある予期しない動作やサポートされていない動作が発生する可能性を抑制できます。

サードパーティーの CSI ドライバーを削除するには、「サードパーティーの vSphere CSI ドライバーの削除」を参照してください。

6.22.7. サードパーティー vSphere CSI Driver Operator の削除

OpenShift Container Platform 4.13 以降へのクラスターアップグレードを有効にするには、サードパーティーの vSphere CSI ドライバーを削除し、Red Hat がサポートする組み込みドライバーがストレージを管理できるようにします。

OpenShift Container Platform 4.10 以降には、Red Hat がサポートする vSphere Container Storage Interface (CSI) Operator ドライバーの組み込みバージョンが含まれます。コミュニティーまたは別のベンダーが提供する vSphere CSI ドライバーをインストールした場合、OpenShift Container Platform の次のメジャーバージョン (4.13 以降など) への更新がクラスターで無効になる可能性があります。

OpenShift Container Platform 4.12 以降では、クラスターは引き続き完全にサポートされており、4.12.z などの 4.12 の z ストリームリリースの更新はブロックされませんが、OpenShift Container Platform の次のメジャーバージョンに更新する前に、サードパーティーの vSphere CSI Driver ドライバーを削除してこの状態を修正する必要があります。サードパーティーの vSphere CSI ドライバーの削除には、関連する永続ボリューム (PV) オブジェクトの削除が必要ないため、データ喪失は発生しません。

注記

以下の手順は完全ではない可能性があるため、ベンダーまたはコミュニティープロバイダーのアンインストールガイドを参照して、ドライバーおよびコンポーネントを完全に削除してください。

手順

  1. サードパーティーの vSphere CSI Driver(VMware vSphere Container Storage プラグイン) の Deployment および Daemonset オブジェクトを削除します。
  2. サードパーティーの vSphere CSI Driver で以前にインストールされた configmap およびシークレットオブジェクトを削除します。
  3. 次のコマンドを実行して、サードパーティーの vSphere CSI ドライバー CSIDriver オブジェクトを削除します。

    $ oc delete CSIDriver csi.vsphere.vmware.com

    出力例

    csidriver.storage.k8s.io "csi.vsphere.vmware.com" deleted

結果

OpenShift Container Platform クラスターからサードパーティーの vSphere CSI Driver を削除した後に、Red Hat の vSphere CSI Driver Operator のインストールが自動的に再開され、OpenShift Container Platform 4.11 以降へのアップグレードをブロックする可能性のある条件は自動的に削除されます。既存の vSphere CSI PV オブジェクトがある場合、それらのライフサイクルは Red Hat の vSphere CSI Driver Operator で管理されるようになります。

6.22.8. vSphere 永続ディスクの暗号化

vSphere 上で実行される OpenShift Container Platform では、仮想マシン (VM) と動的にプロビジョニングされた永続ボリューム (PV) を暗号化できます。

注記

OpenShift Container Platform は、RWX 暗号化 PV をサポートしていません。暗号化されたストレージポリシーを使用するストレージクラスから RWX PV をリクエストすることはできません。

PV を暗号化する前に仮想マシンを暗号化する必要があります。これは、インストール中またはインストール後に実行できます。

仮想マシンの暗号化の詳細は、以下を参照してください。

  • "仮想マシンを暗号化するための要件"
  • インストール時: RHCOS のインストールと OpenShift Container Platform ブートストラッププロセスの開始のステップ 7
  • "vSphere クラスターでの暗号化の有効化"

VM を暗号化した後、vSphere Container Storage Interface (CSI) ドライバーを使用して、動的暗号化ボリュームプロビジョニングをサポートするストレージクラスを設定できます。これは、次の 2 つの方法のいずれかで実行できます。

  • データストア URL: このアプローチは柔軟性があまり高くないため、単一のデータストアを使用する必要があります。また、トポロジーを意識したプロビジョニングもサポートしていません。
  • タグベースの配置: プロビジョニングされたボリュームを暗号化し、タグベースの配置を使用して特定のデータストアをターゲットにします。

6.22.8.1. データストア URL の使用

特定のデータストアをターゲットにして永続ボリュームを暗号化するには、暗号化対応のストレージポリシーとデータストア URL を参照するストレージクラスを作成します。

手順

  1. 暗号化をサポートするデータストア内のデフォルトのストレージポリシーの名前を見つけます。

    これは、VM の暗号化に使用されたポリシーと同じです。

  2. このストレージポリシーを使用するストレージクラスを作成します。

    kind: StorageClass
    apiVersion: storage.k8s.io/v1
    metadata:
     name: encryption
    provisioner: csi.vsphere.vmware.com
    parameters:
     storagePolicyName: <storage-policy-name>
     datastoreurl: "ds:///vmfs/volumes/vsan:522e875627d-b090c96b526bb79c/"

    parameters.storagePolicyName は、暗号化をサポートするデータストア内のデフォルトのストレージポリシーの名前です。

6.22.8.2. タグベースの配置の使用

柔軟なデータストア選択で永続ボリュームを暗号化するには、vCenter タグを通じて複数のデータストアを対象とし、トポロジー対応のプロビジョニングをサポートするタグベースの配置を使用します。

手順

  1. vCenter で、このストレージクラスで使用できるデータストアにタグを付けるためのカテゴリーを作成します。また、作成されたカテゴリーの関連付け可能なエンティティーとして StoragePod (Datastore クラスター)、Datastore、および Folder が選択されていることを確認します。
  2. vCenter で、前に作成したカテゴリーを使用するタグを作成します。
  3. 以前に作成したタグを、ストレージクラスで使用できる各データストアに割り当てます。データストアが OpenShift Container Platform クラスターに参加しているホストと共有されていることを確認してください。
  4. vCenter で、メインメニューから Policies and Profiles をクリックします。
  5. Policies and Profiles ページのナビゲーションペインで、VM Storage Policies をクリックします。
  6. CREATE をクリックします。
  7. ストレージポリシーの名前を入力します。
  8. Enable host based rules および Enable tag based placement rules を選択します。
  9. Next タブで:

    1. Encryption および Default Encryption Properties を選択します。
    2. 先ほど作成したタグカテゴリーを選択し、選択したタグを選択します。ポリシーが一致するデータストアを選択していることを確認します。
  10. ストレージポリシーを作成します。
  11. ストレージポリシーを使用するストレージクラスを作成します。

    kind: StorageClass
    apiVersion: storage.k8s.io/v1
    metadata:
     name:  csi-encrypted
    provisioner: csi.vsphere.vmware.com
    reclaimPolicy: Delete
    volumeBindingMode: WaitForFirstConsumer
    parameters:
     storagePolicyName: <storage-policy-name>

    parameters.storagePolicyName は、暗号化用に作成したストレージポリシーの名前です。

6.22.9. vSphere CSI の複数の vCenter サポート

共有ストレージなしで vSphere インフラストラクチャー全体で高可用性を実現するには、OpenShift Container Platform のインストール時に最大 3 つの vCenter クラスターを設定します。

OpenShift Container Platform v4.17 以降では、この機能がサポートされています。

注記

複数の vCenter は、インストール時 にのみ設定できます。インストール後に複数の vCenter を設定することは できません。

サポートされる vCenter クラスターの最大数は 3 です。

6.22.9.1. インストール時に複数の vCenter を設定する

共有ストレージなしで高可用性を実現するマルチ vCenter サポートを有効にするには、クラスターをデプロイする前に、インストール設定で複数の vSphere クラスターを指定します。

手順

  • インストール時に複数の vSphere クラスターを指定します。詳細は、「vSphere のインストール設定パラメーター」を参照してください。

6.22.10. vSphere CSI トポロジーの概要

トポロジー対応のストレージプロビジョニングを使用して複数の vSphere ゾーンとリージョンに OpenShift Container Platform をデプロイすることで、クラスターの耐障害性を高め、単一障害点を回避できます。

これは、vCenter でゾーンとリージョンのカテゴリーを定義し、これらのゾーンとリージョンのカテゴリーのタグを作成して、コンピューティングクラスターなどのさまざまな障害ドメインにこれらのカテゴリーを割り当てることによって実現されます。適切なカテゴリーを作成し、vCenter オブジェクトにタグを割り当てたら、それらの障害ドメインで Pod のスケジュールを担当する仮想マシン (VM) を作成する追加のマシンセットを作成できます。

次の例では、1 つのリージョンと 2 つのゾーンを持つ 2 つの障害ドメインを定義しています。

表6.6 1 つのリージョンと 2 つのゾーンを含む vSphere ストレージトポロジー
計算クラスター障害ドメイン説明

コンピュートクラスター: ocp1、データセンター: アトランタ

openshift-region: us-east-1 (タグ)、openshift-zone: us-east-1a (タグ)

これにより、リージョン us-east-1 にゾーン us-east-1a を持つ障害ドメインが定義されます。

コンピュータークラスター: ocp2、データセンター: アトランタ

openshift-region: us-east-1 (タグ)、openshift-zone: us-east-1b (タグ)

これにより、us-east-1b と呼ばれる同じリージョン内の別の障害ドメインが定義されます。

6.22.10.1. vSphere CSI トポロジーの要件

vSphere CSI トポロジーには次のガイドラインが推奨されます。

  • トポロジータグは、ホストではなく、データセンターとコンピュートクラスターに追加することを強く推奨します。

    vsphere-problem-detector は、データセンターまたはコンピュートクラスターレベルで openshift-region または openshift-zone タグが定義されていない場合にアラートを発し、各トポロジータグ (openshift-region または openshift-zone) は階層内で 1 回だけ出現する必要があります。

    注記

    この推奨事項を無視すると、CSI ドライバーからのログ警告のみが発生し、ホストなどの階層の下位にある重複タグは無視されます。VMware はこれを無効な設定と見なすため、問題を防ぐためにはこれを使用しないでください。

  • トポロジー対応環境でのボリュームプロビジョニング要求は、特定のトポロジーセグメントの下にあるすべてのホストからアクセス可能なデータストアにボリュームを作成しようとします。これには、Kubernetes ノード仮想マシンが実行されていないホストも含まれます。たとえば、vSphere Container Storage プラグインドライバーが、データセンター dc-1 に適用された zone-a のボリュームをプロビジョニングする要求を受信した場合、dc-1 の下にあるすべてのホストは、ボリュームのプロビジョニング用に選択されたデータストアにアクセスできる必要があります。ホストには、dc-1 の直下にあるホストと、dc-1 内のクラスターの一部であるホストが含まれます。
  • 追加の推奨事項は、VMware の トポロジーを使用したデプロイメントに関するガイドラインとベストプラクティス セクションを参照してください。

6.22.10.2. インストール時の vSphere ストレージトポロジーの作成

vSphere 障害ドメイン全体でトポロジー対応ストレージの自動プロビジョニングを有効にするには、クラスターのインストール時にリージョンとゾーンを設定します。

手順

  • インストール時にトポロジーを指定します。「VMware vCenter のリージョンとゾーンの設定」を参照してください。

    追加のアクションは必要ありません。OpenShift Container Platform によって作成されるデフォルトのストレージクラスはトポロジーを認識し、さまざまな障害ドメインでのボリュームのプロビジョニングを許可します。

6.22.10.3. インストール後に vSphere ストレージトポロジーを作成する

クラスターのインストール後にトポロジー対応のストレージプロビジョニングを有効にするには、vCenter タグを設定し、障害ドメインを作成し、特定のゾーンとリージョンのデータストアを対象とするストレージクラスを定義します。

手順

  1. VMware vCenter vSphere クライアント GUI で、適切なゾーンとリージョンのカテゴリーとタグを定義します。

    vSphere では任意の名前でカテゴリーを作成できますが、OpenShift Container Platform では、トポロジーカテゴリーの定義に openshift-region 名と openshift-zone 名を使用することを強く推奨します。

    vSphere のカテゴリーとタグの詳細は、VMware vCenter のドキュメントを参照してください。

  2. OpenShift Container Platform で、障害ドメインを作成します。詳細は、VSphere 上のクラスターに複数のリージョンとゾーンの指定 を参照してください。
  3. 障害ドメイン全体のデータストアに割り当てるタグを作成します。

    OpenShift Container Platform が複数の障害ドメインにまたがる場合、データストアがそれらの障害ドメイン間で共有されない可能性があります。この場合、永続ボリューム (PV) のトポロジーを意識したプロビジョニングが役立ちます。

    1. vCenter で、データストアにタグを付けるためのカテゴリーを作成します。例: openshift-zonal-datastore-cat。カテゴリーが OpenShift Container Platform クラスターに参加するデータストアのタグ付けに一意に使用される場合、他のカテゴリー名を使用できます。また、作成したカテゴリーの関連付け可能なエンティティーとして StoragePod、Datastore、および Folder が選択されていることを確認します。
    2. vCenter で、以前に作成したカテゴリーを使用するタグを作成します。この例では、タグ名 openshift-zonal-datastore を使用しています。
    3. 以前に作成したタグ (この例では openshift-zonal-datastore) を、動的プロビジョニングと見なされる障害ドメイン内の各データストアに割り当てます。

      注記

      データストアのカテゴリーとタグには任意の名前を使用できます。この例で使用されている名前は、推奨事項として提供されています。定義するタグとカテゴリーが、OpenShift Container Platform クラスター内のすべてのホストと共有されるデータストアのみを一意に識別するようにします。

  4. 必要に応じて、各障害ドメイン内のタグベースのデータストアを対象とするストレージポリシーを作成します。

    1. vCenter で、メインメニューから Policies and Profiles をクリックします。
    2. Policies and Profiles ページのナビゲーションペインで、VM Storage Policies をクリックします。
    3. CREATE をクリックします。
    4. ストレージポリシーの名前を入力します。
    5. ルールには、Tag Placement rules を選択し、目的のデータストアを対象とするタグとカテゴリーを選択します (この例では、openshift-zonal-datastore タグ)。

      データストアは、ストレージ互換性テーブルにリストされています。

  5. 新しいゾーンストレージポリシーを使用する新しいストレージクラスを作成します。

    1. Storage > StorageClasses をクリックします。
    2. StorageClasses ページで、Create StorageClass をクリックします。
    3. Name に新しいストレージクラスの名前を入力します。
    4. Provisioner で、csi.vsphere.vmware.com を選択します。
    5. Additional parameters で、StoragePolicyName パラメーターの Value を、前に作成した新しいゾーンストレージポリシーの名前に設定します。
    6. Create をクリックします。

      出力例

      kind: StorageClass
      apiVersion: storage.k8s.io/v1
      metadata:
        name: zoned-sc
      provisioner: csi.vsphere.vmware.com
      parameters:
        StoragePolicyName: zoned-storage-policy
      reclaimPolicy: Delete
      allowVolumeExpansion: true
      volumeBindingMode: WaitForFirstConsumer

      • metadata.name: 新しいトポロジー対応ストレージクラス名。
      • parameters.StoragePolicyName: ゾーン化されたストレージポリシーを指定します。

        注記

        前述の YAML ファイルを編集し、コマンド oc create -f $FILE を実行して、ストレージクラスを作成することもできます。

6.22.10.4. インフラトポロジーを使用しない vSphere ストレージトポロジーの作成

インフラストラクチャーオブジェクトを使用せずにトポロジー対応ストレージプロビジョニングを設定するには、vCenter のカテゴリーとタグを定義し、トポロジーゾーンとリージョンを認識するように ClusterCSIDriver オブジェクトを設定します。

注記

OpenShift Container Platform は、トポロジー対応セットアップで障害ドメインを指定するためにインフラストラクチャーオブジェクトを使用することを推奨します。インフラストラクチャーオブジェクトで障害ドメインを指定し、同時に ClusterCSIDriver オブジェクトでトポロジーカテゴリーを指定することは、サポートされていない操作です。

手順

  1. VMware vCenter vSphere クライアント GUI で、適切なゾーンとリージョンのカテゴリーとタグを定義します。

    vSphere では任意の名前でカテゴリーを作成できますが、OpenShift Container Platform では、トポロジーを定義するために openshift-region および openshift-zone 名を使用することを強く推奨します。

    vSphere のカテゴリーとタグの詳細は、VMware vCenter のドキュメントを参照してください。

  2. Container Storage Interface (CSI) ドライバーがこのトポロジーを検出できるようにするには、clusterCSIDriver オブジェクトの YAML ファイルの driverConfig セクションを編集します。

    • 以前に作成した openshift-zone および openshift-region カテゴリーを指定します。
    • driverType を vSphere に設定します。

      ~ $ oc edit clustercsidriver csi.vsphere.vmware.com -o yaml

      出力例

      apiVersion: operator.openshift.io/v1
      kind: ClusterCSIDriver
      metadata:
        name: csi.vsphere.vmware.com
      spec:
        logLevel: Normal
        managementState: Managed
        observedConfig: null
        operatorLogLevel: Normal
        unsupportedConfigOverrides: null
        driverConfig:
          driverType: vSphere
            vSphere:
              topologyCategories:
              - openshift-zone
              - openshift-region

      • spec.driverConfig.driverType: driverType が vSphere に設定されていることを確認します。
      • spec.driverConfig.driverType.vSphere.topologyCategories: vCenter で以前に作成されたオープンシフトゾーンおよびオープンシフトリージョンカテゴリー。
  3. 次のコマンドを実行して、CSINode オブジェクトにトポロジーキーがあることを確認します。

    ~ $ oc get csinode

    出力例

    NAME DRIVERS AGE
    co8-4s88d-infra-2m5vd 1 27m
    co8-4s88d-master-0 1 70m
    co8-4s88d-master-1 1 70m
    co8-4s88d-master-2 1 70m
    co8-4s88d-worker-j2hmg 1 47m
    co8-4s88d-worker-mbb46 1 47m
    co8-4s88d-worker-zlk7d 1 47m

    ~ $ oc get csinode co8-4s88d-worker-j2hmg -o yaml

    出力例

    ...
    spec:
      drivers:
      - allocatable:
          count: 59
      name: csi-vsphere.vmware.com
      nodeID: co8-4s88d-worker-j2hmg
      topologyKeys:
      - topology.csi.vmware.com/openshift-zone
      - topology.csi.vmware.com/openshift-region

    spec.topologyKeys は、vSphere openshift-zone および openshift-region カテゴリーのトポロジーキーを示します。

    注記

    CSINode オブジェクトは、更新されたトポロジー情報を受信するのに時間がかかる場合があります。ドライバーが更新された後、CSINode オブジェクトにはトポロジーキーが含まれている必要があります。

  4. 障害ドメイン全体のデータストアに割り当てるタグを作成します。

    OpenShift Container Platform が複数の障害ドメインにまたがる場合、データストアがそれらの障害ドメイン間で共有されない可能性があります。この場合、永続ボリューム (PV) のトポロジーを意識したプロビジョニングが役立ちます。

    1. vCenter で、データストアにタグを付けるためのカテゴリーを作成します。例: openshift-zonal-datastore-cat。カテゴリーが OpenShift Container Platform クラスターに参加するデータストアのタグ付けに一意に使用される場合、他のカテゴリー名を使用できます。また、作成したカテゴリーの関連付け可能なエンティティーとして StoragePod、Datastore、および Folder が選択されていることを確認します。
    2. vCenter で、以前に作成したカテゴリーを使用するタグを作成します。この例では、タグ名 openshift-zonal-datastore を使用しています。
    3. 以前に作成したタグ (この例では openshift-zonal-datastore) を、動的プロビジョニングと見なされる障害ドメイン内の各データストアに割り当てます。

      注記

      カテゴリーとタグには、好きな名前を使用できます。この例で使用されている名前は、推奨事項として提供されています。定義するタグとカテゴリーが、OpenShift Container Platform クラスター内のすべてのホストと共有されるデータストアのみを一意に識別するようにします。

  5. 各障害ドメインのタグベースのデータストアを対象とするストレージポリシーを作成します。

    1. vCenter で、メインメニューから Policies and Profiles をクリックします。
    2. Policies and Profiles ページのナビゲーションペインで、VM Storage Policies をクリックします。
    3. CREATE をクリックします。
    4. ストレージポリシーの名前を入力します。
    5. ルールには、Tag Placement rules を選択し、目的のデータストアを対象とするタグとカテゴリーを選択します (この例では、openshift-zonal-datastore タグ)。

      データストアは、ストレージ互換性テーブルにリストされています。

  6. 新しいゾーンストレージポリシーを使用する新しいストレージクラスを作成します。

    1. Storage > StorageClasses をクリックします。
    2. StorageClasses ページで、Create StorageClass をクリックします。
    3. Name に新しいストレージクラスの名前を入力します。
    4. Provisioner で、csi.vsphere.vmware.com を選択します。
    5. Additional parameters で、StoragePolicyName パラメーターの Value を、前に作成した新しいゾーンストレージポリシーの名前に設定します。
    6. Create をクリックします。

      出力例

      kind: StorageClass
      apiVersion: storage.k8s.io/v1
      metadata:
        name: zoned-sc
      provisioner: csi.vsphere.vmware.com
      parameters:
        StoragePolicyName: zoned-storage-policy
      reclaimPolicy: Delete
      allowVolumeExpansion: true
      volumeBindingMode: WaitForFirstConsumer

      • metadata.name: 新しいトポロジー対応ストレージクラス名。
      • parameters.StoragePolicyName: ゾーン化されたストレージポリシーを指定します。

        注記

        前述の YAML ファイルを編集し、コマンド oc create -f $FILE を実行して、ストレージクラスを作成することもできます。

6.22.10.5. vSphereトトポロジーの結果

トポロジー対応のストレージプロビジョニングが正しく機能していることを確認するには、永続ボリュームに Pod のスケジューリング要件と一致するゾーンおよびリージョンノードのアフィニティーラベルが含まれていることを確認します。

トポロジー対応ストレージクラスからの永続ボリュームクレーム (PVC) と PV の作成は完全にゾーンであり、Pod のスケジュール方法に応じて、それぞれのゾーンでデータストアを使用する必要があります。

手順

  • 次のコマンドを実行して、永続ボリュームに想定どおりにゾーンおよびリージョンラベルが含まれていることを確認します。

    $ oc get pv <pv_name> -o yaml

    出力例

    ...
    nodeAffinity:
      required:
        nodeSelectorTerms:
        - matchExpressions:
          - key: topology.csi.vmware.com/openshift-zone
            operator: In
            values:
            - <openshift_zone>
          - key: topology.csi.vmware.com/openshift-region
            operator: In
            values:
            - <openshift_region>
    ...
    peristentVolumeclaimPolicy: Delete
    storageClassName: <zoned_storage_class_name>
    volumeMode: Filesystem
    ...

    • nodeAffinity.required.nodeSelectorTerms.matchExpressions.key: PV にはゾーンキーがあります。
    • storageClassName: PV はゾーン化されたストレージクラスを使用しています。

6.22.11. vSphere のスナップショットの最大数の変更

vSphere 環境でストレージ容量とパフォーマンスのバランスを取るには、ボリュームあたりのスナップショットの最大数をグローバルまたは特定のデータストアタイプに設定します。

vSphere Container Storage Interface (CSI) のボリュームあたりのスナップショットのデフォルトの最大数は 3 です。1 ボリュームあたり最大 32 個まで変更できます。ただし、スナップショットの最大値を増やすとパフォーマンスとのトレードオフが発生するため、パフォーマンスを向上させるには、ボリュームごとに 2 - 3 個のスナップショットのみを使用するようにしてください。

VMware スナップショットのパフォーマンスに関する推奨事項は、「vSphere 環境で VMware スナップショットを使用するためのベストプラクティス」を参照してください。

前提条件

  • 管理者権限でクラスターにアクセスできる。

手順

  1. 次のコマンドを実行して、現在のシークレットを確認します。

    $ oc -n openshift-cluster-csi-drivers get secret/vsphere-csi-config-secret -o jsonpath='{.data.cloud\.conf}' | base64 -d

    出力例

    # Labels with topology values are added dynamically via operator
    [Global]
    cluster-id = vsphere-01-cwv8p
    
    # Populate VCenters (multi) after here
    [VirtualCenter "vcenter.openshift.com"]
    insecure-flag           = true
    datacenters             = DEVQEdatacenter
    password                = "xxxxxxxx"
    user                    = "xxxxxxxx@devcluster.openshift.com"
    migration-datastore-url = ds:///vmfs/volumes/vsan:52c842f232751e0d-3253aadeac21ca82/

    この例では、スナップショットのグローバル最大数は設定されていないため、デフォルト値の 3 が適用されます。

  2. 次のコマンドを実行してスナップショットの制限を変更します。

    • global スナップショット制限を設定します。

      $ oc patch clustercsidriver/csi.vsphere.vmware.com --type=merge -p '{"spec":{"driverConfig":{"vSphere":{"globalMaxSnapshotsPerBlockVolume": 10}}}}'
      
      clustercsidriver.operator.openshift.io/csi.vsphere.vmware.com patched

      この例では、グローバル制限が 10 に変更されます (globalMaxSnapshotsPerBlockVolume が 10 に設定されています)。

    • 仮想ボリューム のスナップショット制限を設定します。

      このパラメーターは、仮想ボリュームデータストアのみに制限を設定します。仮想ボリュームの最大スナップショット制限は、設定されている場合はグローバル制約をオーバーライドしますが、設定されていない場合はデフォルトでグローバル制限になります。

      $ oc patch clustercsidriver/csi.vsphere.vmware.com --type=merge -p '{"spec":{"driverConfig":{"vSphere":{"granularMaxSnapshotsPerBlockVolumeInVVOL": 5}}}}'
      clustercsidriver.operator.openshift.io/csi.vsphere.vmware.com patched

      この例では、仮想ボリュームの制限が 5 に変更されます (granularMaxSnapshotsPerBlockVolumeInVVOL が 5 に設定されています)。

    • vSAN スナップショットの制限を設定します。

      このパラメーターは、vSAN データストアのみに制限を設定します。vSAN の最大スナップショット制限は、設定されている場合はグローバル制約をオーバーライドしますが、設定されていない場合はデフォルトでグローバル制限になります。vSAN ESA セットアップでは、最大値 32 を設定できます。

      $ oc patch clustercsidriver/csi.vsphere.vmware.com --type=merge -p '{"spec":{"driverConfig":{"vSphere":{"granularMaxSnapshotsPerBlockVolumeInVSAN": 7}}}}'
      clustercsidriver.operator.openshift.io/csi.vsphere.vmware.com patched

      この例では、vSAN 制限が 7 に変更されます (granularMaxSnapshotsPerBlockVolumeInVSAN が 7 に設定されています)。

検証

  • 次のコマンドを実行して、行った変更が config map に反映されていることを確認します。

    $ oc -n openshift-cluster-csi-drivers get secret/vsphere-csi-config-secret -o jsonpath='{.data.cloud\.conf}' | base64 -d

    出力例

    # Labels with topology values are added dynamically via operator
    [Global]
    cluster-id = vsphere-01-cwv8p
    
    # Populate VCenters (multi) after here
    [VirtualCenter "vcenter.openshift.com"]
    insecure-flag           = true
    datacenters             = DEVQEdatacenter
    password                = "xxxxxxxx"
    user                    = "xxxxxxxx@devcluster.openshift.com"
    migration-datastore-url = ds:///vmfs/volumes/vsan:52c842f232751e0d-3253aadeac21ca82/
    
    [Snapshot]
    global-max-snapshots-per-block-volume = 10

    global-max-snapshots-per-block-volume パラメーターが 10 に設定されました。

6.22.12. vSphere のデータストア間での CNS ボリュームの移行

ストレージのパフォーマンスを最適化したり、容量を解放したりするために、vSphere Cloud Native Storage (CNS) ボリュームをデータストア間でデータロスなく移行できます。

現在のデータストアの容量が不足している場合、またはよりパフォーマンスの高いデータストアに移行する場合は、VMware CNS ボリュームをデータストア間で移行できます。これは、接続されたボリュームと切断されたボリュームの両方に適用されます。

6.22.12.1. 制限事項

  • VMware vSphere 8.0.2 以降、または VMware vSphere Foundation (VVF) 9、または VMware Cloud Foundation (VCF) 9 が必要です。
  • 一度に移行できるのは 1 つのボリュームのみです。
  • RWX ボリュームはサポートされていません。
  • CNS ボリュームは、OpenShift Container Platform クラスターを構成するすべてのホストで共有されるデータストアにしか移行できません。
  • 異なるデータセンター内の異なるデータストア間でボリュームを移行することはサポートされていません。
  • VMware HCX はサポートされていません。

6.22.12.2. その他の制限

その他の制限事項は、「vSphere 8 の場合」、「VCF 9 の場合」、「vSphere v8.0 の場合、より一般的な情報」、および「VCF 9 の場合、より一般的な情報」を参照してください。

6.22.13. vSphere でのストレージの無効化と有効化

Day 2 操作中に vSphere 環境とのストレージ統合を制御するには、必要に応じて VMware vSphere Container Storage Interface (CSI) Driver を無効にしてから再度有効にします。

6.22.13.1. vSphere でストレージを無効または有効にした場合の影響

vSphere ストレージを無効化または再度有効化する前に、永続ボリューム、Pod、ストレージクラス、および Container Storage Interface (CSI) ドライバーコンポーネントへの影響を把握してください。

vSphere でストレージを無効および有効にした場合の影響は、次の表で説明します。

表6.7 vSphere でストレージを無効化/有効化した場合の影響
無効化手順 5 の有効化に進みます。
  • vSphere CSI Driver Operator は、CSI ドライバーをアンインストールします。
  • ストレージコンテナーオーケストレーション (CO) は正常である必要があります。
  • vSphere-problem-detector は引き続き実行されますが、アラートやイベントは出力されず、チェックの頻度も低くなります (24 時間に 1 回)。
  • 既存の永続ボリューム (PV)、永続ボリューム要求 (PVC)、および vSphere ストレージポリシーはすべて変更されません。

    • vSphere PV は新しい Pod では使用できません。
    • vSphere PV は、既存の Pod の既存のノードに永久にマウントされ、接続されたままになります。これらの Pod は削除後も無期限に終了状態のままになります。
  • ストレージクラスは削除されています。

* vSphere CSI Driver Operator は CSI ドライバーを再インストールします。

* 必要に応じて、vSphere CSI Driver Operator が vSphere ストレージポリシーを作成します。

6.22.13.2. vSphere でのストレージの無効化と有効化

vSphere ストレージとクラスターの統合を制御するには、ClusterCSIDriver リソースの管理状態を変更して、CSI ドライバーを無効または有効にします。

重要

この手順を実行する前に、「vSphere でストレージを無効または有効にした場合の影響」の表と、環境への潜在的な影響を慎重に確認してください。

手順

  1. Administration > CustomResourceDefinitions をクリックします。
  2. CustomResourceDefinitions ページの Name ドロップダウンボックスの横に、"clustercsidriver" と入力します。
  3. CRD ClusterCSIDriver をクリックします。
  4. Instances タブをクリックします。
  5. csi.vsphere.vmware.com をクリックします。
  6. YAML タブをクリックします。
  7. spec.managementState の値を Removed または Managed に変更します。

    • Removed: ストレージが無効になっています
    • Managed: ストレージが有効になっています
  8. Save をクリックします。
  9. ストレージを無効にする場合は、ドライバーが削除されていることを確認してください。

    1. Workloads > Pods をクリックします。
    2. Pods ページで、Name フィルターボックスに "vmware-vsphere-csi-driver" と入力します。

      表示される項目は Operator のみです。例: "vmware-vsphere-csi-driver-operator-559b97ffc5-w99fm"

6.22.14. ベアメタルノードの追加

vSphere 上の OpenShift Container Platform クラスターへのベアメタルノードの追加がサポートされます。ただし、ベアメタルノードを追加する前に vSphere CSI Driver を削除する必要があります。そうしないと、クラスターは degraded とマークされます。

重要

ベアメタルノードの追加は、テクノロジープレビュー機能です。テクノロジープレビュー機能は、Red Hat 製品のサービスレベルアグリーメント (SLA) の対象外であり、機能的に完全ではないことがあります。Red Hat は、実稼働環境でこれらを使用することを推奨していません。テクノロジープレビュー機能は、最新の製品機能をいち早く提供して、開発段階で機能のテストを行い、フィードバックを提供していただくことを目的としています。

Red Hat のテクノロジープレビュー機能のサポート範囲に関する詳細は、テクノロジープレビュー機能のサポート範囲 を参照してください。

6.22.15. vSphere のノードあたりの最大ボリューム数の増加

個々のノードでより多くのストレージボリュームをサポートするには、同種の vSphere 8 以降の環境でノードあたりの最大ボリュームを増やすことができます。

vSphere バージョン 8 以降、または VMware vSphere Foundation (VVF) 9、または VMware Cloud Foundation (VCF) 9 では、ノードあたりのボリューム許容数を最大 255 まで増やすことができます。それ以外の場合、デフォルト値は 59 のままになります。

重要

ESXi 8 ハイパーバイザーのみを含む同種の vSphere 8 環境、または ESXi 9 ハイパーバイザーのみを含む同種の VVF または VCF 9 環境が必要です。複数のバージョンの ESXi が混在する異種環境は使用できません。このような異種環境では、59 より大きい値を設定すると、クラスターのパフォーマンスが低下します。

制限事項
  • VMware vSphere バージョン 8 以降、または VVF 9、または VCF 9 を実行している必要があります。
  • 十分な数のノードでノードあたりの最大ボリューム数を増やすと、仮想ディスクの制限 (ホストあたり 2048 個) を超える可能性があります。この制限を超えないようにするための vSphere の分散リソーススケジューラー (DRS) 検証がないため、そのような状況が発生する可能性があります。
重要

ノードあたりのボリュームを増やす機能は、テクノロジープレビュー機能です。テクノロジープレビュー機能は、Red Hat 製品のサービスレベルアグリーメント (SLA) の対象外であり、機能的に完全ではないことがあります。Red Hat は、実稼働環境でこれらを使用することを推奨していません。テクノロジープレビュー機能は、最新の製品機能をいち早く提供して、開発段階で機能のテストを行い、フィードバックを提供していただくことを目的としています。

Red Hat のテクノロジープレビュー機能のサポート範囲に関する詳細は、テクノロジープレビュー機能のサポート範囲 を参照してください。

6.22.15.1. vSphere のノードあたりの最大許容ボリュームを増やす

ノードごとに 59 を超える永続ボリュームを必要とするワークロードに対応するために、ClusterCSIDriver リソースを設定して最大許容ボリュームを増やします。

前提条件

  • OpenShift Container Platform Web コンソールにアクセスできる。
  • cluster-admin ロールを持つユーザーとしてクラスターにアクセスできる。
  • VMware vSphere vCenter にアクセスします。
  • vCenter で、パラメーター pvscsiCtrlr256DiskSupportEnabled が 'True' に設定されていることを確認します。

    重要

    VMware では、pvscsiCtrlr256DiskSupportEnabled パラメーターの変更は完全にサポートされていません。また、このパラメーターはクラスター全体のオプションです。

手順

  1. Administration > CustomResourceDefinitions をクリックします。
  2. CustomResourceDefinitions ページの Name ドロップダウンボックスの横に、"clustercsidriver" と入力します。
  3. CRD ClusterCSIDriver をクリックします。
  4. Instances タブをクリックします。
  5. csi.vsphere.vmware.com をクリックします。
  6. YAML タブをクリックします。
  7. パラメーター spec.driverConfig.driverType を vSphere に設定します。
  8. YAML ファイルにパラメーター spec.driverConfig.vSphere.maxAllowedBlockVolumesPerNode を追加し、次のサンプル YAML ファイルのように、ノードあたりの最大ボリューム数を必要な値に指定します。

    パラメーター maxAllowedBlockVolumesPerNode を追加するためのサンプル YAML ファイル

    ...
    spec:
      driverConfig:
        driverType: vSphere
        vSphere:
          maxAllowedBlockVolumesPerNode: 59
    ...

    maxAllowedBlockVolumesPerNode の場合は、ノードあたりの最大ボリューム数に必要な値を入力します。デフォルトは 59 です。最小値は 1、最大値は 255 です。

  9. Save をクリックします。
Red Hat logoGithubRedditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

会社概要

Red Hat は、企業がコアとなるデータセンターからネットワークエッジに至るまで、各種プラットフォームや環境全体で作業を簡素化できるように、強化されたソリューションを提供しています。

多様性を受け入れるオープンソースの強化

Red Hat では、コード、ドキュメント、Web プロパティーにおける配慮に欠ける用語の置き換えに取り組んでいます。このような変更は、段階的に実施される予定です。詳細情報: Red Hat ブログ.

Red Hat ドキュメントについて

Legal Notice

Theme

© 2026 Red Hat
トップに戻る