Personalize um kickstart do portal para desenvolvedores da Apigee no Cloud Marketplace

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

Confira a documentação da Apigee Edge.

Nesta página, descrevemos opções para personalizar, manter e proteger sua solução do kickstart do portal para desenvolvedores da Apigee. Depois de implantados, todos os componentes de serviços do Cloud usados pelo portal geralmente podem ser personalizados de acordo com a documentação padrão do Google Cloud. As seções abaixo fornecem opções de configuração e diretrizes de produção específicas para a solução do portal.

Conectar-se à Apigee ou à Apigee híbrida

Para usar a solução do kickstart do portal do desenvolvedor da Apigee com uma organização híbrida da Apigee ou Apigee, o portal precisa ser implantado no projeto do Google Cloud usado durante o provisionamento dele. Durante a implantação, a conta de serviço é criada com o papel Apigee Developer Admin. Esse papel é obrigatório para autores de chamada de conta de serviço para APIs da Apigee.

Configurar HTTPS para o portal

Na configuração de lançamento da implantação do portal, é possível configurar o HTTPS em seu portal. As opções de configuração da caixa de seleção incluem:

Não marcada O script de implantação não ativará o TLS automaticamente. O TLS pode ser configurado manualmente após a implantação usando o Cloud Load Balancing. Essa é a opção padrão.
Selecionado O pacote de implantação ativará o TLS, provisionará um endereço IP, configurará um nome de domínio e solicitará um certificado SSL usando nip.io. O uso de nip.io não é endossado pelo Google, mas é oferecido como uma opção conveniente para testar implantações. Ao selecionar esta opção, você aceita os Termos e Condições do nip.io.

Usar o Cloud SQL com o CMEK

A instância do Cloud SQL para o portal é criada na região escolhida durante a configuração do lançamento. Por padrão, o Google criptografa dados em repouso usando chaves de criptografia gerenciadas pelo Google. Para usar uma chave de criptografia gerenciada pelo cliente (CMEK, na sigla em inglês) para criptografar os dados armazenados na instância do CloudSQL, siga as etapas descritas em Como usar chaves de criptografia gerenciadas pelo cliente.

Gerenciar o Cloud SQL

Para gerenciar a instância do Cloud SQL após a implantação:

Configurar e atualizar grupos de instâncias gerenciadas

Um grupo de instâncias gerenciadas (MIG) é uma coleção de instâncias de máquina virtual (VM) que pode ser gerenciada como uma única entidade. É possível tornar as cargas de trabalho escalonáveis e altamente disponíveis aproveitando serviços de MIGs automatizados, como escalonamento automático, recuperação automática, implantação regional (várias zonas) e atualização automática.

Para configurar os MIGs após a implantação:

Novas imagens de VM para as soluções do kickstart do portal do desenvolvedor da Apigee serão lançadas regularmente. Os clientes podem usar os passos detalhados em Como atualizar instâncias em um MIG para substituir ou reiniciar instâncias de um MIG para que usem a imagem mais recente.

Ativar o IP privado com VPC Service Controls

Para ativar um endereço IP privado para a instância do Cloud SQL:

Personalizar o código do portal

Se as personalizações forem feitas no código do portal ou nos scripts de inicialização após a implantação, essas alterações precisarão ser exportadas e armazenadas em backup no Filestore para evitar perdas durante as atualizações na imagem base do kickstart do portal do desenvolvedor da Apigee.

Por exemplo, se novos módulos do Drupal estiverem instalados em uma instância do Compute Engine, crie um backup usando as seguintes etapas:

  1. Execute /opt/apigee/scripts/export-code.sh para exportar as alterações.
  2. O script copia os arquivos exportados para a instância do Filestore ativada em /mnt/fileshare/portalname/.
  3. Reinicie as instâncias no grupo para acionar a coleta das alterações em todo o grupo. O script de inicialização detecta automaticamente se um backup de código existe, carrega as alterações, corrige as permissões do arquivo e aplica o arquivo settings.php.
  4. Atualizar o núcleo e os módulos do Drupal usando composer update. As atualizações da Apigee para a imagem base fornecem apenas atualizações do SO, patches de PHP e atualizações do NGINX. Todas as atualizações do núcleo e do Drupal são gerenciadas pelo cliente e precisam ser aplicadas manualmente.

Para adicionar personalizações ao script de inicialização, crie um script em /mnt/fileshare/$PORTAL_NAME/custom-startup-script.sh.

Se estiver instalando pacotes PHP, execute o comando service supervisor restart para aplicar as alterações.

Criar backups

A criação de backups regulares é recomendada como uma prática recomendada para sua solução do kickstart do portal do desenvolvedor da Apigee. Veja as etapas detalhadas em:

Configurar um portal para uso em produção

Para configurar seu portal para uso em produção, siga estas etapas:

Banco de dados do Cloud SQL
  • Verifique ou altere o tipo de máquina do banco de dados
  • Desative o IP público do banco de dados e configure o IP privado.
  • Ative backups automáticos do banco de dados
  • Ative alta disponibilidade para o banco de dados
Filestore
  • Ativar backups para o Filestore
Cloud Load Balancing
  • Ativar o Cloud CDN para armazenar conteúdo estático em cache
  • Adicionar um certificado SSL personalizado, se preferir
Grupo gerenciado de instâncias
  • Ajuste o número mínimo e máximo de instâncias para o tráfego de produção
Authentication
  • Remova a restrição de acesso HTTP Basic Auth de seu site.

    Execute os seguintes comandos para tornar o site do portal acessível ao público:

    gcloud beta runtime-config configs variables set site_basic_auth/enabled 0 \
  --is-text --config-name=PORTAL_NAME --project=GCP_PROJECT_NAME
     
    gcloud beta compute instance-groups managed rolling-action \
  replace INSTANCE_GROUP_ID --region=GCP_REGION \
  --replacement-method=substitute --project=GCP_PROJECT_NAME

A seguir

  • Saiba mais sobre os recursos de suporte para a solução kickstart do portal do desenvolvedor da Apigee.