Como gerenciar instâncias

Esta página se aplica à Apigee, mas não à Apigee híbrida.

Confira a documentação da Apigee Edge.

Uma instância é uma máquina virtual em que o projeto da API e os serviços relacionados são armazenados. As instâncias correspondem a regiões. Normalmente, você começa com uma única instância e adiciona novas instâncias à medida que sua organização se expande em mais regiões. Esta seção explica como:

Criar uma nova instância

Para criar uma nova instância, use a API Instances ou a IU da Apigee. Cada instância requer o seguinte:

  • a própria chave de criptografia de disco para a rede. O Google recomenda que você também crie um keyring separado para a nova instância. Para mais informações, consulte Sobre as chaves de criptografia da Apigee.
  • seus próprios intervalos CIDR /22 e /28 não sobrepostos para peering de rede. Os intervalos não podem ser compartilhados entre instâncias.

Apigee no console do Cloud

Para criar uma nova instância na Apigee no console do Cloud:

  1. Abra a interface da Apigee no console do Cloud no navegador.
  2. Selecione Gerenciamento > Instâncias. O painel Instâncias exibe uma lista das instâncias.

  3. Clique em Criar. Pode haver um atraso enquanto a IU determina se a organização tem os direitos necessários para criar uma nova instância.

    A página Criar nova instância é exibida.

  4. Insira detalhes sobre a nova instância nos campos:
    Campo Obrigatório Descrição
    Runtime hosting location Obrigatório Selecione a região em que você quer criar a nova instância. Não é possível criar uma nova instância em uma região que já tenha uma. Para mais informações sobre como trabalhar com várias regiões, consulte Como usar várias regiões.
    Name Obrigatório

    Insira o código da nova instância.

    O valor padrão é o nome da região de hospedagem do ambiente de execução que você selecionou, mas é possível alterá-lo para qualquer nome significativo que quiser, desde que você siga as regras de nomenclatura:

    • Comprimento mínimo de 2.
    • Tamanho máximo de 32.
    • Use apenas letras minúsculas, números e hífens (seguindo o padrão /^[a-z0-9\-]+$/).
    • precisa começar com uma letra, não tenha dígitos iniciais ou hífens.
    • Precisa terminar com um número ou letra, não tem hifens no final.
    • Precisa ser único em toda a organização.
    IP range allocation Obrigatório

    Especifique como você quer alocar um intervalo de IP. Escolha entre estas opções:

    • Automático (recomendado): a Apigee seleciona um intervalo CIDR disponível com um tamanho de prefixo de /22. Não é necessária nenhuma ação da sua parte.
    • Personalizado: em casos de uso avançados, talvez seja necessário especificar exatamente qual intervalo de IP você quer que a Apigee use. Para esses casos, você especifica um intervalo de IP personalizado e precisa ter o tamanho de /22. O intervalo precisa estar disponível como parte de uma conexão particular entre seu projeto e a Apigee.
    Disk encryption key Obrigatório

    Em Chave de criptografia de disco, escolha uma chave de criptografia gerenciada pelo cliente. Se uma chave já existir, você poderá selecioná-la. O assistente lista todas as chaves no mesmo local que a região de hospedagem do ambiente de execução em todos os keyrings. Se não existir uma chave ou se você não quiser usar uma atual, crie uma nova chave a partir do assistente. Para criar uma chave:

    1. Clique em Criar chave.
    2. Selecione um conjunto de chaves ou, se não existir, ative Criar conjunto de chaves e insira um nome e escolha um local para ele. Os nomes de keyrings podem conter letras, números, sublinhados (_) e hífens (-). Os keyrings não podem ser renomeados ou excluídos.
    3. Clique em Continuar.
    4. Criar uma chave. Digite um nome e um nível de proteção. Os nomes das chaves podem conter letras, números, sublinhados (_) e hífens (-). As chaves não podem ser renomeadas ou excluídas. Para o nível de proteção, Software é uma boa escolha. Esse é o mesmo padrão usado pelo Cloud KMS. No entanto, é possível alterá-lo se quiser.
    5. Clique em Continuar e revise suas seleções.
    6. Clique em Criar.
    7. Clique em Conceder para conceder à conta de serviço permissão para criptografar/descriptografar com a chave selecionada.
    Environments Opcional

    Selecione os ambientes que você quer anexar a esta instância Para fazer isso, clique na lista suspensa Ambientes e marque as caixas de seleção ao lado dos ambientes que você quer anexar. É possível fazer isso em quantos ambientes você quiser. Em seguida, clique em OK.

    Os ambientes de todas as instâncias contam para o número total de ambientes que você pode alocar. Saiba mais em Sobre ambientes e grupos de ambientes:

    A adição de ambientes ao criar uma nova instância é opcional. Se você não os adicionar agora, pode usar a API Instances attachment create ou a IU para adicioná-los e removê-los depois. Consulte Anexar ou remover um ambiente.

    Accepted projects Opcional Clique em Adicionar projeto aceito para selecionar um ou mais projetos do Cloud. Os projetos selecionados podem se conectar de maneira privada ao anexo do serviço da instância. Por padrão, o projeto associado à organização da Apigee é incluído nessa lista.
    Enable logging Opcional Clique no botão Ativar geração de registros para ativar os registros de acesso de entrada do Cloud Logging na instância. Esse recurso permite visualizar os registros gerados por gateways de entrada na sua infraestrutura da Apigee, como um balanceador de carga de aplicativo externo ou um gateway do Anthos, para ajudar na solução de problemas de chamadas de API da Apigee.

    Para mais informações, consulte Como gerar registros de acesso da Apigee.

    Filter Opcional Selecione um código de resposta HTTP na caixa código de resposta para atuar como um filtro dos registros de acesso de entrada.

    Se quiser incluir todos os registros, independentemente do código de resposta HTTP, selecione None (all HTTP responses).

    Para criar um filtro personalizado, selecione Custom e insira o filtro neste formato:

    status_code > XX && status code <= YY

    Exemplo:

    status_code >= 500 && status_code < 504

    Se sua organização não puder criar uma nova instância, entre em contato com a Apigee Sales.

  5. Clique em Criar.

    A Apigee inicia uma operação de longa duração que pode levar 20 minutos ou mais para ser concluída. Quando ela for concluída, a nova instância aparecerá na lista de instâncias da interface Instâncias.

API Apigee

Se a Apigee tiver sido provisionada sem peering de VPC, consulte Criar uma instância de ambiente de execução nas etapas de provisionamento sem peering de VPC.

Se a Apigee tiver sido provisionada com peering de VPC, consulte Criar uma instância de ambiente de execução nas etapas de provisionamento de peering de VPC.

Anexar ou remover ambientes de uma instância

Ao criar um ambiente usando a interface da Apigee no console do Google Cloud, você tem a opção de atribuí-lo a uma instância atual. Para mais informações, consulte Como criar um novo ambiente na interface.

Se você não tiver anexado o ambiente a uma instância durante a criação dele ou quiser remover um ambiente de uma instância, siga as etapas a seguir. Para mais informações sobre ambientes e instâncias, consulte Ambientes e instâncias.

Para anexar ou remover um ambiente de uma instância usando a Apigee no console do Cloud:

  1. Abra a interface da Apigee no console do Cloud no navegador.
  2. Selecione Gerenciamento > Instâncias.
  3. Clique na instância que você quer editar.

  4. Na página Detalhes da instância, clique em Editar.
  5. Na página Editar instância, clique no campo Ambientes (opcional) e selecione o ambiente que você quer anexar à instância ou desmarque o ambiente que você quer remover.
  6. Clique em OK.
  7. Clique em Salvar.

Além de usar a interface, também é possível anexar ambientes a uma instância usando a API Instances attachment create. Por exemplo, consulte Criar um ambiente na documentação de provisionamento de linha de comando.

Editar a lista de projetos aceitos

É possível adicionar ou remover projetos da lista de Projetos aceitos:

  1. Abra a interface da Apigee no console do Cloud no navegador.
  2. Selecione Gerenciamento > Instâncias.
  3. Clique na instância que você quer editar.

  4. Na página Detalhes da instância, clique em Editar.
  5. Na seção Projetos aceitos da página Editar instância, clique no ícone de exclusão ao lado de um projeto para removê-lo. Para adicionar um projeto, clique em Adicionar projeto aceito e digite o ID do projeto.
  6. Clique em Salvar.

Ativar ou desativar registros de acesso de entrada para uma instância

Depois de criar uma instância, você pode ativar e desativar os registros de acesso de entrada do Cloud Logging para a instância:

  1. Abra a interface da Apigee no console do Cloud no navegador.
  2. Selecione Gerenciamento > Instâncias.
  3. Clique na instância que você quer editar.

  4. Na página Detalhes da instância, clique em Editar.
  5. Na página Editar instância, clique no botão Ativar geração de registros para desativar o recurso.
  6. Clique em Salvar.

Excluir uma instância

Use a interface da Apigee no console do Cloud para excluir uma instância atual, conforme descrito nesta seção. Também é possível excluir uma instância usando a API Instances.

Apenas uma instância da Apigee pode estar em uma determinada região do Google Cloud. Quando você exclui uma instância, ela é completamente removida da região. Consulte também Instalação multirregional.

Aviso: quando você exclui uma instância, todos os dados associados a ela são perdidos. Ela não pode ser desfeita. No entanto, se você tiver várias instâncias, como em uma instalação multirregional, seus dados serão perdidos somente se você excluir todas as instâncias. Antes de excluir a última instância, extraia e faça backup dos dados que você não quer perder.

Os dados a seguir serão armazenados em uma instância da Apigee e serão excluídos se você excluir a instância:

Tipo de dados Descrição
Sistema de gerenciamento de chaves (KMS) Os dados do KMS incluem produtos, desenvolvedores, apps de desenvolvedor, tokens OAuth (incluindo tokens de acesso, tokens de atualização e códigos de autorização) e chaves de API. Use a política AccessEntity ou a API Apigee relacionada para recuperar os dados que você quer salvar.
Mapa de chave-valor (KVM) Todos os dados que podem ser criados ou gerenciados com políticas da KVM. Consulte Como recuperar KVMs.
Cota Definições de cotas, buckets e contadores.
Cache do ambiente Todos os dados em cache.

Para excluir uma instância da Apigee usando a interface da Apigee no console do Cloud:

  1. Abra a interface da Apigee no console do Cloud no navegador.
  2. Selecione Gerenciamento > Instâncias.

  3. Selecione a instância que você quer excluir.
  4. Na página Detalhes da instância, clique em Excluir.