Configurando a CLI

É possível usar o plug-in da CLI do IBM Key Protect para ajudar a criar, importar e gerenciar as chaves de criptografia.

Para saber mais sobre o uso do plug-in da CLI do Key Protect, confira o documento de referência da CLI do Key Protect.

Instalando o plug-in da CLI do Key Protect

Antes de configurar o plug-in da CLI do Key Protect, instale a IBM Cloud CLI.

Para instalar as CLIs:

Instale o IBM Cloud CLI.

Após instalar a CLI, será possível executar os comandos ibmcloud para interagir com os serviços de nuvem.
Efetue login no IBM Cloud.
```
ibmcloud login
```
Se o login falhar, execute o comando ibmcloud login --sso para tentar novamente. Os comandos --sso é necessário quando você faz login com um ID federado. Se essa opção for usada, acesse o link listado na saída da CLI para gerar uma senha descartável.
Para iniciar o gerenciamento de chaves de criptografia, instale o plug-in da CLI do Key Protect.
```
ibmcloud plugin install key-protect -r "IBM Cloud"
```
Configure a região para direcionar um terminal do Key Protect específico.
```
ibmcloud kp region-set -i <INSTANCE_ID>
```
Substitua <INSTANCE_ID> pelo ID da instância que representa seu Key Protect. Saiba mais sobre sua instância, incluindo a escolha de regiões, em Provisionando o serviço Key Protect.

Será solicitado que escolha a partir de uma lista, conforme mostrado nos resultados.
```
Select a Region:
    1. au-syd
    2. eu-de
    3. eu-gb
    4. jp-osa
    5. jp-tok
    6. us-east
    7. us-south
    8. staging (us-south)
    Enter a number:
```

Definir o ponto de extremidade da instância:

export KP_TARGET_ADDR=<KEY_PROTECT_INSTANCE_ENDPOINT>

Substitua <KEY_PROTECT_INSTANCE_ENDPOINT> pelo ponto final do ID de sua instância. Por exemplo:

export KP_TARGET_ADDR=https://fadedbee-0000-0000-0000-1234567890ab.api.us-south.kms.appdomain.cloud

Você pode encontrar o ponto de extremidade da instância para Key Protect no console da interface do usuário IBM Cloud para sua instância específica.

Opcional: verifique se o plug-in foi instalado com êxito.
```
ibmcloud plugin list
```

Atualizando o plug-in da CLI do Key Protect

Para melhores práticas, é possível optar por atualizar a CLI periodicamente para usar novos recursos.

Para atualizar a CLI:

Efetue login no IBM Cloud usando IBM Cloud CLI.
```
ibmcloud login
```
Se o login falhar, execute o comando ibmcloud login --sso para tentar novamente. Os comandos --sso é necessário quando você faz login com um ID federado. Se essa opção for usada, acesse o link listado na saída da CLI para gerar uma senha descartável.
Instale a atualização do repositório de plug-in.
```
ibmcloud plugin update key-protect
```

Opcional: verifique se o plug-in foi atualizado com êxito.

ibmcloud plugin list

Os resultados podem mostrar a versão e o status dos plug-ins, bem como propriedades sobre os plug-ins, como informações sobre o suporte para "terminais privados".


Plugin Name                             Version   Status             Private endpoints supported   
cloud-functions[wsk/functions/fn]       1.0.49    Update Available   false   
cloud-object-storage                    1.2.4     Update Available   false   
container-registry                      0.1.541   Update Available   true   
container-service[kubernetes-service]   1.0.233   Update Available   false   
key-protect                             0.6.8                        true   
sdk-gen                                 0.1.12                       false

Desinstalando o plug-in da CLI do Key Protect

Efetue login no IBM Cloud usando IBM Cloud CLI.
```
ibmcloud login
```
Se o login falhar, execute o comando ibmcloud login --sso para tentar novamente. Os comandos --sso é necessário quando você faz login com um ID federado. Se essa opção for usada, acesse o link listado na saída da CLI para gerar uma senha descartável.
Instale a atualização do repositório de plug-in.
```
ibmcloud plugin uninstall key-protect
```
Opcional: verifique se o plug-in foi desinstalado com êxito.
```
ibmcloud plugin list
```