cpd-cli service-instance create コマンドを使用した watsonx Orchestrate 用のサービス・インスタンスの作成

watsonx Orchestrate をインストールした後、operands プロジェクトwatsonx Orchestrate・サービス・インスタンスを作成する必要があります。 IBM® Software Hub ユーザーの場合は、cpd-cli service-instance create コマンドを使用して、サービス・インスタンスの作成プロセスをスクリプト化できます。

このタスクを実行する必要があるのは誰か?
cpd-cliを使用してサービス・インスタンスを作成するには、IBM Software Hubサービス・インスタンスの作成 (can_provision)許可が必要です。
このタスクをいつ完了する必要がありますか?
cpd-cliから cpd-cli service-instance create コマンドを使用してサービス・インスタンスを作成する場合にのみ、このタスクを実行します。
サービス・インスタンスを作成するための代替方法

このタスクを完了するために必要な情報

watsonx Orchestrateのサービス・インスタンスを作成する前に、以下の情報を確認してください。

バージョンの要件

IBM Software Hubのインスタンスに関連付けられているすべてのコンポーネントは、同じリリースでインストールまたは作成する必要があります。 例えば、watsonx Orchestrate がバージョン 5.3.1 でインストールされている場合は、バージョン 5.3.1 でサービス・インスタンスを作成する必要があります。

環境変数

このタスクのコマンドでは環境変数を使用するため、記載されているとおりにコマンドを実行できます。

  • 環境変数を定義するスクリプトがない場合は、インストール環境変数の設定を参照してください。
  • スクリプトから環境変数を使用するには、このタスクでコマンドを実行する前に環境変数をsourceする必要があります。 例えば、以下のコマンドを実行します。
    source ./cpd_vars.sh

始める前に

このタスクでは、以下の前提条件が満たされていることを前提としています。

前提条件 詳細情報の参照先
watsonx Orchestrate がインストールされています。 このタスクが完了していない場合は、『 watsonx Orchestrateのインストール』を参照してください。
cpd-cli コマンド行インターフェースは、サービス・インスタンスの作成元のワークステーションにインストールされます。 このタスクが完了していない場合は、『クライアント・ワークステーションのセットアップ』を参照してください。 Setting up a client workstation
サービス・インスタンスを作成するワークステーションで IBM Software Hub ユーザー・プロファイルを作成した。

このプロファイルは、IBM Software Hubサービス・インスタンスの作成 (can_provision)許可を持つユーザーに関連付けられている必要があります。

このタスクが完了していない場合は、cpd-cli 管理コマンドを使用するためのプロファイルの作成を参照してください。

手順

サービス・インスタンスを作成するには、以下のタスクを実行します。

  1. サービス・インスタンスの作成
  2. サービス・インスタンスが作成されたことを検証しています
  3. 次に行うこと

サービス・インスタンスの作成

サービス・インスタンスを作成するには、以下の手順を実行します。

  1. サービス・インスタンス・ペイロードを定義する JSON ファイルを作成する、ワークステーション上のディレクトリーに移動します。
  2. サービス・インスタンスの JSON ペイロードにデータを取り込むために使用される環境変数を設定します。
    1. INSTANCE_NAME 環境変数を、サービス・インスタンスの表示名として使用する固有の名前に設定します。
      export INSTANCE_NAME=<display-name>

      この名前は、IBM Software Hub Web クライアントの「インスタンス」ページに表示されます。

      表示名は string で、英数字 (a から z、A から Z、0 から 9) とダッシュ (-) のみを使用できます。 名前の先頭と末尾は英数字でなければなりません。

    2. INSTANCE_DESCRIPTION 環境変数を、サービス・インスタンスに使用する記述に設定します。
      export INSTANCE_DESCRIPTION="<description>"

      この説明は、IBM Software Hub Web クライアントの「インスタンス」ページに表示されます。

      説明は stringであり、英数字、スペース、ダッシュ、下線、およびピリオドを含めることができます。 上記の export コマンドに示されているように、表示名を引用符で囲んでください。

  3. orchestrate-instance.json ペイロード・ファイルを作成します。
    cat << EOF > ./orchestrate-instance.json
    {
        "addon_type": "orchestrate",
        "display_name": "${INSTANCE_NAME}",
        "namespace": "${PROJECT_CPD_INST_OPERANDS}",
        "addon_version": "${VERSION}",
        "create_arguments": {
            "description": "${INSTANCE_DESCRIPTION}"
        }
    }
    EOF
    以下の環境変数は、インストール環境変数スクリプトで既に定義されている値を使用します。
    • ${PROJECT_CPD_INST_OPERANDS}
    • ${VERSION}
  4. PAYLOAD_FILE 環境変数を、ワークステーション上の JSON ペイロード・ファイルの完全修飾名に設定します。
    export PAYLOAD_FILE=<fully-qualified-JSON-file-name>
  5. ペイロード・ファイルからサービス・インスタンスを作成します。
    cpd-cli service-instance create \
    --profile=${CPD_PROFILE_NAME} \
    --from-source=${PAYLOAD_FILE}

サービス・インスタンスが作成されたことの検証

サービス・インスタンスが作成されたことを確認するには、以下のコマンドを実行します。

cpd-cli service-instance status ${INSTANCE_NAME} \
--profile=${CPD_PROFILE_NAME} \
--output=json
  • コマンドが PROVISIONEDを返した場合、サービス・インスタンスは正常に作成されました。
  • コマンドが PROVISION_IN_PROGRESSを返した場合は、数分待ってからコマンドを再実行してください。
  • コマンドが FAILEDを返した場合は、zen-core-apiポッドとzen-watcherポッドのポッド・ログで考えられる原因を確認します。
重要: フレッシュ・5.2.0・クラスターまたはアップグレードされた5.2.0・クラスターで作成された新規テナントは、New Agentic Experienceにのみアクセスできます。

次のタスク

サービス・インスタンスを使用する準備ができました。 サービス・インスタンスの管理者は、他のユーザーにインスタンスへのアクセス権限を付与できます。