Configuration de la clé de cryptage pour IBM cpdctl

Pour sécuriser vos mots de passe et vos clés d'API, IBM cpdctl utilise le chiffrement AES-256. Vous pouvez utiliser une clé de cryptage personnalisée ou la clé codée par défaut fournie par IBM cpdctl.

Vous pouvez fournir une clé de chiffrement personnalisée pour AES-256 en définissant la variable d'environnement CPDCTL_ENCRYPTION_KEY_PATH qui pointe vers le chemin du répertoire de stockage du fichier de la clé de chiffrement. Si cette variable d'environnement n'est pas définie, cpdctl utilisera sa propre clé de cryptage codée en dur.

Pour macOS et Linux:

export CPDCTL_ENCRYPTION_KEY_PATH=/path/cpdctl.key

Pour l'invite de commande Windows :

set CPDCTL_ENCRYPTION_KEY_PATH=/path/cpdctl.key

Pour Windows PowerShell:

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

utilisateur

La commande user permet de gérer les utilisateurs dans watsonx.data.

Syntaxe :

./cpdctl config user [commands]

La commande user prend également en charge les commandes suivantes :

./cpdctl config user set [commands] prend également en charge les commandes suivantes en tant qu'options à utiliser pour définir les informations d'identification :

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

Exemple de configuration d'un utilisateur dans une instance en nuage :

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

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

Pour watsonx.data sur IBM Cloud, il est recommandé d'utiliser --username et --apikey qui sont utilisés pour se connecter à la console. Pour plus d'informations, voir Obtenir une clé API.

profil

La commande profile gère les profils dans watsonx.data.

L'authentification unique (SSO) est activée dans la configuration de cpdctl.

Syntaxe :

./cpdctl config profile [commands]

La commande profile prend en charge les commandes suivantes :

./cpdctl config profile set [commands] prend également en charge les commandes suivantes en tant qu'options à utiliser pour définir les informations d'identification :

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

Exemple de configuration d'un profil à l'aide de la configuration user définie précédemment dans une instance 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

Utilisation conjointe des commandes user et profile

Vous pouvez combiner les deux commandes user et profile pour configurer le profil d'instance dans la configuration cpdctl. Un exemple d'utilisation de la combinaison est fourni ci-dessous :

Mise en place d'un profil d'instance cloud :

Syntaxe :

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

Exemple :

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

Pour watsonx.data sur IBM Cloud, il est recommandé d'utiliser --username et --apikey qui sont utilisés pour se connecter à la console. Pour plus d'informations, voir Obtenir une clé API.

Définition de l'identifiant de l'instance comme variable d'environnement

À partir de la version 1.8.5 de cpdctl, les utilisateurs ne doivent plus définir instance ID comme variable d'environnement. Cette méthode est obsolète et sera complètement supprimée dans une prochaine version. Au lieu de cela, vous devez définir l'adresse instance ID directement à l'aide de l'option profil comme décrit dans la section Utilisation conjointe des commandes user et profile

Vous devez définir un identifiant d'instance pour accéder à l'environnement correspondant afin d'exécuter les commandes cpdctl. Pour définir l'identifiant de l'instance, vous pouvez utiliser la variable d'environnement WX_DATA_INSTANCE_ID. Cela vous permet d'éviter de spécifier l'identifiant de l'instance à chaque commande.

Pour définir la variable, exécutez la commande suivante dans macOS et Linux:

export WX_DATA_INSTANCE_ID=<instance-id_value>

Où <instance-id_value> est l'identifiant de l'instance du logiciel watsonx.data ou le CRN de votre instance watsonx.data sur IBM Cloud, accessible en cliquant sur l'icône i de la page d'accueil.

Pour définir la variable, exécutez la commande suivante dans l'invite de commande Windows :

set WX_DATA_INSTANCE_ID=<instance-id_value>

Pour définir la variable, exécutez la commande suivante sous Windows PowerShell:

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