Configuração da chave de criptografia para IBM cpdctl

Para proteger suas senhas e chaves de API, o IBM cpdctl usa a criptografia AES-256. Você pode usar uma chave de criptografia personalizada ou a chave padrão codificada fornecida pelo IBM cpdctl.

Você pode fornecer uma chave de criptografia personalizada para AES-256 definindo a variável de ambiente CPDCTL_ENCRYPTION_KEY_PATH que aponta para o caminho do diretório de retenção do arquivo de chave de criptografia. Se essa variável de ambiente não for definida, o cpdctl usará sua própria chave de criptografia codificada.

Para macOS e Linux:

export CPDCTL_ENCRYPTION_KEY_PATH=/path/cpdctl.key

Para o prompt de comando do Windows:

set CPDCTL_ENCRYPTION_KEY_PATH=/path/cpdctl.key

Para Windows PowerShell:

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

Usuário

O comando user gerencia usuários em watsonx.data.

Sintaxe:

./cpdctl config user [commands]

O comando user também oferece suporte aos seguintes comandos:

./cpdctl config user set [commands] suporta ainda mais os seguintes comandos como opções a serem usadas para definir as credenciais:

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

Exemplo de configuração de um usuário em uma instância de nuvem:

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

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

Para watsonx.data em IBM Cloud, é recomendável usar --username e --apikey, que são usados para fazer login no console. Para obter mais informações, consulte Obter chave de API.

perfil

O comando profile gerencia perfis em watsonx.data.

O login de logon único (SSO) está ativado na configuração do cpdctl.

Sintaxe:

./cpdctl config profile [commands]

O comando profile oferece suporte aos seguintes comandos:

./cpdctl config profile set [commands] suporta ainda mais os seguintes comandos como opções a serem usadas para definir as credenciais:

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

Exemplo de configuração de um perfil usando a configuração user definida anteriormente em uma instância de nuvem:

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

Usar os comandos user e profile juntos

Você pode combinar os dois comandos user e profile para configurar o perfil da instância na configuração do cpdctl. Uma ilustração de exemplo de como usar a combinação é fornecida abaixo:

Configuração de um perfil de instância de nuvem:

Sintaxe:

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

Exemplo:

./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 em IBM Cloud, é recomendável usar --username e --apikey, que são usados para fazer login no console. Para obter mais informações, consulte Obter chave de API.

Definição do ID da instância como variável de ambiente

A partir da versão 1.8.5 do cpdctl, os usuários não precisam mais definir instance ID como variável de ambiente. Esse método está obsoleto e será completamente removido em uma versão futura. Em vez disso, você deve definir o instance ID diretamente usando o perfil conforme descrito em Usando os comandos user e profile juntos

Você deve definir um ID de instância para acessar o ambiente correspondente e executar os comandos cpdctl. Para definir a ID da instância, você pode usar a variável de ambiente WX_DATA_INSTANCE_ID. Isso permite que você evite especificar o ID da instância em cada comando.

Para definir a variável, execute o seguinte comando em macOS e Linux:

export WX_DATA_INSTANCE_ID=<instance-id_value>

Onde <instance-id_value> é o ID da instância do software watsonx.data ou o CRN da sua instância watsonx.data em IBM Cloud, que pode ser acessado clicando no ícone i na página inicial.

Para definir a variável, execute o seguinte comando no prompt de comando do Windows:

set WX_DATA_INSTANCE_ID=<instance-id_value>

Para definir a variável, execute o seguinte comando no Windows PowerShell:

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