Configurazione della chiave di crittografia per IBM cpdctl

Per proteggere le password e le chiavi API, IBM cpdctl utilizza la crittografia AES-256. È possibile utilizzare una chiave di crittografia personalizzata o quella predefinita e codificata fornita da IBM cpdctl.

È possibile fornire una chiave di crittografia personalizzata per AES-256 impostando la variabile d'ambiente CPDCTL_ENCRYPTION_KEY_PATH che punta al percorso della directory di archiviazione dei file di crittografia. Se questa variabile d'ambiente non è impostata, cpdctl utilizzerà la propria chiave di crittografia codificata.

Per macOS e Linux:

export CPDCTL_ENCRYPTION_KEY_PATH=/path/cpdctl.key

Per il prompt dei comandi di Windows:

set CPDCTL_ENCRYPTION_KEY_PATH=/path/cpdctl.key

Per Windows PowerShell:

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

Utente

Il comando user gestisce gli utenti in watsonx.data.

Sintassi:

./cpdctl config user [commands]

Il comando user supporta inoltre i seguenti comandi:

./cpdctl config user set [commands] supporta inoltre i seguenti comandi come opzioni da utilizzare per l'impostazione delle credenziali:

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

Esempio di impostazione di un utente in un'istanza cloud:

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

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

Per watsonx.data su IBM Cloud, si consiglia di utilizzare --username e --apikey che vengono utilizzati per accedere alla console. Per ulteriori informazioni, consultare la sezione Ottenere la chiave API.

profilo

Il comando profile gestisce i profili in watsonx.data.

Il login single sign-on (SSO) è abilitato nella configurazione di cpdctl.

Sintassi:

./cpdctl config profile [commands]

Il comando profile supporta i seguenti comandi:

./cpdctl config profile set [commands] supporta inoltre i seguenti comandi come opzioni da utilizzare per l'impostazione delle credenziali:

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

Esempio di impostazione di un profilo utilizzando la configurazione user impostata in precedenza in un'istanza cloud:

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

Usare i comandi utente e profilo insieme

È possibile combinare insieme i due comandi utente e profilo per configurare il profilo dell'istanza nella configurazione di cpdctl. Di seguito è riportato un esempio di utilizzo della combinazione:

Impostazione di un profilo di istanza cloud:

Sintassi:

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

Esempio:

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

Per watsonx.data su IBM Cloud, si consiglia di utilizzare --username e --apikey che vengono utilizzati per accedere alla console. Per ulteriori informazioni, consultare la sezione Ottenere la chiave API.

Impostazione dell'ID dell'istanza come variabile d'ambiente

A partire dalla versione 1.8.5 di cpdctl, gli utenti non devono più impostare instance ID come variabile d'ambiente. Questo metodo è deprecato e sarà completamente rimosso in una versione futura. Invece, è necessario impostare direttamente il sito instance ID utilizzando l'opzione profilo come descritto in Utilizzo dei comandi utente e profilo insieme

È necessario impostare un ID di istanza per accedere all'ambiente corrispondente per eseguire i comandi cpdctl. Per impostare l'ID dell'istanza, si può usare la variabile d'ambiente WX_DATA_INSTANCE_ID. Ciò consente di evitare di specificare l'ID dell'istanza con ogni comando.

Per impostare la variabile, eseguire il seguente comando in macOS e Linux:

export WX_DATA_INSTANCE_ID=<instance-id_value>

Dove <instance-id_value> è l'ID dell'istanza del software watsonx.data o il CRN dell'istanza watsonx.data su IBM Cloud, accessibile facendo clic sull'icona i nella homepage.

Per impostare la variabile, eseguire il seguente comando nel Prompt dei comandi di Windows:

set WX_DATA_INSTANCE_ID=<instance-id_value>

Per impostare la variabile, eseguire il seguente comando in Windows PowerShell:

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