Configuração de seu ambiente de CLI e API

Antes de criar um IBM® Storage Ceph® as a Service usando a API ou a CLI, configure seu ambiente.

Pré-requisitos gerais

  1. Configure sua conta para acessar IBM Storage Ceph as a Service. Certifique-se de que a conta seja atualizada para uma conta paga.

  2. Certifique-se de que você tenha em mãos a lista de endpoints locais que foram fornecidos para implementação.

    Você pode definir os endpoints como variáveis de ambiente.

Pré-requisitos da CLI

Antes de poder usar a CLI, é necessário instalar a CLI do IBM Cloud e o plug-in da CLI do IBM Storage Ceph as a Service.

Certifique-se de que o ambiente no qual a CLI será executada esteja conectado à rede local antes de usar a CLI na implementação local do site IBM Storage Ceph as a Service.

  1. Instale a CLI do IBM Cloud.

  2. Instale o plug-in IBM Storage Ceph as a Service CLI software-defined-storage.

    ibmcloud plugin install software-defined-storage
    

    As ações da CLI IBM Storage Ceph as a Service também usam os aliases sds. Para saber como usar os comandos da CLI, é possível executar:

    ibmcloud sds --help
    ibmcloud sds volume-create --help
    ibmcloud sds host-create --help
    

Acesso à CLI por meio do ponto de extremidade da API

Para configurar a CLI para usar o ponto de extremidade da API, siga estas etapas:

Se precisar fazer o download da CLI do IBM Cloud e dos plug-ins associados, você deverá poder acessar o repositório público onde eles estão localizados.

  1. Certifique-se de que o núcleo da CLI do IBM Cloud e o plug-in IBM Storage Ceph as a Service estejam atualizados para a versão mais recente:

    ibmcloud update
    
    ibmcloud plugin update software-defined-storage
    
  2. Para especificar um endpoint de API, digite o seguinte comando:

    ibmcloud login -a https://cloud.ibm.com
    

    Para obter mais informações sobre os detalhes das opções da CLI, consulte login do ibmcloud.

Configurar o token do IAM

Antes de usar a CLI para criar seu IBM Storage Ceph as a Service, você deve obter um token do IAM, armazenar o endpoint como uma variável e verificar se tem acesso ao serviço IBM Storage Ceph as a Service.

IAM_TOKEN=$(ibmcloud iam oauth-tokens --output json | jq -r '.iam_token)

Pré-requisitos da API

Antes de usar a API para criar seu IBM Storage Ceph as a Service, você deve obter um token do IAM, armazenar o endpoint como uma variável e verificar se tem acesso ao serviço da API CephaaS.

Os exemplos a seguir usam o terminal regional us-south.

Etapa 1: armazene sua chave de API como uma variável

Execute o comando a seguir para armazenar a chave de API para sua conta em uma variável de ambiente. Se você não tiver uma chave de API, consulte Criando uma chave de API.

apikey="<YOUR_API_KEY>"

Etapa 2: obter um token do IBM Identity and Access Management (IAM)

Execute o comando a seguir para obter e analisar um token do IAM usando o utilitário de processamento de JSON jq. É possível modificar o comando para usar outra ferramenta de análise ou remover a última parte dele para analisar o token manualmente.

IAM_TOKEN=`curl -k -X POST \
  --header "Content-Type: application/x-www-form-urlencoded" \
  --header "Accept: application/json" \
  --data-urlencode "grant_type=urn:ibm:params:oauth:grant-type:apikey" \
  --data-urlencode "apikey=$apikey" \
  "https://iam.cloud.ibm.com/identity/token"  |jq -r '(.token_type + " " + .access_token)'`

Para visualizar o token do IAM, execute echo $IAM_TOKEN. O resultado deve ser semelhante a este:

Bearer <your token>

O cabeçalho de Autorização espera que o token inicie com "Bearer". Se o resultado não incluir "Portador", atualize a variável IAM_TOKEN para incluí-lo. Esses exemplos presumem que "Bearer" está incluído no IAM_TOKEN.

Um token do IAM é válido por até 60 minutos e está sujeito a mudança. Quando um token expirar, deve-se gerar um novo. Use a propriedade expires_in para definir a validade do token do IAM que você acabou de criar.

Etapa 3: armazene o terminal de API como uma variável

O $sds_endpoint é uma variável de ambiente que aponta para o endpoint fornecido a você quando o IBM Storage Ceph as a Service foi configurado. Ele está no formulário URL. Por exemplo, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}. Execute o comando a seguir para armazenar o terminal de API em uma variável, para que ele possa ser reutilizado posteriormente em sua sessão.

Por exemplo:

sds_api_endpoint="https://sds-cephaas.936481b2-379d-4ca6-94ed-4dc1911d749f.software-defined-storage.appdomain.cloud:33173"

Para verificar se essa variável foi salva, execute echo $sds_endpoint e certifique-se de que a resposta não seja vazia.

Etapa 4: Verifique se você tem acesso à API

Agora que você tem um endpoint e seu token IAM, verifique seu acesso à API por meio de uma das APIs descritas na Referência da API.

Se você se deparar com resultados inesperados, inclua a sinalização --verbose (depuração) após o comando curl para obter informações detalhadas de criação de log.