コンフィグコマンドと使い方

configコマンドにはさらに別のコマンドがあり、 IBM cpdctlで IBM® watsonx.data 環境を設定することができる。 このトピックでは、実行可能なタスクの簡単な説明とともにコマンドの一覧を示します。

config コマンドは、 watsonx.data のプロファイルとユーザーの設定を管理します。 コンフィギュレーションと操作の実行中は、 watsonx.data インスタンスをウェブブラウザで開いておく必要があります。

構文:

./cpdctl config [commands]

configコマンドは以下のコマンドをサポートしている：

これらのコマンドを別々に実行することで、 ユーザーと プロファイルを 設定することができる。 プロファイルとユーザーを1つのコマンドで設定するには、複合コマンドを使用することをお勧めします。 詳細については、 userとprofileというコマンドを併用するを 参照のこと。

IBM cpdctl 用暗号化キーの設定

パスワードとAPIキーを保護するために、 IBM cpdctlは AES-256 暗号化を使用しています。 カスタムの暗号化キーか、 IBM cpdctlが提供するデフォルトのハードコードされたキーを使用することができる。

CPDCTL_ENCRYPTION_KEY_PATH 環境変数を設定し、暗号化キー・ファイルを保持するディレクトリのパスを指定することで、 AES-256 用にカスタム暗号化キーを提供することができます。 この環境変数が設定されていない場合、cpdctlはハードコードされた独自の暗号化キーを使用する。

macOS、 Linux ：

export CPDCTL_ENCRYPTION_KEY_PATH=/path/cpdctl.key

Windowsコマンドプロンプトの場合：

set CPDCTL_ENCRYPTION_KEY_PATH=/path/cpdctl.key

Windows用 PowerShell:

$env:CPDCTL_ENCRYPTION_KEY_PATH = "/path/cpdctl.key"

ユーザー

user コマンドは、 watsonx.data のユーザーを管理する。

構文:

./cpdctl config user [commands]

user コマンドはさらに以下のコマンドをサポートしている：

ユーザー別対応コマンド
オプション 説明
./cpdctl config user set [commands] watsonx.data インスタンスに接続するために、cpdctlコンフィギュレーションでユーザーの認証情報を設定する。
./cpdctl config user list watsonx.data インスタンスへの接続に使用される、cpdctl コンフィギュレーションに保存されている認証情報を一覧表示します。
./cpdctl config user get <username> watsonx.data インスタンスへの接続に使用される、cpdctl コンフィギュレーションに保存されているユーザーの認証情報を取得する。
./cpdctl config user unset <username> watsonx.data インスタンスの cpdctl コンフィギュレーションから現在設定されているユーザー名を削除する。

./cpdctl config user set [commands] さらに、認証情報の設定に使用するオプションとして、以下のコマンドをサポートしている：

--apikey (string) : Set user apikey

--password (string) : Set user password

--token-file (string) : Set location of a file that contains user token

--username (string) : Set user name

クラウドインスタンスにユーザーを設定する例：

./cpdctl config user set <user> --username <saas_username> --apikey <APIKEY>

./cpdctl config user set user2 --username user@ibm.com --apikey APIKEY

IBM Cloud 上の watsonx.data については、コンソールへのログインに使用する --username と --apikey を使用することを推奨する。 詳細については、 APIキーの取得を 参照してください。

プロファイル

profile コマンドは watsonx.data でプロファイルを管理する。

シングルサインオン（SSO）ログインはcpdctlコンフィギュレーションで有効になっている。

構文:

./cpdctl config profile [commands]

profile コマンドは以下のコマンドをサポートしている：

プロファイル別対応コマンド
オプション 説明
./cpdctl config profile set [commands] cpdctlコンフィギュレーションで watsonx.data 環境プロファイルを設定する。
./cpdctl config profile list cpdctlコンフィギュレーションで設定されているすべての watsonx.data 環境プロファイルを一覧表示する。
./cpdctl config profile get <profilename> cpdctl configurationから watsonx.data 環境プロファイルの詳細を取得する。
./cpdctl config profile unset <profilename> cpdctl 設定から watsonx.data 環境プロファイルを削除する。
./cpdctl config profile current cpdctl configurationから、現在使用されている watsonx.data 環境プロファイルの詳細を取得する。
./cpdctl config profile use <profilename> cpdctlコンフィギュレーションから特定の watsonx.data 環境プロファイルを使用する。

./cpdctl config profile set [commands] さらに、認証情報の設定に使用するオプションとして、以下のコマンドをサポートしている：

--apikey (string) : Create a user having this API key and associate it with the profile. Used for SaaS and Onprem. Recommended to use for SaaS instance.

--common-services-url (string) : Set Common Services URL for the profile

--iam-integration-enabled () : Set if IAM integration is enabled on CP4D

--ibmcloud (string) : Connect the profile to IBM Cloud CLI session metadata. Flag value specifies IBM Cloud CLI configuration directory. If no value is given, default IBM Cloud CLI configuration directory is assumed.

--password (string) : Create a user having this password and associate it with the profile. Used for Onprem. Recommended to use for Onprem instance.

--region (string) : IBM cloud region.

--token-file (string) : Create a user having this token location and associate it with the profile.

--url (string) : Set URL for the profile

--user (string) : Set user for the profile

--username (string) : Create a user having this name and associate it with the profile.

クラウドインスタンスで先に設定した user 設定を使用してプロファイルを設定する例：

./cpdctl config profile set <profile_name> --user <user> --url <profile_url> --region <region_name>

./cpdctl config profile set saas --user user2 --url https://cloud.ibm.com/ --region us-south

userコマンドとprofileコマンドの併用

cpdctlコンフィギュレーションでインスタンス・プロファイルを設定するには、userとprofileの2つのコマンドを組み合わせることができる。 組み合わせの使用例を以下に示す：

クラウドインスタンスプロファイルの設定

構文:

cpdctl config profile set <profile_name> --username <saas_username> --apikey <APIKEY> --url <saas_url> --region <region_name> \
--env "WATSONX_DATA_INSTANCE_ID=<crn>" \
--env "WATSONX_DATA_URL=<WXD-base-url>"

例:

./cpdctl config profile set saas --username user@ibm.com --apikey APIKEY --url https://cloud.ibm.com/ --region us-south \
--env "WATSONX_DATA_INSTANCE_ID=crn:v1:staging:public:lakehouse:us-south:a/781f752068d44638a3b2a13de58d3cfe:2c590eda-8d51-4269-86ce-a6dfb84c8267::" \
--env "WATSONX_DATA_URL=https://us-south.lakehouse.dev.cloud.ibm.com/"

IBM Cloud 上の watsonx.data については、コンソールへのログインに使用する --username と --apikey を使用することを推奨する。 詳細については、 APIキーの取得を 参照してください。

インスタンスIDを環境変数に設定する

cpdctl version 1.8.5 以降、ユーザーは環境変数として instance ID を設定する必要がなくなった。 このメソッドは非推奨であり、将来のリリースでは完全に削除される予定である。 代わりに、 instance ID プロファイル userコマンドとprofileコマンドの併用で 説明されている

cpdctlコマンドを実行するには、対応する環境にアクセスするためのインスタンスIDを設定する必要がある。 インスタンスIDを設定するには、環境変数 WX_DATA_INSTANCE_ID。 これにより、コマンドごとにインスタンスIDを指定する手間を省くことができる。

変数を設定するには、 macOS と Linux で以下のコマンドを実行する：

export WX_DATA_INSTANCE_ID=<instance-id_value>

ここで、 <instance-id_value> は、 watsonx.data ソフトウェア・インスタンスのインスタンス ID、またはホームページの i アイコンをクリックしてアクセスできる IBM Cloud 上の watsonx.data インスタンスの CRN です。

この変数を設定するには、Windowsのコマンドプロンプトで以下のコマンドを実行する：

set WX_DATA_INSTANCE_ID=<instance-id_value>

変数を設定するには、Windowsで以下のコマンドを実行する。 PowerShell:

$env:WX_DATA_INSTANCE_ID = "<instance-id_value>"