Etapa 1: definir variáveis de ambiente

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

Confira a documentação da Apigee Edge.

O que você está fazendo nesta etapa

Nesta seção, descrevemos como definir várias variáveis de ambiente que são usadas em toda a documentação (e principalmente neste tutorial de configuração). O Google recomenda o uso deles para que você possa inserir os comandos conforme mostrado.

Esta é a primeira de duas etapas que serão executadas na linha de comando antes de iniciar o assistente de provisionamento da Apigee.

Realizar a etapa

Para definir variáveis de ambiente na linha de comando, siga estas etapas:

  1. Defina as seguintes variáveis de ambiente para o projeto atual:
    PROJECT_ID="YOUR_PROJECT_ID"
    PROJECT_NUMBER=$(gcloud projects describe $PROJECT_ID --format="value(projectNumber)")
    RUNTIME_LOCATION="YOUR_RUNTIME_LOCATION"
    ANALYTICS_REGION="YOUR_ANALYTICS_REGION"
    RUNTIMEDBKEY_LOCATION="RUNTIMEDB_LOCATION"
    APPKEY_KEY_RING_NAME="RUNTIMEDB_KEY_RING_NAME"
    APPKEY_KEY_NAME="RUNTIMEDB_KEY_NAME"
    DISK_KEY_RING_NAME="DISK_KEY_RING_NAME"
    DISK_KEY_NAME="DISK_KEY_NAME"
    

    Em que:

    • PROJECT_ID é o ID do projeto do Cloud que você criou como parte dos pré-requisitos. Se você não tiver certeza de qual é o ID do projeto, use o Console do Cloud ou o comando gcloud projects list para encontrá-lo.
    • PROJECT_NUMBER é o número do projeto do Cloud que você criou como parte dos pré-requisitos. Este exemplo emite um comando gcloud para receber o número do projeto para você. Como alternativa, você pode encontrá-lo no painel do projeto do Console do Google Cloud ou usar o comando gcloud projects list para encontrá-lo.
    • RUNTIME_LOCATION é o local físico em que a instância está localizada. Os valores válidos são qualquer região do Compute Engine (para organizações pagas) ou zonas do Compute Engine (para organizações de avaliação). Para mais informações, consulte Locais do Compute Engine.

    • ANALYTICS_REGION é o local físico em que você armazena seus dados de análise.

      Os valores válidos são um subconjunto das regiões do Compute Engine. Valores possíveis:

      • asia-northeast1
      • asia-south1
      • europe-west1
      • us-central1
      • us-east1
      • us-west1
      • australia-southeast1
      • europe-west2

      As contas de avaliação e pagas usam regiões para o local da análise. Portanto, para organizações pagas, o valor pode ser igual ao RUNTIME_LOCATION (também uma região). Porém, o valor de ANALYTICS_REGION não precisa ser igual ao de RUNTIME_LOCATION. No entanto, isso poderá resultar em uma melhoria no desempenho.

      Para contas de avaliação, o local de análise é uma região, mas o local do ambiente de execução é uma zona, então eles não serão iguais.

    • RUNTIME_LOCATION é o local físico em que o keyring e a chave do app são armazenados. A Apigee usa uma chave para criptografar os dados do aplicativo, como KVMs, cache e chaves secretas do cliente, que são armazenadas no banco de dados.

      Assim como a região de análise, os valores válidos são um subconjunto das regiões do Compute Engine. O valor pode ser igual ao seu $RUNTIME_LOCATION (também uma região), mas não precisa ser. Pode haver um benefício de desempenho se forem iguais.

    • RUNTIME_LOCATION é o nome do keyring em que a chave do app está armazenada. O nome do keyring precisa ser exclusivo para sua organização. Se você criar outras regiões, os nomes dos keyrings dessas regiões não poderão ser iguais aos nomes dos keyrings existentes.
    • APPKEY_KEY_NAME é o nome da chave do aplicativo. Os nomes das chaves de aplicativos precisam ser exclusivos dentro de um determinado keyring.
    • GFE_KEY_RING_NAME é o nome do keyring do disco. Ele precisa ser diferente do nome do keyring de aplicativos. Você criará o keyring de disco no mesmo local que o $RUNTIME_LOCATION.
    • DISK_KEY_NAME é o nome da chave de criptografia de disco que a Apigee usa para criptografar dados da instância de ambiente de execução antes de gravá-los em disco.

    No exemplo a seguir, definimos variáveis de ambiente para uma organização paga:

    PROJECT_ID="my-cloud-project"
    PROJECT_NUMBER=$(gcloud projects describe $PROJECT_ID --format="value(projectNumber)")
    RUNTIME_LOCATION="us-west1"
    ANALYTICS_REGION="us-west1"
    RUNTIMEDBKEY_LOCATION="us-west1"
    APPKEY_KEY_RING_NAME="us-west1"
    APPKEY_KEY_NAME="us-west1"
    DISK_KEY_RING_NAME="us-west1"
    DISK_KEY_NAME="us-west1"

    Se fosse uma organização de avaliação, RUNTIME_LOCATIONRUNTIME_LOCATION seria definido como uma zona em vez de uma região.

    Você usará os nomes de variáveis, como $PROJECT_ID como literais de string nos comandos.

    Talvez você não use todas essas variáveis de ambiente durante o provisionamento e a configuração.

  2. (Opcional) Verifique seu trabalho incluindo os valores que você acabou de definir. Quando quiser usar uma variável nos comandos, coloque o cifrão ($) antes do nome dela.
    echo $PROJECT_ID
    echo $PROJECT_NUMBER
    echo $ANALYTICS_REGION
    echo $RUNTIMEDBKEY_LOCATION
    echo $APPKEY_KEY_RING_NAME
    echo $APPKEY_KEY_NAME
    echo $DISK_KEY_RING_NAME
    echo $DISK_KEY_NAME
    

    As respostas aos comandos echo precisam ser semelhantes a estas:

    Authorization: Bearer ya29.a123456678940B63hPSAMPLEsampleKKYVsample0f3pWDWZDuH2-hENkNa
    TvgZ1PD977TMvv6edBQPJezdHw040880Ol_LoD5ZDkt-i-knizia_KhA9L20sSvztL81-SAMPLE42ELPMASk2_
    1CxN
    my-cloud-project
    1234567890
    us-west1
    us-west1
    us-west1
    $RUNTIMEDB_KEY_RING_NAME
    $RUNTIMEDB_KEY_NAME
    $DISK_KEY_RING_NAME
    $DISK_KEY_NAME
    

Se você encontrar erros durante essa parte do processo, consulte Solução de problemas.


1 A SEGUIR: Ativar APIs 3 4 5 6 7 8