Como personalizar seu domínio

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

Confira a documentação da Apigee Edge.

Por padrão, quando cria um portal do desenvolvedor, você recebe um exemplo de nome de domínio do Apigee no seguinte formato para acessar seu portal ativo:

https://orgname-portalname.apigee.io

Em que orgname é o nome da organização e portalname é definido usando o nome do portal convertido para letras minúsculas, com espaços e traços removidos.

Antes de lançar um portal do desenvolvedor, é recomendável fornecer seu próprio nome de domínio personalizado. Por exemplo, uma alternativa popular é:

https://developers.example.com

Para considerações sobre como usar um domínio personalizado com um provedor de identidade SAML, consulte Como usar um domínio personalizado com o provedor SAML.

Etapas para personalizar seu domínio

Para personalizar seu nome de domínio, execute as seguintes etapas:

  1. Registrar o nome do domínio
  2. Crie um certificado TLS para seu domínio personalizado. Você precisará do certificado ao criar o balanceador de carga.
  3. Determine o nome de host padrão do seu portal.
  4. Crie um grupo de endpoints de rede (NEG, na sigla em inglês) de Internet para definir o endpoint de back-end como seu portal integrado para o balanceador de carga.
  5. Crie um balanceador de carga que aponte para o NEG da Internet e reserve o IP para suas solicitações de clientes recebidas.
  6. Ativar o domínio personalizado no seu portal
  7. Atualize seu DNS para criar um novo registro para o host de domínio personalizado.

Etapa 1: registrar seu nome de domínio

Caso você precise registrar um novo domínio, há muitos sites populares de registro de domínio disponíveis, como o Google Domains. Você escolhe qual site de registro de domínio quer usar.

Ao decidir o nome de domínio, considere que URLs legíveis e fáceis de usar são um componente essencial para melhorar a otimização de mecanismos de pesquisa, conforme descrito em Implementar otimização de mecanismos de pesquisa (SEO, na sigla em inglês).

Etapa 2: criar um certificado TLS para seu domínio personalizado

Crie um certificado TLS para seu domínio personalizado usando a ferramenta de sua preferência, como Let's Encrypt. Veja mais informações em:

Etapa 3: determinar o nome do host padrão do seu portal

Para determinar o nome de host padrão do seu portal:

  1. Na IU da Apigee, selecione Publicar > Portals na barra de navegação lateral. A lista de portais é exibida.

  2. Copie o conteúdo no campo Local do portal em que você quer criar um domínio personalizado. Item do portal com o campo de local destacado

    Ele será necessário na próxima etapa.

Etapa 4: criar um NEG da Internet

Nesta etapa, você cria um grupo de endpoints de rede (NEG, na sigla em inglês) de Internet para definir o endpoint de back-end para seu portal integrado para o balanceador de carga. Para mais informações, consulte Visão geral dos grupos de endpoints de rede de Internet.

  1. No console do Google Cloud, acesse a página Painel e selecione ou crie um projeto do Google Cloud.

    Ir para a página "Painel"

  2. Selecione Compute Engine > Grupos de endpoints de rede no navegador.

  3. Clique em Criar grupo de endpoints de rede.

  4. Configure os seguintes campos:

    Campo Valor
    Nome Digite um nome para a NEG na Internet.
    Tipo de grupo de endpoints de rede Selecione Grupo de endpoints de rede (Internet).
    Novo endpoint de rede

  5. Você pode deixar os campos restantes definidos com os valores padrão.

  6. Clique em Criar.

A NEG na Internet foi criada.

Etapa 5: criar um balanceador de carga

Crie um balanceador de carga que aponte para o NEG da Internet e reserve o IP para suas solicitações de clientes recebidas.

Iniciar a configuração

  1. No console do Google Cloud, acesse a página Balanceamento de carga.

    Acessar o "Balanceamento de carga"

  2. Clique em Criar balanceador de carga.
  3. Em Tipo de balanceador de carga, selecione Balanceador de carga de aplicativo (HTTP/HTTPS) e clique em Próxima.
  4. Em Voltado ao público ou interno, selecione Voltado ao público (externo) e clique em Próxima.
  5. Em Implantação global ou de região única, selecione Melhor para cargas de trabalho globais e clique em Próxima.
  6. Em Geração do balanceador de carga, selecione Balanceador de carga de aplicativo externo global e clique em Próxima.
  7. Clique em Configurar.

Configurar o balanceador de carga

  1. Clique em cada categoria e configure o balanceador de carga conforme descrito na tabela a seguir.

    Categoria Passos
    Configuração de front-end

    Reserve o endereço IP para as solicitações do cliente recebidas e faça upload do certificado TLS criado na Etapa 2: criar um certificado TLS:

    1. Na seção Criar balanceador de carga de aplicativo externo global, posicione o cursor sobre Configuração de front-end e clique na seta.
    2. Digite um nome para o front-end no campo Nome.
    3. Selecione HTTPS no menu suspenso Protocolo.
    4. No menu suspenso Endereço IP, selecione Criar endereço IP
      A caixa de diálogo "Reservar um novo endereço IP estático" é exibida.
    5. Insira um nome para o endereço IP estático no campo Nome.
    6. Opcionalmente, insira uma Descrição.
    7. Clique em Reservar.
    8. Armazene o endereço IP que foi reservado para uso ao configurar o registro DNS.
    9. Selecione Criar um novo certificado na lista suspensa Certificado.
      Os slides "Criar um novo certificado" serão abertos.
    10. Digite um nome para o novo certificado no campo Nome.
    11. Selecione Fazer o upload do certificado em Criar modo.
    12. Faça upload dos detalhes do certificado TLS, incluindo a chave pública, a cadeia de certificados e a chave privada.
    13. Clique em Criar.
    14. Clique em Concluído para criar o novo IP e nova porta de front-end.
    Configuração de back-end

    Defina a configuração do back-end para direcionar o tráfego de entrada para o NEG da Internet criado na Etapa 4: criar um grupo de endpoints de rede (NEG) de Internet:

    1. Na seção Criar balanceador de carga de aplicativo externo global, posicione o cursor sobre Configuração de back-end e clique na seta.
    2. Na seção Serviços e buckets de back-end, selecione Serviços de back-end > Criar um serviço de back-end na lista suspensa.
      Os slides da janela "Criar serviço de back-end" serão abertos.
    3. Digite um nome no campo Nome.
    4. Selecione Grupo de endpoints da rede na Internet na lista suspensa Tipo de back-end.
    5. Selecione HTTPS como protocolo.
    6. NoNovo back-end selecione o NEG da Internet criado noEtapa 4: criar um grupo de endpoints de rede (NEG) da Internet noGrupo de endpoints de rede na Internet menu suspenso e clique emConcluído para criar um anexo da VLAN de monitoramento.
    7. Desmarque a caixa de seleção para Ativar o Cloud CDN.
    8. É possível deixar todos os outros valores definidos como padrão.
    9. Clique em Criar.
      10. .
    Regras de host e caminho

    Configure as regras de host e de caminho para determinar como o tráfego será direcionado:

    1. Na seção Criar balanceador de carga externo do aplicativo global, posicione o cursor sobre Regras de host e caminho e clique na seta.
    2. Clique em Regra avançada de host e caminho (redirecionar URL, reescrever URL) em Modo.
    3. Na seção Nova regra de host e caminho, faça o seguinte:
      1. Selecione Rotear tráfego para um único back-end no menu suspenso Ação.
      2. Expanda a Ação de complemento (Regravação de URL).
      3. Digite o nome de domínio padrão que você copiou na Etapa 3: determine o nome do host padrão do seu portal no campo Reescrever o host.
      4. Selecione o serviço de back-end configurado na lista suspensa Back-end.
      5. Clique em Concluído.

  2. Clique em Criar na página Criar balanceador de carga de aplicativo externo global.

Etapa 6: configurar o domínio personalizado no seu portal

Para ativar o domínio personalizado no seu portal:

  1. Na IU da Apigee, selecione Publicar > Portals na barra de navegação lateral.
    A lista de portais é exibida.
  2. Selecione o portal na lista.
  3. Selecione Configurações na página de destino ou na lista suspensa na barra de navegação superior.
  4. Clique na guia Domains.
  5. Digite seu nome de domínio personalizado no campo Domínio.
  6. Clique em Enable.

Verifique se, ao acessar o domínio personalizado em um navegador, você é direcionado ao portal integrado.

Consulte também Como editar um domínio personalizado e Como desativar um domínio personalizado.

Etapa 7: atualizar o DNS

No seu sistema DNS, crie um novo registro para o host de domínio personalizado.

Para criar uma zona do Cloud DNS, siga as etapas descritas em Como gerenciar zonas. Configure os seguintes campos conforme descrito abaixo:

Campo Descrição
Tipo de zona Selecione Público.
Nome da zona Digite um nome significativo para a zona. Por exemplo: mycompany-zone
Nome do DNS Digite o sufixo da zona usando um nome de domínio seu. Por exemplo: mycompany.com

Depois de criar uma zona, na página "Detalhes da zona", clique em Adicionar conjunto de registros e siga as etapas descritas em Como gerenciar registros. Configure os seguintes campos conforme descrito abaixo:

Campo Descrição
Nome do DNS Especifique o prefixo do nome do DNS. O sufixo definido para a zona do Cloud DNS também é exibido, mas não é editável. Por exemplo: developers.mycompany.com
"Tipo de registro de recurso" Selecione A (o padrão).
TTL Defina como o valor desejado ou deixe como 5 (padrão).
Unidade da TTL Defina o valor desejado ou deixe como minutos (padrão).
Endereço IPv4 Digite o endereço IP externo que você reservou ao criar o balanceador de carga.

Como editar um domínio personalizado no seu portal

Para editar um domínio personalizado no seu portal:

  1. Na IU da Apigee, selecione Publicar > Portals na barra de navegação lateral.
    A lista de portais é exibida.
  2. Selecione o portal na lista.
  3. Selecione Configurações no menu suspenso na barra de navegação superior ou na página de destino.
  4. Clique na guia Domínios.
  5. Edite as informações do domínio personalizado.
  6. Clique em Save.

Como desativar um domínio personalizado no seu portal

Para desativar um nome de domínio personalizado no seu portal:

  1. Na IU da Apigee, selecione Publicar > Portals na barra de navegação lateral. A lista de portais é exibida.
  2. Selecione o portal na lista.
  3. Selecione Configurações no menu suspenso na barra de navegação superior ou na página de destino.
  4. Clique na guia Domínios.
  5. Clique em Desativar.
  6. Clique em Desativar no prompt para confirmar a operação.

O domínio personalizado está desativado e os campos são apagados.