インストール・オプション・ファイルを使用して、CP4Dのサービスをインストールしてみた

はじめに

IBM Cloud Pak for Data (以下 CP4D) にサービスをインストールする場合、幾つかのサービスでは、インストール・オプション・ファイルを使用して、必須やオプションの設定を指定する事ができます。
インストール・オプション・ファイルを使用する上での考慮点がありますので ご紹介します。

参照マニュアル

サービスのインストール・オプションの指定

前提条件

本記事では、クライアント・マシンがLinuxである事を前提とします。
また、IBM Software Hub コマンド・ライン・インターフェース (以下 cpd-cli) がクライアント・マシンにインストールされている事を前提とします。CP4D自身のインストールに cpd-cli を使用しますので、cpd-cli はクライアント・マシンにインストールされていますが、以下の方法をお勧めします。

1.cpd-cli コマンドを任意のディレクトリーから実行可能にします。
cpd-cli が配置されているディレクトリーをPATHに設定します。
以下の行を ~/.bashrc ファイルに追加します。

export PATH=<fully-qualified-path-to-the-cpd-cli>:$PATH

例)
export PATH=$HOME/cpd-cli-linux-EE-14.2.1-2542:$PATH

2.cpd-cli のワークスペース・ディレクトリーを環境変数に設定します。
デフォルトでは cpd-cli コマンドを初めて実行すると、 cpd-cli によって自動的に cpd-cli-workspace/olm-utils-workspace/work ディレクトリーが作成されます。
cpd-cli の PATH を設定した場合、cpd-cli を任意のディレクトリーで実行する事が可能で、実行したディレクトリーの下に cpd-cli-workspace/olm-utils-workspace/work ディレクトリーが作成されてしまいます。

CPD_CLI_MANAGE_WORKSPACE 環境変数を設定する事により、cpd-cli のワークスペース・ディレクトリーを固定する事ができます。
以下の行を ~/.bashrc ファイルに追加します。

例)
export CPD_CLI_MANAGE_WORKSPACE=$HOME/cpd-cli-workspace/olm-utils-workspace/work

インストール・オプション・ファイルの指定

cpd-cli のワークスペース・ディレクトリーに install-options.yml というファイルを作成して、サービス毎の設定を記述します。
今回、CPD_CLI_MANAGE_WORKSPACE 環境変数に cpd-cli のワークスペース・ディレクトリーを設定しましたので、下記の install-options.yml ファイルを作成します。

$HOME/cpd-cli-workspace/olm-utils-workspace/work/install-options.yml

以下は watsonx.data intelligence サービスをインストールする際に使用した install-options.yml ファイルの内容の例になります。
"custom_spec:" と "サービス名" と プロパティーを設定する際に、インデントが必要になりますので ご注意ください。

###############################################################################
# watsonx.data intelligence parameters
###############################################################################
custom_spec:
  watsonx_dataintelligence:
    enableAISearch: True
    enableDataGovernanceCatalog: True
    enableDataLineage: False
    enableDataProductHub: True             
    enableDataQuality: False
    enableGenerativeAICapabilities: True
    enableKnowledgeGraph: False
    enableModelsOn: cpu
    enableSemanticEnrichment: True

以上で インストール・オプション・ファイルの作成は完了です。
インストールするサービスの OLMオブジェクトを作成 (オペレーターのインストール) した後 "cpd-cli manage apply-cr" コマンドで、サービスのカスタム・リソースを作成します。
"--param-file" パラメーターでインストール・オプション・ファイルを指定しますが、ここで注意が必要です。
"--param-file" パラメーターで指定するインストール・オプション・ファイルは、クライアント・マシン上の install-options.yml ファイルではなく、"cpd-cli" コマンドによって起動される Docker や Podman のコンテナ内の install-options.yml ファイル を指定します。
cpd-cli のワークスペース・ディレクトリー (今回の例では "$HOME/cpd-cli-workspace/olm-utils-workspace/work") は、コンテナ内の /tmp/work ディレクトリーにマップされます。
このため、"--param-file" は下記のように指定します。

--param-file=/tmp/work/install-options.yml

"--param-file=$HOME/cpd-cli-workspace/olm-utils-workspace/work/install-options.yml" のように、クライアント・マシン上の install-options.yml を指定してしまうと、"cpd-cli manage apply-cr" コマンドは下記のようなエラーで失敗します。

FileNotFoundError: [Errno 2] No such file or directory: '/home/XXXXXXXX/cpd-cli-workspace/olm-utils-workspace/work/install-options.yml'

以下は実際に CP4D 5.2.1 に watsonx.data intelligence 5.2.1 をインストールした "cpd-cli manage apply-cr" コマンドの例になります。

$ cpd-cli manage apply-cr \
--components=watsonx_dataintelligence \
--release=${VERSION} \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--block_storage_class=${STG_CLASS_BLOCK} \
--file_storage_class=${STG_CLASS_FILE} \
--param-file=/tmp/work/install-options.yml \
--license_acceptance=true

途中省略

[SUCCESS] 2025-10-14T20:31:09.157954Z You may find output and logs in the /home/kanbayashi/cpd-cli-workspace/olm-utils-workspace/work directory.
[SUCCESS] 2025-10-14T20:31:09.158040Z The apply-cr command ran successfully.

下記のコマンドで、install-options.yml ファイルで指定した内容が、watsonx.data intelligence のカスタム・リソースに反映されている事が判ります。

$ oc get WatsonxDataIntelligence watsonxdataintelligence-cr -o yaml

途中省略

spec:
  enableAISearch: true
  enableContentLinkingForTextToSql: false
  enableDataGovernanceCatalog: true
  enableDataLineage: false
  enableDataProduct: true
  enableDataProductHub: true
  enableDataQuality: false
  enableGenerativeAICapabilities: true
  enableKnowledgeGraph: false
  enableModelsOn: cpu
  enableSemanticEmbedding: false
  enableSemanticEnrichment: true
  enableTextToSql: false

以上で、インストール・オプション・ファイルを使用したCP4Dのサービスのインストールの紹介を終わります。