comandos config y uso
El comando config tiene además diferentes comandos dentro, usando los cuales puedes configurar el entorno IBM® watsonx.data en IBM cpdctl. Este tema enumera los comandos con una breve descripción de las tareas que se pueden realizar.
El comando config gestiona la configuración de perfiles y usuarios para watsonx.data. La instancia watsonx.data debe estar abierta en el navegador web mientras se configuran y realizan las operaciones.
Sintaxis:
./cpdctl config [commands]
El comando config admite los siguientes comandos:
Puede configurar el usuario y el perfil ejecutando estos comandos por separado. Se recomienda utilizar los comandos combinados para establecer el perfil y los usuarios a través de un único comando. Para obtener más información, consulte Uso conjunto de los comandos usuario y perfil.
Configuración de la clave de cifrado para IBM cpdctl
Para proteger sus contraseñas y claves API, IBM cpdctl utiliza el cifrado AES-256. Puede utilizar una clave de cifrado personalizada o la clave codificada por defecto que proporciona IBM cpdctl.
Puede proporcionar una clave de encriptación personalizada para AES-256 configurando la variable de entorno CPDCTL_ENCRYPTION_KEY_PATH que apunta a la ruta del directorio que contiene el archivo de clave de encriptación. Si no se establece esta variable de entorno, cpdctl utilizará su propia clave de cifrado.
Para macOS y Linux:
export CPDCTL_ENCRYPTION_KEY_PATH=/path/cpdctl.key
Para el símbolo del sistema de Windows:
set CPDCTL_ENCRYPTION_KEY_PATH=/path/cpdctl.key
Para Windows PowerShell:
$env:CPDCTL_ENCRYPTION_KEY_PATH = "/path/cpdctl.key"
usuario
El comando user gestiona los usuarios en watsonx.data.
Sintaxis:
./cpdctl config user [commands]
El comando user admite además los siguientes comandos:
| Opciones | Descripción |
|---|---|
./cpdctl config user set [commands] |
Establezca las credenciales de un usuario en la configuración de cpdctl para conectarse a la instancia watsonx.data. |
./cpdctl config user list |
Lista las credenciales almacenadas en la configuración cpdctl que se utiliza para conectarse a la instancia watsonx.data. |
./cpdctl config user get <username> |
Obtiene las credenciales de un usuario almacenado en la configuración de cpdctl que se utiliza para conectarse a la instancia watsonx.data. |
./cpdctl config user unset <username> |
Elimina el nombre de usuario actual de la configuración cpdctl de la instancia watsonx.data. |
./cpdctl config user set [commands] admite además los siguientes comandos como opciones para configurar las credenciales:
--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
Ejemplo de configuración de un usuario en una instancia en la nube:
./cpdctl config user set <user> --username <saas_username> --apikey <APIKEY>
./cpdctl config user set user2 --username user@ibm.com --apikey APIKEY
Para watsonx.data en IBM Cloud, se recomienda utilizar --username y --apikey que se utilizan para acceder a la consola. Para más información, consulte Obtener clave API.
perfil
El comando profile gestiona los perfiles en watsonx.data.
El inicio de sesión único (SSO) está activado en la configuración de cpdctl.
Sintaxis:
./cpdctl config profile [commands]
El comando profile admite los siguientes comandos:
| Opciones | Descripción |
|---|---|
./cpdctl config profile set [commands] |
Establezca el perfil de entorno watsonx.data en la configuración de cpdctl. |
./cpdctl config profile list |
Lista todos los perfiles de entorno watsonx.data establecidos en la configuración de cpdctl. |
./cpdctl config profile get <profilename> |
Obtenga detalles del perfil de entorno watsonx.data desde la configuración de cpdctl. |
./cpdctl config profile unset <profilename> |
Eliminar el perfil de entorno watsonx.data de la configuración de cpdctl. |
./cpdctl config profile current |
Obtiene detalles del perfil de entorno watsonx.data actual utilizado desde la configuración de cpdctl. |
./cpdctl config profile use <profilename> |
Utilizar un perfil de entorno watsonx.data concreto de la configuración de cpdctl. |
./cpdctl config profile set [commands] admite además los siguientes comandos como opciones para configurar las credenciales:
--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.
Ejemplo de configuración de un perfil utilizando la configuración de user establecida anteriormente en una instancia en la nube:
./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
Uso conjunto de los comandos usuario y perfil
Puede combinar los dos comandos user y profile para configurar el perfil de instancia en la configuración de cpdctl. A continuación se ofrece un ejemplo de cómo utilizar la combinación:
Configuración de un perfil de instancia en la nube:
Sintaxis:
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>"
Ejemplo:
./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/"
Para watsonx.data en IBM Cloud, se recomienda utilizar --username y --apikey que se utilizan para acceder a la consola. Para más información, consulte Obtener clave API.
Establecer el ID de instancia como variable de entorno
A partir de la versión de cpdctl 1.8.5, los usuarios ya no necesitan establecer instance ID como variable de entorno. Este método está obsoleto y se eliminará por completo en una futura versión. En su lugar, debe configurar la dirección
instance ID directamente mediante la función
Debe establecer un ID de instancia para acceder al entorno correspondiente y ejecutar los comandos cpdctl. Para establecer el ID de instancia, puede utilizar la variable de entorno WX_DATA_INSTANCE_ID. Esto le permite evitar especificar
el ID de instancia con cada comando.
Para establecer la variable, ejecute el siguiente comando en macOS y Linux:
export WX_DATA_INSTANCE_ID=<instance-id_value>
Donde, <instance-id_value> es el ID de instancia de la instancia de software watsonx.data o CRN de su instancia watsonx.data en IBM Cloud a la que puede acceder haciendo clic en el icono i de la página de inicio.
Para establecer la variable, ejecute el siguiente comando en el símbolo del sistema de Windows:
set WX_DATA_INSTANCE_ID=<instance-id_value>
Para establecer la variable, ejecute el siguiente comando en Windows PowerShell:
$env:WX_DATA_INSTANCE_ID = "<instance-id_value>"