VPC クラスターへの OpenShift Data Foundation のデプロイ

コンソールからの OpenShift Data Foundation アドオンのインストール

クラスターに ODF をインストールするには、以下の手順を実行します。

1. アドオンを有効にする前に、変更ログで最新バージョン情報を確認してください。

2. パラメーター・リファレンスを確認します。

3. Red Hat OpenShift クラスター・コンソールから、アドオンのインストール先となるクラスターを選択します。

4. クラスターの**「概要」ページで、「OpenShift Data Foundation」カードの「インストール」**をクリックします。 **「ODF のインストール (Install ODF)」**パネルが開きます。

5. **「ODF のインストール (Install ODF)」**パネルで、ODF デプロイメントに使用する構成パラメーターを入力します。

6. 請求プランとして**「基本」または「拡張」**を選択します。 請求タイプについて詳しくは、 請求タイプ別のフィーチャー・サポート を参照してください。

7. VPC クラスターの場合は、 「リモート・プロビジョニング」 を選択して、 Block Storage for VPCを使用して ODF のボリュームを動的にプロビジョンします。

8. 「OSD ストレージ・クラス名」 フィールドに、ストレージ・ボリュームのプロビジョニングに使用する Block Storage for VPC ODF ストレージ・クラスの名前を入力します。 複数ゾーン・クラスターの場合は、 VolumeBindingMode が WaitForFirstConsumer のストレージ・クラスを使用します。 詳しくは、「 Storage Class Reference 」を参照してください。

9. **「OSD ポッド・サイズ」**フィールドに、プロビジョンするボリュームのサイズを入力します。

10. **「ワーカー・ノード」**フィールドに、ODF をデプロイするワーカー・ノードのノード名を入力します。 少なくとも 3 つのワーカー・ノード名を入力する必要があります。 ノード名を見つけるには、クラスター内で oc get nodes コマンドを実行します。 Node の名前は、名前の間にスペースを入れずにコンマで区切る必要があります。 例: 10.240.0.24,10.240.0.26,10.240.0.25。すべてのワーカー・ノードに ODF をデプロイする場合は、このフィールドをブランクのままにします。

11. **「必要な OSD ディスクの数」**フィールドに、各ワーカー・ノードにプロビジョンする OSD ディスク (アプリ・ストレージ) の数を入力します。

12. ODF システム・ポッドで使用される OSD ボリューム (クラスター全体の暗号化) を暗号化する場合は、 「クラスター暗号化の有効化」 を選択します。

13. アプリケーション・ボリューム (アプリ・ストレージ) の暗号化を有効にする場合は、 「ボリューム暗号化の有効化」 を選択します。

    1. 「インスタンス名」 フィールドに、 Hyper Protect Crypto Services または Key Protect インスタンスの固有の名前を入力します。
    2. 「インスタンス・タイプ」 フィールドに、暗号化インスタンスのタイプを入力します。
    3. 「インスタンス ID」 フィールドに、 Hyper Protect Crypto Services または Key Protect インスタンス ID を入力します。 例: d11a1a43-aa0a-40a3-aaa9-5aaa63147aaa。
    4. 「シークレット名」 フィールドに、 Hyper Protect Crypto Services または Key Protect 資格情報を使用して作成したシークレットの名前を入力します。 例: ibm-hpcs-secret。
    5. 「ベース URL」 フィールドに、 Hyper Protect Crypto Services または Key Protect インスタンスのパブリック・エンドポイントを入力します。 例: https://api.eu-gb.hs-crypto.cloud.ibm.com:8389。
    6. **「トークン URL」**フィールドに、https://iam.cloud.ibm.com/identity/token を入力します。

14. 使用するパラメーターを入力したら、**「インストール」**をクリックします。

15. アドオンのデプロイメントが完了するまで数分待ちます。 デプロイメントが完了すると、アドオンの状況は Normal - Addon Ready になります。

16. インストールを検証します。 Red Hat OpenShift クラスターにアクセスします。

17. 以下のコマンドを実行して、ODF ポッドが実行されていることを確認します。

    oc get pods -n openshift-storage
    

次のステップ

ODF を使用するアプリをデプロイします。

CLI からのアドオンのインストール

ibmcloud oc cluster addon enable コマンドを使用して、アドオンをインストールできます。

1. VPC パラメーター・リファレンス を確認してください。 アドオンを有効にすると、オーバーライドするパラメーターごとに --param "key=value" オプションを指定することによって、デフォルト値をオーバーライドできます。

2. Red Hat OpenShift クラスターにアクセスします。

3. openshift-data-foundation アドオン・バージョンをリストします。 デフォルト・バージョンを書き留め、インストールするバージョンを決定します。

   ibmcloud ks cluster addon versions
   

4. アドオンを有効にする前に、変更ログで最新バージョン情報を確認してください。 アドオンは n+1 のクラスター・バージョンをサポートすることに注意してください。 例えば、バージョン 4.10.0 のアドオンを OCP 4.9 または 4.11 クラスターにデプロイすることができます。 デフォルト以外のクラスター・バージョンを使用している場合は、アドオンを有効にするときに --version オプションを指定する必要があります。

5. アドオンのオプションを確認します。

   ibmcloud oc cluster addon options --addon openshift-data-foundation --version 4.12.0
   

   バージョン 4.12.0 のアドオン・オプションの例

   Add-on Options
   Option                Default Value
   clusterEncryption     false
   hpcsTokenUrl          <Please provide the KMS token URL>
   osdDevicePaths        <Please provide IDs of the disks to be used for OSD pods if using local disks or standard classic cluster>
   ocsUpgrade            false
   autoDiscoverDevices   false
   hpcsServiceName       <Please provide the KMS Service instance name>
   hpcsSecretName        <Please provide the KMS secret name>
   osdSize               250Gi
   osdStorageClassName   ibmc-vpc-block-metro-10iops-tier
   billingType           advanced
   hpcsInstanceId        <Please provide the KMS Service instance ID>
   hpcsBaseUrl           <Please provide the KMS Base (public) URL>
   odfDeploy             true
   numOfOsd              1
   workerNodes           all
   hpcsEncryption        false
   ignoreNoobaa          false
   

6. openshift-data-foundationアドオンを有効にします。 いずれかのデフォルト・パラメーターをオーバーライドする場合は、オーバーライドするパラメーターごとに --param "key=value" オプションを指定します。 アドオンを有効にするときにストレージ・クラスターを作成しない場合は、まずアドオンを有効にしてから、後で CRD を作成してストレージ・クラスターを作成することができます。

   デフォルトのストレージ・クラスター設定と、Hyper Protect Crypto Services を有効にした暗号化を使用してアドオン・バージョン 4.10 をデプロイするためのコマンド例。

   ibmcloud oc cluster addon enable openshift-data-foundation -c <cluster-name> --version 4.12.0 --param "odfDeploy=true" --param "hpcsTokenUrl=https://iam.cloud.ibm.com/identity/token" --param "hpcsEncryption=true" --param "hpcsBaseUrl=<hpcs-instance-public-endpoint>" --param "hpcsInstanceId=<hpcs-instance-id>" --param "hpcsServiceName=<hpcs-instance-name>" --param "hpcsSecretName=<hpcs-secret-name>"
   

   ODF アドオンのみをデプロイするコマンドの例。

   ibmcloud oc cluster addon enable openshift-data-foundation -c <cluster_name> --version <version> --param "odfDeploy=false"
   

   デフォルトの構成パラメーターを使用して、ODF をデプロイし、ストレージ・クラスターを作成するコマンドの例。

   ibmcloud oc cluster addon enable openshift-data-foundation -c <cluster_name> --version <version>
   

   osdSize パラメーターをオーバーライドしながら ODF をデプロイし、ストレージ・クラスターを作成するコマンドの例。

   ibmcloud oc cluster addon enable openshift-data-foundation -c <cluster_name> --version <version> --param "osdSize=500Gi"
   

7. アドオンが Ready 状態であることを確認します。

   oc get storagecluster -n openshift-storage
   

   出力例:

   NAME                 AGE   PHASE   EXTERNAL   CREATED AT             VERSION
   ocs-storagecluster   53m   Ready              2023-03-10T12:20:52Z   4.11.0
   

8. ibm-ocs-operator-controller-manager-***** ポッドが kube-system 名前空間で実行されていることを確認します。

   oc get pods -A | grep ibm-ocs-operator-controller-manager
   

9. odfDeploy を false に設定してアドオンを有効にした場合は、 ODF カスタム・リソースを作成する 手順に従ってください。

Terraform からのアドオンのインストール

始めに:

• Terraform CLI および IBM Cloud プロバイダー・プラグインをインストールします。
• IBM Cloud API キー があることを確認します。

1. Terraform プロバイダー・ファイルを作成します。 ファイルを Terraform ディレクトリーに保存します。 詳しくは、 Terraform IBM Cloud プロバイダーの資料を参照してください。

   Terraform プロバイダー・ファイルの例。

   terraform {
   required_providers {
       ibm = {
       source = "IBM-Cloud/ibm"
       version = "1.53.0"
       }
   }
   }
   
   provider "ibm" {
   region = "us-south"
   ibmcloud_api_key = "<api-key>"
   }
   

2. ODF アドオン用の Terraform 構成ファイルを作成します。 ファイルを Terraform ディレクトリーに保存します。

   構成ファイルの例。

   ibmcloud_api_key = "" # Enter your API Key
   cluster = "" # Enter the Cluster ID
   region = "us-south" # Enter the region
   
   # For add-on deployment
   odfVersion = "4.12.0"
   
   # For CRD Creation and Management
   autoDiscoverDevices = "false"
   billingType = "advanced"
   clusterEncryption = "false"
   hpcsBaseUrl = null
   hpcsEncryption = "false"
   hpcsInstanceId = null
   hpcsSecretName = null
   hpcsServiceName = null
   hpcsTokenUrl = null
   ignoreNoobaa = "false"
   numOfOsd = "1"
   ocsUpgrade = "false"
   osdDevicePaths = null
   osdSize = "250Gi"
   osdStorageClassName = "ibmc-vpc-block-metro-10iops-tier"
   workerNodes = null
   

3. CLI で、Terraform ディレクトリーにナビゲートします。

   cd <terraform_directory>
   

4. コマンドを実行して、Terraform アクションを初期化および計画します。 計画の出力を調べて、正しいアクションが実行されていることを確認してください。

   terraform init
   

   terraform plan
   

5. Terraform ファイルを適用してクラスターを作成します。 次に、 IBM Cloud コンソールにナビゲートして、クラスターがプロビジョニングされていることを確認します。

   terraform apply
   

ODF カスタム・リソースの作成

ストレージ・ボリュームの動的プロビジョニングを使用して、VPC クラスター内に ODF ストレージ・クラスターを作成するには、ストレージ・デバイスの詳細を指定するためのカスタム・リソースを作成します。

IBM Cloud Object Storage サービス・インスタンスをデフォルトのバッキング・ストアとして使用する場合は、サービス・インスタンスを作成したこと、また、クラスターに Kubernetes シークレットを作成したことを確認してください。 ODF の CRD をクラスターに作成すると、ODF が ibm-cloud-cos-creds という名前のシークレットを検索し、Object Storage の HMAC 資格情報を使用してデフォルトのバッキング・ストアをセットアップします。

1. OcsCluster という名前のカスタム・リソース定義を作成します。 以下のカスタム・リソース定義ファイルのいずれかをローカル・マシンに保存して編集し、事前に作成しておいたカスタム・ストレージ・クラスの名前を monStorageClassName および osdStorageClassName パラメーターとして指定します。 OcsCluster の各パラメーターについて詳しくは、 パラメーターのリファレンスを参照してください。

   4.8 クラスター上のすべてのワーカー・ノードに ODF をインストールするためのカスタム・リソース定義の例。

   apiVersion: ocs.ibm.io/v1
   kind: OcsCluster
   metadata:
     name: ocscluster-vpc # Kubernetes resource names can't contain capital letters or special characters. Enter a name for your resource that uses only lowercase letters, numbers, `-` or `.`
   spec:
     osdStorageClassName: <osdStorageClassName> # Specify an ODF storage class with a waitForFirstConsumer volume binding mode
     osdSize: <osdSize> # The OSD size is the total storage capacity of your OCS storage cluster. Use at least 250Gi OSDs for production workloads.
     numOfOsd: 1
     billingType: advanced
     ocsUpgrade: false
   

   4.8 クラスター上の指定されたワーカー・ノードにのみ ODF をインストールするためのカスタム・リソース定義の例。

   apiVersion: ocs.ibm.io/v1
   kind: OcsCluster
   metadata:
     name: ocscluster-vpc # Kubernetes resource names can't contain capital letters or special characters. Enter a name for your resource that uses only lowercase letters, numbers, `-` or `.`
   spec:
     osdStorageClassName: <osdStorageClassName> # Specify an ODF storage class with a waitForFirstConsumer volume binding mode
     osdSize: <osdSize> # The OSD size is the total storage capacity of your OCS storage cluster. Use at least 250Gi OSDs for production workloads.
     numOfOsd: 1
     billingType: advanced
     ocsUpgrade: false
     workerNodes: # Specify the private IP addresses of the worker nodes where you want to install OCS.
       - <workerNodes> # To get a list worker nodes, run `oc get nodes`.
       - <workerNodes>
       - <workerNodes>
   

2. ファイルを保存し、クラスターに OcsCluster カスタム・リソースを作成します。

   oc create -f <ocs-cluster-filename>.yaml
   

3. OcsCluster が実行中であることを確認します。

   oc describe ocscluster ocscluster-vpc
   

   出力例。

   Name:         ocscluster-vpc
   Namespace:    
   Labels:       <none>
   Annotations:  <none>
   API Version:  ocs.ibm.io/v1
   Kind:         OcsCluster
   Metadata:
       Creation Timestamp:  2021-03-23T20:56:51Z
   Finalizers:
     finalizer.ocs.ibm.io
   Generation:  1
   Managed Fields:
     API Version:  ocs.ibm.io/v1
     Fields Type:  FieldsV1
     fieldsV1:
       f:spec:
         .:
         f:billingType:
         f:monSize:
         f:monStorageClassName:
         f:numOfOsd:
         f:ocsUpgrade:
         f:osdSize:
         f:osdStorageClassName:
     Manager:      oc
     Operation:    Update
     Time:         2021-03-23T20:56:51Z
     API Version:  ocs.ibm.io/v1
     Fields Type:  FieldsV1
     fieldsV1:
       f:metadata:
         f:finalizers:
           .:
           v:"finalizer.ocs.ibm.io":
       f:status:
         .:
         f:storageClusterStatus:
     Manager:         manager
     Operation:       Update
     Time:            2021-04-09T23:12:02Z
   Resource Version:  11372332
   Self Link:         /apis/ocs.ibm.io/v1/ocsclusters/ocscluster-vpc
   UID:               aa11a1a1-111f-aace-afac-1fa1afe1111a
   Spec:
     Billing Type:            hourly
     Mon Size:                20Gi
     Mon Storage Class Name:  ibmc-vpc-block-10iops-tier
     Num Of Osd:              1
     Ocs Upgrade:             false
     Osd Size:                250Gi
     Osd Storage Class Name:  ibmc-vpc-block-10iops-tier
   Status:
     Storage Cluster Status:  
   Events:                    <none>
   

4. ODF を使用するアプリをデプロイします。