Etapa 3: criar um grupo de ambientes

Nesta etapa, você criará um ambiente e um grupo de ambiente.

Na Apigee, os proxies de API são implantados em ambientes, que fornecem contextos isolados para seus proxies. Os ambientes são organizados em grupos de ambiente, que fornecem nomes do host para todos os proxies implantados nos ambientes do grupo. É preciso ter pelo menos um ambiente e pelo menos um grupo de ambientes. Para saber mais, consulte Sobre ambientes e grupos de ambiente.

Criar um ambiente

Crie o ambiente antes de criar o grupo. É possível criar um ambiente usando a IU da Apigee ou a API. Use a IU para conhecer as etapas a seguir.

Apigee no console do Cloud

Para criar um novo ambiente na Apigee no console do Cloud:

  1. Abra a interface da Apigee no console do Cloud em um navegador.
  2. Selecione Gerenciamento > Ambientes no painel de navegação à esquerda.
  3. No painel Ambientes, clique em + Criar ambiente.
  4. No painel Criar um ambiente, insira o seguinte:
    • Nome: é o nome do ambiente programático. O Nome não pode ser alterado após a criação.

      O nome precisa ter entre dois e 32 caracteres, que podem ser letras minúsculas, números ou hifens. O nome precisa começar com uma letra e não pode terminar com um hífen. O nome precisa ser diferente de qualquer outro nome de ambiente da organização.

    • Nome de exibição: o nome do ambiente exibido na IU.
    • Descrição: opcional. Uma descrição do ambiente.
    • Instância: deixe o campo Instance em branco. As instâncias não se aplicam às instalações da Apigee híbrida.
    • Grupo de ambientes: deixe o campo Grupo de ambientes em branco por enquanto. Você criará um grupo de ambiente no próximo procedimento.
    • Tipo de implantação: para a maioria das instalações da Apigee híbrida, selecione a opção para implantar proxies de API individuais. Você tem a opção de implantar um arquivo do ambiente de configuração do proxy de API. Para mais informações, consulte Tipos de implantação compatíveis.
  5. Clique em Criar.

Após a conclusão, o novo ambiente é exibido na tabela no painel Ambientes.

IU clássica da Apigee

Para acessar a IU híbrida e adicionar um ambiente, siga as seguintes etapas:

  1. Abra a IU da Apigee. Se esta for a primeira vez que você faz login, o híbrido exibirá uma caixa de diálogo de consentimento. Se for solicitado que você selecione mais de uma conta, escolha a conta proprietária do projeto do Google Cloud que você está usando para instalar a Apigee híbrida. Clique em Permitir.
  2. Seu navegador acessa a página de destino principal da IU do híbrido.

    A página de destino na IU da Apigee, que consiste em navegação à esquerda e imagens grandes que são links.

  3. Verifique se a organização está selecionada na lista suspensa. Se não estiver selecionada, selecione-o na lista suspensa, conforme mostrado no exemplo a seguir:

    Uma lista de organizações com a ativação híbrida

  4. Clique em Administrador > Ambientes > Visão geral.

    Menu da IU do híbrido da Apigee mostrando "Administrador", "Ambientes" e "Visão geral" expandido

    A visualização Ambientes será exibida, sem ambientes (ainda):

  5. Clique em +Ambiente.

    A caixa de diálogo de Novo ambiente é exibida:

    A nova caixa de diálogo de ambiente

  6. Digite as informações a seguir na caixa de diálogo Novo ambiente:
    1. Nome de exibição (obrigatório): um nome amigável do ambiente usado na IU. Por exemplo, "Meu primeiro ambiente" ou "teste". Ao contrário do Nome do ambiente, o Nome de exibição pode incluir caracteres maiúsculos e outros.
    2. Environment name (obrigatório): é o nome programático do ambiente. também conhecido como ID do ambiente.

      Por exemplo, "my-environment" ou "test".

      O Nome de exibição e o Nome do ambiente podem ser diferentes.

    3. Descrição (opcional): informações adicionais sobre o ambiente que você quer adicionar como um lembrete da finalidade do ambiente. Por exemplo, "Criado durante a instalação inicial".
  7. Mantenha os outros valores padrão e clique em Criar.

    A Apigee cria o novo ambiente.

    Agora você precisa criar um grupo de ambientes e adicionar o novo ambiente a ele.

API Apigee

Para criar um ambiente com a API Create Environments, siga as seguintes etapas:

  1. Abra um terminal no dispositivo que você está usando para gerenciar a Apigee.
  2. Na linha de comando, receba as credenciais de autenticação de gcloud. Use o comando a seguir:

    Linux / MacOS

    export TOKEN=$(gcloud auth print-access-token)

    Para verificar se o token foi preenchido, use echo, como mostra o exemplo a seguir:

    echo $TOKEN

    Isso exibirá seu token como uma string codificada.

    Windows

    for /f "tokens=*" %a in ('gcloud auth print-access-token') do set TOKEN=%a

    Para verificar se o token foi preenchido, use echo, como mostra o exemplo a seguir:

    echo %TOKEN%

    Isso exibirá seu token como uma string codificada.

  3. Crie a seguinte variável de ambiente:

    Linux / MacOS

    export ENV_NAME="YOUR_ENV_NAME"

    Windows

    set ENV_NAME="YOUR_ENV_NAME"

    Em que:

    • ENV_NAME (Necessário) O nome do ambiente pode conter letras minúsculas, traços e números e precisa começar com uma letra minúscula. Esse nome será usado como o identificador e não poderá ser alterado após a criação do ambiente.
  4. Chame a seguinte API da Apigee:
    curl -H "Authorization: Bearer $TOKEN" -X POST -H "content-type:application/json"   -d '{
        "name": "'"$ENV_NAME"'"
      }'   "https://apigee.googleapis.com/v1/organizations/$ORG_NAME/environments"

    Em uma solicitação de criação bem-sucedida, a API Environments responderá com uma mensagem semelhante à seguinte:

    {
      "name": "organizations/hybrid-example/operations/c2aee040-7e79-4fd4-b0cf-79ca1b7098a8",
      "metadata": {
        "@type": "type.googleapis.com/google.cloud.apigee.v1.OperationMetadata",
        "operationType": "INSERT",
        "targetResourceName": "organizations/hybrid-example/environments/example-env",
        "state": "IN_PROGRESS"
      }
    }

    Como a propriedade state na resposta indica, a Apigee começou a criar o novo ambiente. Portanto, seu estado é IN_PROGRESS.

  5. Verifique se o ambiente foi criado:
    curl -H "Authorization: Bearer $TOKEN" \
              "https://apigee.googleapis.com/v1/organizations/$ORG_NAME/environments"

    Em uma solicitação de criação bem-sucedida, a API Environments responde com uma mensagem semelhante a esta:

    [
      "your-environment-name"
    ]

Criar um grupo de ambiente

Agora crie um grupo de ambiente e atribua o ambiente criado nele.

Apigee no console do Cloud

Para criar um novo grupo de ambiente na Apigee no console do Cloud:

  1. Abra a interface da Apigee no console do Cloud em um navegador.
  2. Selecione Gerenciamento > Ambientes no painel de navegação à esquerda.
  3. No painel Ambientes, selecione Grupos de ambientes.
  4. Clique em + Criar grupo de ambiente.
  5. Digite o seguinte:
    • Nome do grupo de ambientes: um nome para o grupo de ambientes. O nome precisa começar e terminar com um caractere alfanumérico. Ele pode ter até 63 caracteres alfanuméricos e hífens. O nome precisa ser diferente de qualquer nome de grupo de ambiente na organização.
    • Hostames: uma lista de nomes de host que podem ser usados para chamar proxies. Cada nome de host precisa estar em uma linha separada.

      Você também pode clicar em Configurar o balanceador de carga do Google com estes domínios. Isso abre a página Balanceamento de carga no Console do Cloud, onde é possível configurar o balanceamento de carga dos nomes de host.

    • Ambientes: uma lista opcional de ambientes para incluir no grupo.
  6. Clique em Criar.

IU clássica da Apigee

Para criar um grupo de ambiente usando a IU da Apigee, siga estas etapas:

  1. Abra a IU da Apigee.
  2. Seu navegador acessa a página de destino principal da IU do híbrido.

  3. Verifique se a organização está selecionada na lista suspensa. Se não estiver, selecione-a na lista suspensa.
  4. Clique em Administrador > Ambientes > Grupos.

    A visualização Visão geral dos grupos de ambientes é exibida:

    A visualização "Grupos de ambientes"

  5. Clique em +Grupo de ambiente.

    A caixa de diálogo Adicionar grupo de ambiente é exibida.

    Caixa de diálogo "Adicionar grupo de ambiente" mostrando o campo "Nome" em branco

  6. Digite um nome e clique em Adicionar.
  7. Mantenha o cursor do mouse sobre o grupo de ambiente recém-criado e clique em Editar .

    Adicione um nome de host que será usado por todas as proxies implementadas nos ambientes do grupo. Precisa ser um domínio que você tenha acesso de gerenciamento. O nome do host pode ser o próprio domínio, como example.com, ou pode incluir um subdomínio como my-proxies.example.com.

    Se você precisar registrar um domínio, consulte um registrador de domínios, como o Google Domains.

    Também é possível configurar um balanceador de carga para o domínio. Para saber mais sobre balanceadores de carga, consulte Visão geral do Cloud Load Balancing.

    Janela "Editar grupo de ambiente" mostrando nenhum ambiente atribuído

  8. Clique em Adicionar (+) na caixa Ambientes.
  9. A caixa de diálogo Adicionar ambiente é exibida.

    Caixa de diálogo "Adicionar ambiente" listando os ambientes disponíveis

  10. Selecione um ambiente na lista e clique em Adicionar.
  11. Clique em Save.

API Apigee

Para criar um grupo de ambiente usando a API da Apigee:

  1. Na linha de comando, receba as credenciais de autenticação de gcloud usando o comando a seguir:

    Linux / MacOS

    TOKEN=$(gcloud auth print-access-token)

    Windows

    for /f "tokens=*" %a in ('gcloud auth print-access-token') do set TOKEN=%a
  2. Crie as variáveis de ambiente a seguir.

    Linux / MacOS

    export DOMAIN="YOUR_DOMAIN"
    export ENV_GROUP="YOUR_ENVIRONMENT_GROUP"

    Windows

     data-terminal-prefix=">">set ENV_GROUP="YOUR_ENVIRONMENT_GROUP"
     data-terminal-prefix=">">set DOMAIN="YOUR_DOMAIN"

    Em que:

    • DOMAIN (Obrigatório) Este é o nome do host que todos os proxies implantados nos ambientes deste grupo vão usar. Este deve ser um domínio que você gerencia. O endereço pode ser o próprio domínio, comoexample.com, ou pode incluir um subdomínio como my-proxies.example.com. Se você não tiver um domínio gerenciado, insira um marcador por enquanto. É possível alterar o endereço do domínio depois.
    • ENV_GROUP (Necessário) O nome do ambiente pode conter letras minúsculas, traços e números e precisa começar com uma letra minúscula. Esse nome será usado como o identificador e não poderá ser alterado após a criação
  3. Crie o grupo de ambiente:
    curl -H "Authorization: Bearer $TOKEN" -X POST -H "content-type:application/json" \
       -d '{
         "name": "'"$ENV_GROUP"'",
         "hostnames":["'"$DOMAIN"'"]
       }' \
       "https://apigee.googleapis.com/v1/organizations/$ORG_NAME/envgroups"
        
  4. Atribua o ambiente ao novo grupo:
    curl -H "Authorization: Bearer $TOKEN" -X POST -H "content-type:application/json" \
       -d '{
         "environment": "'"$ENV_NAME"'",
       }' \
       "https://apigee.googleapis.com/v1/organizations/$ORG_NAME/envgroups/$ENV_GROUP/attachments"
        
  5. Verifique se o grupo de ambiente foi criado com sucesso usando o seguinte comando CURL:
    curl -H "Authorization: Bearer $TOKEN" \
      "https://apigee.googleapis.com/v1/organizations/$ORG_NAME/envgroups"

    Em uma solicitação de criação bem-sucedida, a API Environments Group responde com uma mensagem semelhante a esta:

          {
            "environmentGroups": [
              {
                "name": "your_envgroup_hybrid",
                "hostnames": [
                  "apigee.hybrid.com"
                ],
                "createdAt": "1677826235324",
                "lastModifiedAt": "1677826235324",
                "state": "ACTIVE"
              }
            ]
          }
        
  6. Busque os anexos mais recentes do grupo de ambiente recém-criado usando o seguinte comando CURL:
    curl -H "Authorization: Bearer $TOKEN" \
      "https://apigee.googleapis.com/v1/organizations/$ORG_NAME/envgroups/$ENV_GROUP/attachments"

    O anexo e a criação do grupo de ambiente foram bem-sucedidos se o resultado mostrar um valor de hash exclusivo, conforme mostrado no exemplo de resposta abaixo:

    
            {
              "environmentGroupAttachments": [
                {
                  "name": "c27046d1-b83e-4cba-xxxx-caaa660b2bd6",
                  "environment": "your_envtest_hybrid",
                  "createdAt": "1677826263567",
                  "environmentGroupId": "your_envgroup_hybrid"
                }
              ]
            }
            

Próxima etapa

Para continuar a instalação, vá para a Parte 2: configuração do ambiente de execução híbrido.