第9章 動的プロビジョニング
動的プロビジョニングでは、管理者は永続ボリューム (PV) のプールを手動で作成する代わりに、ストレージクラスを作成します。ストレージクラスを使用すると、OpenShift Container Platform はストレージバックエンドを自動的にトリガーして、要求された正確なサイズとタイプの新しいボリュームを作成し、PV オブジェクトを作成し、その後 PV を永続ボリューム要求 (PVC) にバインドします。
9.1. 動的プロビジョニングについて リンクのコピーリンクがクリップボードにコピーされました!
StorageClass リソースオブジェクトは、要求可能なストレージを記述および分類し、オンデマンドで動的にプロビジョニングされるストレージのパラメーターを渡す手段を提供します。
StorageClass オブジェクトは、さまざまなレベルのストレージとストレージへのアクセスを制御するための管理メカニズムとしても機能します。クラスター管理者 (cluster-admin) またはストレージ管理者 (storage-admin) は、ユーザーが基礎となるストレージボリュームソースに関する詳しい知識がなくても要求できる StorageClass オブジェクトを定義し、作成します。
OpenShift Container Platform の永続ボリュームフレームワークはこの機能を有効にし、管理者がクラスターに永続ストレージをプロビジョニングできるようにします。フレームワークにより、ユーザーは基礎となるインフラストラクチャーの知識がなくてもこれらのリソースを要求できるようになります。
OpenShift Container Platform では、数多くのストレージタイプを永続ボリュームとして使用することができます。これらはすべて管理者によって静的にプロビジョニングされますが、一部のストレージタイプは組み込みプロバイダーとプラグイン API を使用して動的に作成できます。
9.2. 利用可能な動的プロビジョニングプラグイン リンクのコピーリンクがクリップボードにコピーされました!
プロビジョナープラグインは、クラウドプロバイダーの API に接続することで、必要に応じてストレージリソースを自動的に作成します。これにより、手動による介入なしに永続ボリューム (PV) を動的にプロビジョニングし、クラスターのストレージニーズに応じて柔軟に対応できます。
選択したプロビジョナープラグインは、関連するドキュメントに記載されているとおり、該当するクラウド、ホスト、またはサードパーティープロバイダーの設定も必要となります。
| ストレージタイプ | プロビジョナープラグインの名前 | 注記 |
|---|---|---|
| Red Hat OpenStack Platform (RHOSP) Cinder |
| |
| RHOSP Manila Container Storage Interface (CSI) |
| インストール後、OpenStack Manila CSI Driver Operator と ManilaDriver は、動的プロビジョニングに必要なすべての利用可能な Manila 共有タイプに対応するストレージクラスを自動的に作成します。 |
| Amazon Elastic Block Store (Amazon EBS) |
|
複数クラスターを複数の異なるゾーンで使用する際の動的プロビジョニングの場合は、各ノードに |
| Azure Disk |
| |
| Azure File |
|
|
| GCE Persistent Disk (gcePD) |
| マルチゾーン設定の場合、現在のクラスターにノードが存在しないゾーンに永続ボリューム (PV) が作成されることを避けるため、GCE プロジェクトごとに 1 つの OpenShift Container Platform クラスターを実行することを推奨します。 |
| IBM Power® 仮想サーバーブロック |
| インストール後、IBM Power® Virtual Server Block CSI Driver Operator と IBM Power® Virtual Server Block CSI Driver は、動的プロビジョニングに必要なストレージクラスを自動的に作成します。 |
| VMware vSphere |
|
9.3. ストレージクラスの定義 リンクのコピーリンクがクリップボードにコピーされました!
StorageClass オブジェクトはクラスター全体に適用され、すべての名前空間で利用可能です。cluster-admin またはストレージ管理者の特権を持つユーザーのみが、それらを作成または変更できます。
この集中管理により、クラスター全体で一貫したストレージポリシーが確保される一方で、アプリケーションチームはカスタムストレージ設定について管理者と連携する必要が生じます。
Cluster Storage Operator は、使用されるプラットフォームに応じてデフォルトのストレージクラスをインストールする可能性があります。このストレージクラスは Operator によって所有され、制御されます。アノテーションとラベルを定義するほかは、これを削除したり、変更したりすることはできません。異なる動作が必要な場合は、カスタムストレージクラスを定義する必要があります。
以下のセクションでは、StorageClass オブジェクトの基本的な定義とサポートされている各プラグインタイプの具体的な例を説明します。
9.3.1. 基本 StorageClass オブジェクト定義 リンクのコピーリンクがクリップボードにコピーされました!
StorageClass オブジェクトは、クラスター内で永続ボリューム (PV) が動的に作成される方法を決定するメタデータ、プロビジョナータイプ、およびプラグイン固有のパラメーターを定義します。
ストレージプロビジョナーの種類ごとに必要なパラメーターが異なり、アノテーションによってクラスター全体のデフォルト設定が制御されるため、この構造がすべての動的ストレージプロビジョニングの基盤となります。
StorageClass 定義の例
kind: StorageClass
apiVersion: storage.k8s.io/v1
metadata:
name: <storage-class-name>
annotations:
storageclass.kubernetes.io/is-default-class: 'true'
...
provisioner: kubernetes.io/aws-ebs
parameters:
type: gp3
...
-
種類:API オブジェクト型。 -
apiversion: 現在の apiVersion。 -
metadata.name: ストレージクラスの名前。 -
オプション:
metadata.annotations: ストレージクラスのアノテーション。 -
プロビジョナー: このストレージクラスに関連付けられているプロビジョナーの種類。 -
オプション:
パラメーター: 特定のプロビジョナーに必要なパラメーター。これはプラグインごとに異なります。
9.3.2. RHOSP Cinder StorageObject オブジェクト定義 リンクのコピーリンクがクリップボードにコピーされました!
この RHOSP Cinder ストレージクラスの例では、パフォーマンス最適化のためのボリュームタイプの設定方法、高可用性を実現するためのアベイラビリティーゾーン配置の制御方法、および永続ボリュームのファイルシステムタイプを指定する方法を示します。
Cinder ストレージクラスの YAML ファイル例
kind: StorageClass
apiVersion: storage.k8s.io/v1
metadata:
name: <storage-class-name>
provisioner: kubernetes.io/cinder
parameters:
type: fast
availability: nova
fsType: ext4
-
metadata.name: ストレージクラスの名前。永続ボリューム要求は、関連する永続ボリュームをプロビジョニングするためにこのストレージクラスを使用します。 -
parameter.type: Cinder で作成されたボリュームタイプ。デフォルトは空です。 -
parameters.availability: アベイラビリティーゾーン。特に指定がない場合、ボリュームは通常、OpenShift Container Platform クラスターにノードが存在するすべてのアクティブゾーンにラウンドロビン方式で分散されます。 -
parameters.fsType: 動的にプロビジョニングされたボリューム上に作成されるファイルシステム。この値は、動的にプロビジョニングされた永続ボリュームのfsTypeフィールドにコピーされ、ボリュームが初めてマウントされたときにファイルシステムが作成されます。デフォルト値はext4です。以下は、RHOSP Cinder におけるストレージクラスオブジェクト定義の例です。
9.3.3. RHOSP Manila Container Storage Interface (CSI) オブジェクト定義 リンクのコピーリンクがクリップボードにコピーされました!
OpenStack Manila CSI ドライバー Operator は、インストール後すぐに利用可能なすべての Manila 共有タイプに対応するストレージクラスを自動的に作成するため、手動による設定は不要です。
この自動化により、Manila 共有タイプの詳細を理解したり、カスタム StorageClass 定義を作成したりすることなく、永続ボリュームのプロビジョニングをすぐに開始できます。
9.3.4. AWS Elastic Block Store (EBS) StorageObject オブジェクト定義 リンクのコピーリンクがクリップボードにコピーされました!
この AWS EBS ストレージクラスの例では、動的にプロビジョニングされた永続ボリュームのボリュームタイプ、IOPS パフォーマンス、暗号化設定、およびファイルシステムタイプを設定する方法を示します。
AWS EBS ストレージクラスの YAML ファイルの例
kind: StorageClass
apiVersion: storage.k8s.io/v1
metadata:
name: <storage-class-name>
provisioner: ebs.csi.aws.com
parameters:
type: io1
iopsPerGB: "10"
encrypted: "true"
kmsKeyId: keyvalue
fsType: ext4
-
metadata.name: ストレージクラスの名前。永続ボリューム要求は、関連する永続ボリュームをプロビジョニングするためにこのストレージクラスを使用します。 -
parameters.type:io1、gp3、sc1、st1から選択します。デフォルトはgp3です。有効な Amazon Resource Name (ARN) の値については、AWS ドキュメント Amazon リソースネーム (ARN) を使用して AWS リソースを識別するを 参照してください。 オプション:
parameters.iopsPerGB。io1 ボリュームのみ。1 GiB あたり 1 秒あたりの I/O 処理数。AWS ボリュームプラグインは、この値と要求されたボリュームのサイズを乗算してボリュームの IOPS を算出します。最大値は 20,000 IOPS で、これは AWS がサポートする最大値です。
詳細は、AWS ドキュメント Amazon リソースネーム (ARN) を使用して AWS リソースを識別するを 参照してください。
-
オプション:
パラメーター.encrypted。EBS ボリュームを暗号化するかどうかを示します。有効な値はtrueまたはfalseです。 オプション:
parameters.kmsKeyId。ボリュームを暗号化する際に使用するキーの完全な ARN。値を指定しない場合でもencyptedがtrueに設定されている場合は、AWS によってキーが生成されます。有効な ARN 値については、AWS ドキュメント Amazon リソース名 (ARN) を使用して AWS リソースを識別するを 参照してください。
-
オプション:
parameters.fsType。動的にプロビジョニングされたボリュームで作成されるファイルシステム。この値は、動的にプロビジョニングされた永続ボリュームのfsTypeフィールドにコピーされ、ボリュームが初めてマウントされたときにファイルシステムが作成されます。デフォルト値はext4です。
9.3.5. Azure Disk StorageClass オブジェクト定義 リンクのコピーリンクがクリップボードにコピーされました!
この Azure Disk ストレージクラスの例では、最適なゾーン配置、ボリューム拡張、およびパフォーマンス階層を実現するために、遅延ボリュームバインディングを使用してマネージドディスクを設定する方法を示します。
主要なパラメーターは、共有ストレージアカウントや専用ストレージアカウントではなく、マネージドディスクを必要とする OpenShift ノードとの互換性を確保します。
Azure Disk ストレージクラスの YAML ファイルの例
apiVersion: storage.k8s.io/v1
kind: StorageClass
metadata:
name: <storage-class-name>
provisioner: kubernetes.io/azure-disk
volumeBindingMode: WaitForFirstConsumer
allowVolumeExpansion: true
parameters:
kind: Managed
storageaccounttype: Premium_LRS
reclaimPolicy: Delete
-
metadata.name: ストレージクラスの名前。永続ボリューム要求は、関連する永続ボリュームをプロビジョニングするためにこのストレージクラスを使用します。 -
volumeBindingMode:WaitForFirstConsumer の使用を強く推奨します。これにより、Pod を利用可能なゾーンから空きのあるワーカーノードにスケジュールするのに十分なストレージがボリュームプロビジョニングされます。 parameters.kind: 指定可能な値はShared(デフォルト)、Managed、およびDedicated です。重要Red Hat は
Managedの使用のみをサポートしています。Azure では、
共有ディスクと専用ディスクの両方で管理対象外のディスクが作成されますが、OpenShift Container Platform では、マシンのオペレーティングシステム (ルート) ディスク用に管理対象のディスクが作成されます。ただし、Azure Disk はノードで管理ディスクおよびマネージド外ディスクの両方の使用を許可しないため、SharedまたはDedicatedで作成されたマネージド外ディスクを OpenShift Container Platform ノードに割り当てることはできません。parameters.storageaccounttype: Azure ストレージアカウント SKU ティア。デフォルトは空です。Premium 仮想マシンはStandard_LRS ディスクとPremium_LRSディスクの両方を接続できることに注意してください。標準仮想マシンはStandard_LRSディスクのみを接続できます。管理対象仮想マシンは、管理対象ディスクのみを接続できます。管理対象外の仮想マシンは、管理対象外のディスクのみを接続できます。-
共有:Azure は、クラスターと同じリソースグループ内のいくつかの共有ストレージアカウントに、すべての管理対象外ディスクを作成します。 -
マネージド:Azure は新しいマネージドディスクを作成します。 -
専用ストレージが指定されておらず、storageAccount が指定されていない場合: Azure は、クラスターと同じリソースグループ内に、新しいアンマネージドディスク用の専用ストレージアカウントを新たに作成します。 -
専用ストレージで、storageAccountが指定されている場合: Azure は、クラスターと同じリソースグループ内の新しいアンマネージドディスクに、指定されたストレージアカウントを使用します。この機能を利用するには、指定されたストレージアカウントが同じリージョンに存在する必要があり、Azure クラウドプロバイダーがそのストレージアカウントへの書き込みアクセス権を持っている必要があります。
-
9.3.6. Azure File のオブジェクト定義 リンクのコピーリンクがクリップボードにコピーされました!
Azure ファイルストレージクラスがファイル共有を動的にプロビジョニングできるようにするには、永続ボリュームバインダーに、Azure ストレージ認証情報を含むシークレットを作成および管理するためのアクセス許可を付与します。
これにより、プロビジョナーはファイル共有の作成に必要な Azure ストレージアカウント名とキーを安全に保存およびアクセスできるようになります。
手順
次のサンプルファイルのように、シークレットの作成と表示へのアクセスを許可する
ClusterRoleオブジェクトを定義します。クラスターロールの例 YAML ファイル
apiVersion: rbac.authorization.k8s.io/v1 kind: ClusterRole metadata: name: <persistent_volume_binder_role> rules: - apiGroups: [''] resources: ['secrets'] verbs: ['get','create']-
Metadata.name: シークレットを表示および作成するためのクラスターロールの名前。
-
以下のコマンドを実行して、サービスアカウントにクラスターロールを追加します。
$ oc adm policy add-cluster-role-to-user <persistent-volume-binder-role> system:serviceaccount:kube-system:persistent-volume-binderここで、
<persistent-volume-binder-role>は、前の手順で指定したクラスターロールの名前です。次のサンプルファイルのように、Azure File
StorageClassオブジェクトを作成します。Azure File ストレージクラスの YAML ファイルの例
kind: StorageClass apiVersion: storage.k8s.io/v1 metadata: name: <azure-file> provisioner: kubernetes.io/azure-file parameters: location: eastus skuName: Standard_LRS storageAccount: <storage-account> reclaimPolicy: Delete volumeBindingMode: Immediate-
metadata.name: ストレージクラスの名前。永続ボリューム要求は、関連する永続ボリュームをプロビジョニングするためにこのストレージクラスを使用します。 -
parameters.location: Azure ストレージアカウントの場所 (eastusなど)。デフォルトでは空になっており、OpenShift Container Platform クラスターの場所に新しい Azure ストレージアカウントが作成されます。 -
parameters.skuName: Azure ストレージアカウントの SKU ティア (Standard_LRSなど)。デフォルトでは空欄になっており、Standard_LRSSKU を持つ新しい Azure ストレージアカウントが作成されます。 -
parameters.storageAccount: Azure ストレージアカウントの名前。ストレージアカウントが提供されると、skuNameおよびlocationは無視されます。ストレージアカウントが指定されていない場合、ストレージクラスは、定義されたskuNameと場所に一致するアカウントがリソースグループに関連付けられているストレージアカウントを検索します。
-
9.3.6.1. Azure File を使用する場合の考慮事項 リンクのコピーリンクがクリップボードにコピーされました!
Azure ファイルストレージには、デフォルトではシンボリックリンク、ハードリンク、スパースファイルがサポートされていないことや、マウントされたディレクトリーとコンテナープロセス間で所有権が一致しないなど、ファイルシステム固有の制限があります。
これらの制約を理解し、uid、gid、mfsymlinks などのマウントオプションを使用することで、コンテナー化されたアプリケーションと正しく連携する Azure ファイルストレージクラスを設定できます。
以下の機能はサポートされていません。
- シンボリックリンク
- ハードリンク
- 拡張属性
- スパースファイル
- 名前付きパイプ
また、Azure File がマウントされるディレクトリーの所有者ユーザー ID (UID) は、コンテナーのプロセス UID とは異なります。StorageClass オブジェクトの uid マウントオプションを指定することで、マウントされたディレクトリーに使用する特定のユーザー識別子を定義できます。
以下の StorageClass オブジェクトは、マウントされたディレクトリーの uid とグループ識別子 (gid) を変更し、シンボリックリンクを有効にする方法を示しています。
変更された uid と gid を含む Azure ファイルストレージクラスの YAML ファイルの例
kind: StorageClass
apiVersion: storage.k8s.io/v1
metadata:
name: azure-file
mountOptions:
- uid=1500
- gid=1500
- mfsymlinks
provisioner: kubernetes.io/azure-file
parameters:
location: eastus
skuName: Standard_LRS
reclaimPolicy: Delete
volumeBindingMode: Immediate
-
mountOptions.uid: マウントするディレクトリーに使用するユーザー識別子を指定します。 -
mountOptions.gid: マウントするディレクトリーに使用するグループ識別子を指定します。 -
mountOptions.mfsymlinks: シンボリックリンクを有効にします。
9.3.7. GCE PersistentDisk (gcePD) オブジェクトの定義 リンクのコピーリンクがクリップボードにコピーされました!
この Google Compute Engine Persistent Disk (GCE PD) ストレージクラスの例では、ディスクパフォーマンス階層 (SSD、標準、ハイパーディスクバランス) の設定方法、ボリューム拡張の有効化方法、および遅延バインディングを使用してワークロードのゾーン配置を最適化する方法を示します。
GCE PD ストレージクラスの YAML ファイルの例
apiVersion: storage.k8s.io/v1
kind: StorageClass
metadata:
name: <storage-class-name>
provisioner: kubernetes.io/gce-pd
parameters:
type: pd-ssd
replication-type: none
volumeBindingMode: WaitForFirstConsumer
allowVolumeExpansion: true
reclaimPolicy: Delete
-
metadata.name: ストレージクラスの名前。永続ボリューム要求は、関連する永続ボリュームをプロビジョニングするためにこのストレージクラスを使用します。 -
parameters.type:pd-ssd、pd-standard、またはhyperdisk-balanced を選択します。デフォルトはpd-ssdです。
9.3.8. VMware vSphere オブジェクトの定義 リンクのコピーリンクがクリップボードにコピーされました!
この VMware vSphere ストレージクラスの例では、vSphere インフラストラクチャー上で動的なストレージプロビジョニングを有効にするために必要な基本的な構造と Container Storage Interface (CSI) プロビジョナーの設定を示します。
この最小限の定義は、vSphere ストレージ統合の基盤となるものであり、ストレージポリシー、データストア設定、その他の vSphere 固有のパラメーターを追加することで拡張できます。
vSphere ストレージクラスの YAML ファイルの例
kind: StorageClass
apiVersion: storage.k8s.io/v1
metadata:
name: <storage-class-name>
provisioner: csi.vsphere.vmware.com
-
metadata.name: ストレージクラスの名前。永続ボリューム要求は、関連する永続ボリュームをプロビジョニングするためにこのストレージクラスを使用します。 -
プロビジョナー: ストレージクラスのプロビジョナーの名前。vSphere の場合、これはcsi.vsphere.vmware.comです。
9.4. デフォルトのストレージクラスを設定します リンクのコピーリンクがクリップボードにコピーされました!
ストレージクラスを指定せずに永続ボリューム要求 (PVC) を作成すると、デフォルトのストレージクラスによって永続ボリュームが自動的にプロビジョニングされます。
これにより、ユーザーが各請求ごとにストレージクラスを選択する必要がなくなるため、ストレージ管理が簡素化されます。ストレージクラスをクラスター全体のデフォルトとして指定するには、ストレージクラスのメタデータにアノテーションを追加します。
前提条件
- 実行中の OpenShift Container Platform クラスターに管理者権限でログインしている。
手順
必要なストレージクラスについては、次の例のように
metadata.annotations.storageclass.kubernetes.io/is-default-classフィールドをtrueに設定してください。ストレージクラスの YAML ファイルの例
apiVersion: storage.k8s.io/v1 kind: StorageClass metadata: annotations: storageclass.kubernetes.io/is-default-class: "true" ...注記ベータアノテーションの
storageclass.beta.kubernetes.io/is-default-classは依然として使用可能ですが、今後のリリースで削除される予定です。オプション: 以下の例のように、
metadata.annotations.kubernetes.io/description フィールドにストレージクラスの説明を作成します。ストレージクラスの YAML ファイルの例
apiVersion: storage.k8s.io/v1 kind: StorageClass metadata: annotations: kubernetes.io/description: My Storage Class Description ...
9.5. デフォルトストレージクラスの変更 リンクのコピーリンクがクリップボードにコピーされました!
デフォルトのストレージクラスを変更して、新しい永続ボリューム要求 (PVC) が、指定したストレージバックエンドを自動的に使用するようにします。
これにより、ユーザーが各クレームに対してストレージクラスを指定する必要なく、コストの最適化、インフラストラクチャーの変更への対応、または新規デプロイメント全体で一貫したストレージタイプの確保が可能になります。
この例では、gp3 と standard という 2 つのストレージクラスが定義されており、デフォルトのストレージクラスを gp3 から standard に変更すると考えています。
前提条件
- クラスター管理者権限でクラスターにアクセスできる。
手順
以下のコマンドを実行して、ストレージクラスをリスト表示します。
$ oc get storageclass出力例
NAME TYPE gp3 (default) ebs.csi.aws.com1 standard ebs.csi.aws.comテキスト
(default)は、デフォルトのストレージクラスを示します。この例では、gp3が現在のデフォルトのストレージクラスです。目的のストレージクラスをデフォルトにします。
目的のストレージクラスに、次のコマンドを実行して
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があるというアラートを受け取ります。古いデフォルトストレージクラスからデフォルトのストレージクラス設定を削除します。
古いデフォルトのストレージクラスの場合は、次のコマンドを実行して
storageclass.kubernetes.io/is-default-classアノテーションの値をfalseに変更します。$ oc patch storageclass gp3 -p '{"metadata": {"annotations": {"storageclass.kubernetes.io/is-default-class": "false"}}}'以下のコマンドを実行して変更内容を確認してください。
$ oc get storageclass出力例
NAME TYPE gp3 ebs.csi.aws.com standard (default) ebs.csi.aws.com標準ストレージクラスがデフォルトになりました。