Como trabalhar com referências

Esta página se aplica à Apigee e à Apigee híbrida.

Confira a documentação da Apigee Edge.

Ao configurar um TargetServer para aceitar TLS, você especifica um keystore ou confiáveis, usando uma referência. Uma referência é uma variável que contém o nome do keystore ou do truststore, em vez de especificar o nome do keystore ou truststore diretamente.

Uma referência pode ser representada por um objeto XML como este:

  <reference>
    <name>ReferenceName</name>
    <description>ReferencDescription</description>
    <resourceType>ReferredResourceType<resourceType>
    <refers>ReferredResource<refers>
  </reference>

A vantagem de usar uma referência é poder alterar o valor da referência para mudar o keystore usado pelo servidor de destino, geralmente porque o certificado no keystore atual expira em breve.

Só é possível usar uma referência ao keystore e truststore. Não é possível usar uma referência ao alias. Ao alterar a referência para um keystore, verifique se o nome do alias do certificado é o mesmo do keystore antigo.

Restrições ao usar referências a keystores e truststore

Se você tiver um balanceador de carga e encerrar o TLS no balanceador, não será possível usar as referências do keystore e truststore no servidor de destino.

Criar uma referência

Use a IU ou a API da Apigee para criar uma nova referência.

Apigee no console Google Cloud

Para criar uma referência usando o console Google Cloud :

  1. No console do Google Cloud , acesse a página Gerenciamento > Ambientes.

    Acessar "Ambientes"

  2. Selecione o ambiente em que você quer criar a referência.

  3. Clique na guia Referências.

  4. Clique em Criar referência.

  5. No painel Criar referência, insira os seguintes detalhes:
    • Nome: o nome da referência.
    • Keystore: o keystore para o qual a referência aponta.

  6. Clique em Criar.

IU clássica

Para criar uma referência usando a IU, faça o seguinte:

  1. Faça login na IU da Apigee.
  2. Selecione o nome da sua organização.
  3. Selecione Administrador > Ambientes > Referências.
  4. Selecione o ambiente (geralmente prod ou test).
  5. Selecione o botão + Referência.
  6. No pop-up Adicionar referência, faça o seguinte:
    1. Adicione o nome da referência.
    2. Selecione a Referência, o keystore ou o warehouse de referência.
    3. Selecione Adicionar referência.

API

Para criar uma referência usando a chamada de API Criar referência:

      curl -H "Authorization: Bearer $TOKEN" \
        -X POST \
        -d '{
            "reference": {
              "name": MyReferenceName",
              "resourceType": "KeyStore",
              "refers": "KeyStoreID"
            }
           }' \
        https://apigee.googleapis.com/v1/{parent=organizations/*/environments/*}/references

Modificar uma referência

É possível usar a IU ou a API da Apigee para modificar uma referência atual.

Apigee no console Google Cloud

Para modificar uma referência usando o console do Google Cloud :

  1. No console do Google Cloud , acesse a página Gerenciamento > Ambientes.

    Acessar "Ambientes"

  2. Selecione o ambiente em que você quer modificar a referência.

  3. Clique na guia Referências.

  4. Na lista exibida, selecione a referência que você quer modificar.

  5. Clique em Ações > Editar.

  6. No painel Editar referência, atualize a referência para especificar o novo keystore.

  7. Clique em Atualizar.

IU clássica da Apigee

Para modificar o valor de uma referência na IU:

  1. Faça login na IU da Apigee.
  2. Selecione o nome da sua organização.
  3. Selecione Administrador > Ambientes > Referências.
  4. Selecione o ambiente (geralmente prod ou test).
  5. Selecione o botão Editar para a referência.
  6. Atualize a referência para especificar o novo keystore ou truststore. Cuidado: verifique se o alias no novo keystore tem o mesmo nome que o alias no keystore antigo.
  7. Salve suas atualizações.

API

Para mudar a referência a fim de direcionar para um keystore diferente, garantindo que o alias no novo keystore tenha o mesmo nome que o do keystore antigo, use a API Update Reference:

        curl -H "Authorization: Bearer $TOKEN" \
          -X PUT \
          -d '{
              "name": "MyReferenceName",
              "resourceType": "KeyStore",
              "refers": "KeyStoreID"
              }' \
        https://apigee.googleapis.com/v1/{name=organizations/*/environments/*/references/*}