Trabalhar com grupos de ambientes

Esta página aplica-se ao Apigee e ao Apigee Hybrid.

Veja a documentação do Apigee Edge.

Esta secção descreve como criar e editar grupos de ambientes, o que inclui adicionar ou remover ambientes ou nomes de anfitriões a um grupo com o Apigee. Para mais informações sobre o que é um grupo de ambientes e como funciona, consulte os artigos Ambientes e vista geral do grupo de ambientes.

Criar grupos de ambientes

Pode criar novos grupos de ambientes através da IU do Apigee ou da API Apigee. Esta secção descreve como fazer ambas as ações.

Quando cria um grupo de ambientes pela primeira vez, este não contém ambientes. No entanto, define um nome de anfitrião predefinido: example.group-name. Para adicionar ambientes a um grupo de ambientes, consulte o artigo Adicionar ambientes a um grupo de ambientes.

Apigee na Cloud Console

Para criar um novo grupo de ambientes no Apigee na Cloud Console:

  1. Na Google Cloud consola, aceda à página Gestão > Ambientes.

    Aceder a Ambientes

  2. No painel Ambientes, selecione Grupos de ambientes.
  3. Clique em + Criar grupo de ambientes.
  4. Introduza os seguintes dados:
    • Nome do grupo de ambientes: um nome para o grupo de ambientes. O nome tem de começar e terminar com um caráter alfanumérico. Pode ter até 63 carateres alfanuméricos e hífenes. O nome tem de ser diferente de qualquer nome de grupo de ambientes existente na sua organização.
    • Nomes de anfitriões: uma lista de nomes de anfitriões que podem ser usados para chamar proxies. Cada nome do anfitrião tem de estar numa linha separada.

      Também tem a opção de clicar em Configurar o balanceador de carga da Google com estes domínios. Esta ação abre a página Equilíbrio de carga na Cloud Console, onde pode configurar o equilíbrio de carga para os nomes de anfitrião.

    • Environments: uma lista opcional de ambientes a incluir no grupo de ambientes.
  5. Clique em Criar.

Apigee clássico

Para criar um novo grupo de ambientes na IU do Apigee clássico:

  1. Na IU do Apigee, selecione Administração > Ambientes > Grupos.
  2. Clique em + Grupo de ambientes:

    Botão Adicionar ambiente

    É apresentada a caixa de diálogo Adicionar um grupo de ambientes.

  3. Introduza um nome para o novo grupo de ambientes:

    Adicione um grupo de ambientes

    O nome só pode conter letras minúsculas, números e hífenes. Além disso, tem de começar com uma letra, ter, pelo menos, dois carateres e não pode terminar com um hífen. Os nomes válidos incluem my-env-group e prod2.

  4. Clique em Adicionar.

    O Apigee cria um novo grupo de ambientes. Normalmente, esta é uma operação muito rápida.

    Numa operação bem-sucedida, o Apigee confirma que o grupo foi criado com uma faixa que tem o seguinte aspeto:

    Banner de confirmação do grupo

    O Apigee também atribui um nome de anfitrião predefinido ao novo grupo.

  5. (Opcional) Atribua nomes de anfitrião adicionais ao novo grupo clicando em para esse grupo.

    O Apigee apresenta o painel Detalhes do grupo de ambientes:

    Detalhes do grupo de ambientes

  6. Adicione nomes de anfitriões ao campo Nomes de anfitriões. Cada nome do anfitrião tem de estar numa linha separada.
  7. Clique em Guardar quando terminar.

    Pode adicionar e remover nomes de anfitriões desta lista em qualquer altura através do mesmo procedimento.

API Apigee

Para criar um novo grupo de ambientes através da API Apigee, envie um pedido POST para a API Create environment groups. Antes de chamar a API, certifique-se de que tem um token válido, conforme descrito em Obter uma chave de acesso OAuth 2.0.

O comando curl de exemplo seguinte mostra a sintaxe para criar um novo grupo:

curl -i $TOKEN -X POST \
  https://apigee.googleapis.com/v1/organizations/ORG_NAME/envgroups?name=new-group-name

Quando especificar o nome do novo grupo, tem de usar apenas letras minúsculas, números e hífenes (a-z, A-Z e -). Não pode usar letras maiúsculas nem carateres especiais que não sejam hífenes. Também tem de começar o nome com uma letra minúscula.

Se não especificar parâmetros adicionais, este comando cria um novo grupo sem nomes de anfitriões atribuídos.

Também pode atribuir nomes de anfitriões quando cria o grupo, especificando-os como uma matriz no corpo do pedido.

O exemplo seguinte cria um novo grupo my-group e atribui três novos nomes de anfitriões ao novo grupo:

curl -i $TOKEN -X POST \
  https://apigee.googleapis.com/v1/organizations/org_name/envgroups?name=my-group \
  -d '{ \
    "hostnames": ["server1.mycompany.com", "server2.mycompany.com", "10.1.142.8"] \
  }'

Pode alterar posteriormente os nomes dos anfitriões na lista enviando um pedido PATCH para a API Patch environment groups.

Adicionar ambientes a um grupo de ambientes

Não é possível aceder a ambientes que não estejam num grupo porque não têm um nome de anfitrião associado. Os nomes de anfitriões são definidos no grupo de ambientes e não no ambiente. Quando cria um ambiente usando a IU do Apigee na Google Cloud consola, tem a opção de atribuir o ambiente a um grupo de ambientes existente. Para mais informações, consulte a secção Criar um novo ambiente na IU.

Se não atribuiu o seu ambiente a um grupo durante a criação do ambiente, esta secção descreve como adicionar um ambiente não atribuído a um grupo de ambientes através da IU do Apigee ou da API Apigee.

Apigee na Cloud Console

Para adicionar um ambiente a um grupo de ambientes na consola do Apigee no Google Cloud:

  1. Crie o ambiente, conforme descrito em Criar ambientes.
  2. Na Google Cloud consola, aceda à página Gestão > Ambientes.

    Aceder a Ambientes

  3. No painel Ambientes, selecione Grupos de ambientes.
  4. Na linha do grupo de ambientes, clique em Ações, e selecione Editar.
  5. No painel Editar grupo de ambientes, em Ambientes (opcional), selecione o ambiente que quer adicionar ao grupo de ambientes.
  6. Clique em Atualizar.

Apigee clássico

Para adicionar um ambiente a um grupo de ambientes na IU do Apigee clássico:

  1. Crie o ambiente, conforme descrito em Criar ambientes.
  2. Na IU do Apigee, selecione Administração > Ambientes > Grupos.
  3. Procure em Não atribuído para ver uma lista de ambientes que não fazem parte de um grupo de ambientes:

    Veja ambientes não atribuídos

    Tenha em atenção os ambientes não atribuídos que quer atribuir.
  4. Clique em junto ao grupo de ambientes ao qual quer adicionar ambientes.

    O painel Detalhes do grupo de ambientes apresenta:

    Painel de detalhes do grupo

  5. Para adicionar um novo ambiente a este grupo, clique em + na lista Ambientes.

    O painel Adicionar ambiente é apresentado:

    Caixa de diálogo Adicionar ambiente ao grupo

  6. Selecione o ambiente que quer adicionar ao grupo e clique em Adicionar.

    O Apigee adiciona o ambiente ao grupo.

API Apigee

Para adicionar um novo ambiente a um grupo de ambientes através da API Apigee, envie um pedido POST para a API Environment group attachment, como mostra o exemplo seguinte:

curl -H "Authorization: Bearer $TOKEN" -X POST
  "https://apigee.googleapis.com/v1/organizations/my-org/envgroups/test-group/attachments"
  -d '{
    "name": "my-attachment",
    "environment": "test"
  }'

Onde:

  • $TOKEN está definido como a sua chave de acesso OAuth 2.0, conforme descrito em Obter uma chave de acesso OAuth 2.0.
  • O corpo do pedido contém o nome do anexo, bem como o nome do novo ambiente.

O corpo do pedido contém uma instância de um recurso EnvironmentGroupAttachment, que é um simples wrapper em torno de um único ambiente.

Se for bem-sucedido, a resposta contém detalhes sobre o novo anexo, incluindo a data/hora em que foi criado. Por exemplo:

{
  "name": "my-attachment",
  "environment": "test"
  "createdAt": "42"
}

Remover um ambiente de um grupo de ambientes

Pode remover um ambiente de um grupo de ambientes com a IU do Apigee ou a API Apigee.

Apigee na Cloud Console

Para remover um ambiente de um grupo de ambientes na consola do Apigee in Cloud:

  1. Na Google Cloud consola, aceda à página Gestão > Ambientes.

    Aceder a Ambientes

  2. No painel Ambientes, selecione Grupos de ambientes.
  3. Na linha do grupo de ambientes, clique em Ações, e selecione Editar.
  4. No painel Editar grupo de ambientes, em Ambientes (opcional), desmarque o ambiente que quer remover do grupo de ambientes.
  5. Clique em Atualizar.

Apigee clássico

Para remover um ambiente de um grupo de ambientes na IU do Apigee clássico:

  1. Na IU do Apigee, selecione Administração > Ambientes > Vista geral.
  2. Selecione o ambiente que quer remover.
  3. No painel Grupos, mova o cursor para o final da linha do grupo do qual quer remover o ambiente e clique em Ícone de lixo.

API Apigee

Para remover um ambiente de um grupo de ambientes através da API Apigee, use o método delete no recurso EnvironmentGroupAttachment para eliminar a associação correspondente ao ambiente.

Eliminar um grupo de ambientes

Pode eliminar um grupo de ambientes através da IU do Apigee ou da API.

Apigee na Cloud Console

Para eliminar um grupo de ambientes no Apigee na Cloud Console:

  1. Na Google Cloud consola, aceda à página Gestão > Ambientes.

    Aceder a Ambientes

  2. No painel Ambientes, selecione Grupos de ambientes.
  3. Na linha do grupo de ambientes, clique em Ações, e selecione Editar.

Apigee clássico

Para eliminar um grupo de ambientes na IU do Apigee clássico:

  1. Na IU do Apigee, selecione Administração > Ambientes > Grupos.
  2. Mova o cursor para o painel do grupo que quer eliminar.
  3. Clique no ícone Ícone de lixo.

API Apigee

Para eliminar um grupo de ambientes através da API Apigee, use o método delete no recurso EnvironmentGroup.

Adicionar nomes de anfitriões a um grupo

Quando cria um grupo, o Apigee adiciona o nome do anfitrião predefinido example.GROUP_NAME. Pode adicionar os nomes dos anfitriões ao grupo através das instruções nesta secção.

Os nomes de anfitrião que define num grupo de ambientes:

  • Tem de ser único em todos os grupos de ambientes numa organização; não pode ser usado por mais do que um grupo
  • Não suportam carateres universais
  • Os caminhos base têm de ser exclusivos num anfitrião (nenhum proxy pode ter o mesmo caminho base num anfitrião)

Apigee na Cloud Console

Para adicionar um nome de anfitrião a um grupo de ambientes na Apigee na Cloud Console:

  1. Na Google Cloud consola, aceda à página Gestão > Ambientes.

    Aceder a Ambientes

  2. No painel Ambientes, selecione Grupos de ambientes.
  3. Na linha do grupo de ambientes, clique em Ações, e selecione Editar.
  4. No painel Editar grupo de ambientes, em Nomes de anfitriões, introduza o nome de anfitrião que quer adicionar ao grupo de ambientes.
  5. Clique em Atualizar.

Apigee clássico

Para adicionar um nome de anfitrião a um grupo de ambientes na IU do Apigee clássico:

  1. Na IU do Apigee, selecione Administração > Ambientes > Grupos.
  2. Passe o cursor do rato sobre o cartão do grupo e selecione .

    O painel Detalhes do grupo de ambientes apresenta:

    Painel de detalhes do grupo

  3. No campo Nomes de anfitriões, introduza os novos anfitriões.
  4. Clique em Guardar para adicionar os novos anfitriões ao grupo.

API Apigee

Para adicionar nomes de anfitriões a um grupo de ambientes através da API Apigee, envie um pedido PATCH para a API Patch environment groups. Certifique-se de que define o parâmetro updateMask como hostnames e especifica a lista completa de nomes de anfitriões que quer: o valor desse campo no seu pedido substitui a lista existente.

O exemplo seguinte define os nomes de anfitrião para o ambiente de teste:

curl -H "Authorization: Bearer $TOKEN" -X PATCH
  "https://apigee.googleapis.com/v1/organizations/my-org/envgroups/test-group?updateMask=hostnames"
  -d '{
    "name": "my-hostnames",
    "hostnames": [
      "test-1.example.com",
      "test-2.example.com",
      "test-3.example.com"
    ]
  }'

Onde:

  • $TOKEN está definido como a sua chave de acesso OAuth 2.0, conforme descrito em Obter uma chave de acesso OAuth 2.0.
  • A carga útil do pedido especifica um nome para a matriz de anexos de nomes de anfitriões, além da matriz de nomes propriamente dita.

Se o pedido for bem-sucedido, a resposta contém um recurso Operation.

Determinar se o Cloud Load Balancer está configurado para um nome de anfitrião

Pode chamar um proxy com o seguinte comando:

curl -v https://YOUR_ENV_GROUP_HOSTNAME/myproxy

onde YOUR_ENV_GROUP_HOSTNAME é o nome do anfitrião de um grupo de ambientes que contém o ambiente no qual o proxy está implementado. Para o fazer, o Cloud Load Balancer tem de ser configurado para o nome do anfitrião do grupo de ambientes. Normalmente, o balanceador de carga é configurado quando o Apigee é aprovisionado pela primeira vez. Para determinar se o equilibrador de carga está configurado para o nome de anfitrião:

  1. Na Google Cloud consola, aceda à página Apigee Management > Environments > Environment Groups.

    Aceda a Grupos de ambientes

  2. Clique em Mais, Editar junto a um grupo de ambientes.
  3. Clique em Configurar o Google Load Balancer com estes domínios É aberta a página de balanceamento de carga da Google Cloud Platform.
  4. Página de balanceamento de carga na Google Cloud Platform

  5. Clique no nome do equilibrador de carga na coluna Nome. Se o Apigee tiver sido aprovisionado com o Assistente de aprovisionamento, o nome do equilibrador de carga é apigee-proxy-url-map. Se não vir esse nome, contacte o administrador do sistema na sua organização que aprovisionou o Apigee.

    Quando clica no nome, é apresentada a página Detalhes do balanceador de carga:

    Página de detalhes do equilibrador de carga na Google Cloud Platform

  6. Na tabela Frontend, clique num certificado SSL na coluna Certificado e procure um certificado SSL que corresponda ao nome do anfitrião:
    • Se o Tipo de certificado for GERIDO, verifique se o campo Nomes de anfitriões DNS do certificado corresponde ao nome do anfitrião.
    • Se o certificado não for gerido, pode ter de transferir o certificado e verificar se o respetivo nome comum corresponde ao nome de anfitrião.

Se não encontrar o nome do anfitrião em nenhum certificado, contacte o administrador de sistemas para receber assistência adicional.