konfigurationsbefehle und Verwendung

Der Befehl config enthält außerdem verschiedene Befehle, mit denen Sie die Umgebung IBM® watsonx.data in IBM cpdctl konfigurieren können. In diesem Thema werden die Befehle mit einer kurzen Beschreibung der durchzuführenden Aufgaben aufgeführt.

Der Befehl config verwaltet die Konfiguration der Profile und Benutzer für watsonx.data. Die Instanz watsonx.data muss während der Konfiguration und Durchführung der Vorgänge im Webbrowser geöffnet sein.

Syntax:

./cpdctl config [commands]

Der Befehl config unterstützt die folgenden Befehle:

Sie können Benutzer und Profil einstellen, indem Sie diese Befehle separat ausführen. Es wird empfohlen, die kombinierten Befehle zu verwenden, um das Profil und die Benutzer mit einem einzigen Befehl einzustellen. Weitere Informationen finden Sie unter Gemeinsame Verwendung der Befehle user und profile.

Konfigurieren des Verschlüsselungsschlüssels für IBM cpdctl

Um Ihre Passwörter und API-Schlüssel zu schützen, verwendet IBM cpdctl AES-256 Verschlüsselung. Sie können einen benutzerdefinierten Verschlüsselungsschlüssel oder den standardmäßig von IBM cpdctl bereitgestellten, fest codierten Schlüssel verwenden.

Sie können einen benutzerdefinierten Verschlüsselungsschlüssel für AES-256 bereitstellen, indem Sie die Umgebungsvariable CPDCTL_ENCRYPTION_KEY_PATH setzen, die auf den Pfad des Verzeichnisses mit der Verschlüsselungsdatei verweist. Wenn diese Umgebungsvariable nicht gesetzt ist, verwendet cpdctl seinen eigenen fest kodierten Verschlüsselungsschlüssel.

Für macOS und Linux:

export CPDCTL_ENCRYPTION_KEY_PATH=/path/cpdctl.key

Für die Windows-Eingabeaufforderung:

set CPDCTL_ENCRYPTION_KEY_PATH=/path/cpdctl.key

Für Windows PowerShell:

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

Benutzer

Der Befehl user verwaltet Benutzer in watsonx.data.

Syntax:

./cpdctl config user [commands]

Der Befehl user unterstützt außerdem die folgenden Befehle:

Unterstützte Befehle durch den Benutzer
Optionen Beschreibung
./cpdctl config user set [commands] Legen Sie die Anmeldeinformationen für einen Benutzer in der cpdctl-Konfiguration fest, um eine Verbindung zur Instanz watsonx.data herzustellen.
./cpdctl config user list Auflistung der in der cpdctl-Konfiguration gespeicherten Anmeldeinformationen, die für die Verbindung mit der Instanz watsonx.data verwendet werden.
./cpdctl config user get <username> Abrufen der Anmeldedaten eines in der cpdctl-Konfiguration gespeicherten Benutzers, der für die Verbindung mit der Instanz watsonx.data verwendet wird.
./cpdctl config user unset <username> Entfernen Sie den aktuell eingestellten Benutzernamen aus der cpdctl-Konfiguration der Instanz watsonx.data.

./cpdctl config user set [commands] unterstützt außerdem die folgenden Befehle als Optionen für die Einstellung der Anmeldeinformationen:

--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

Beispiel für die Einrichtung eines Benutzers in einer Cloud-Instanz:

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

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

Für watsonx.data auf IBM Cloud wird empfohlen, --username und --apikey zu verwenden, die für die Anmeldung an der Konsole verwendet werden. Weitere Informationen finden Sie unter API-Schlüssel abrufen.

Profil

Der Befehl profile verwaltet Profile in watsonx.data.

Die SSO-Anmeldung (Single Sign-On) ist in der cpdctl-Konfiguration aktiviert.

Syntax:

./cpdctl config profile [commands]

Der Befehl profile unterstützt die folgenden Befehle:

Unterstützte Befehle nach Profil
Optionen Beschreibung
./cpdctl config profile set [commands] Setzen Sie das Umgebungsprofil watsonx.data in der cpdctl-Konfiguration.
./cpdctl config profile list Alle watsonx.data Umgebungsprofile auflisten, die in der cpdctl-Konfiguration eingestellt sind.
./cpdctl config profile get <profilename> Holen Sie sich die Details des watsonx.data Umgebungsprofils aus der cpdctl-Konfiguration.
./cpdctl config profile unset <profilename> Entfernen Sie das Umgebungsprofil watsonx.data aus der cpdctl-Konfiguration.
./cpdctl config profile current Holen Sie sich die Details des aktuellen watsonx.data Umgebungsprofils, das von cpdctl configuration verwendet wird.
./cpdctl config profile use <profilename> Verwenden Sie ein bestimmtes watsonx.data Umgebungsprofil aus der cpdctl-Konfiguration.

./cpdctl config profile set [commands] unterstützt außerdem die folgenden Befehle als Optionen für die Einstellung der Anmeldeinformationen:

--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.

Beispiel für die Einrichtung eines Profils unter Verwendung der zuvor festgelegten Konfiguration user in einer Cloud-Instanz:

./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

Die Befehle user und profile zusammen verwenden

Sie können die beiden Befehle user und profile miteinander kombinieren, um das Instanzprofil in der cpdctl-Konfiguration zu konfigurieren. Nachstehend finden Sie ein Beispiel für die Verwendung dieser Kombination:

Einrichten eines Cloud-Instance-Profils:

Syntax:

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>"

Beispiel:

./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/"

Für watsonx.data auf IBM Cloud wird empfohlen, --username und --apikey zu verwenden, die für die Anmeldung an der Konsole verwendet werden. Weitere Informationen finden Sie unter API-Schlüssel abrufen.

Einstellung der Instanz-ID als Umgebungsvariable

Ab der cpdctl-Version 1.8.5 müssen die Benutzer die Umgebungsvariable instance ID nicht mehr setzen. Diese Methode ist veraltet und wird in einer zukünftigen Version vollständig entfernt werden. Stattdessen müssen Sie die instance ID direkt mit der Funktion Profil wie unter Verwendung der Befehle user und profile zusammen beschrieben

Sie müssen eine Instanz-ID festlegen, um auf die entsprechende Umgebung zuzugreifen und die cpdctl-Befehle auszuführen. Um die Instanz-ID festzulegen, können Sie die Umgebungsvariable WX_DATA_INSTANCE_ID verwenden. So müssen Sie nicht bei jedem Befehl die Instanz-ID angeben.

Um die Variable zu setzen, führen Sie den folgenden Befehl in macOS und Linux aus:

export WX_DATA_INSTANCE_ID=<instance-id_value>

Dabei ist <instance-id_value> die Instanz-ID der Softwareinstanz watsonx.data oder die CRN Ihrer Instanz watsonx.data auf IBM Cloud, die Sie durch Anklicken des i-Symbols auf der Homepage aufrufen können.

Um die Variable zu setzen, führen Sie den folgenden Befehl in der Windows-Eingabeaufforderung aus:

set WX_DATA_INSTANCE_ID=<instance-id_value>

Um die Variable zu setzen, führen Sie unter Windows den folgenden Befehl aus PowerShell:

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