Configurar um nome DNS personalizado para uma instância do Cloud SQL

Nesta página, descrevemos como configurar um nome de sistema de nomes de domínio (DNS) personalizado para sua instância do Cloud SQL.

Visão geral

É possível configurar uma instância do Cloud SQL para que seus aplicativos se conectem usando um nome DNS personalizado gerenciado pela sua organização. Se você quiser usar um nome DNS personalizado para se conectar a uma instância do Cloud SQL em vez de um endereço IP, configure um nome alternativo do assunto (SAN) personalizado. É possível configurar uma SAN personalizada ao criar ou atualizar uma instância.

Quando você adiciona um nome DNS personalizado como uma configuração SAN personalizada à sua instância, o Cloud SQL insere o nome DNS personalizado no campo SAN do certificado do servidor da instância. Essa personalização permite usar o nome DNS personalizado com validação de nome de host de forma segura. É possível adicionar uma lista separada por vírgulas de até três nomes de DNS personalizados à configuração de SAN personalizada. Por motivos de segurança, use uma configuração SAN personalizada somente para instâncias que você configurar com CUSTOMER_MANAGED_CAS_CA como o modo de CA do servidor.

Depois de configurar o nome DNS personalizado para sua instância, é possível usá-lo para conectar seus clientes ou aplicativos de banco de dados, incluindo os conectores de linguagem do Cloud SQL e o proxy de autenticação do Cloud SQL.

Fluxo de trabalho

Para configurar um nome DNS personalizado para uma instância, faça o seguinte:

  1. Crie uma instância configurada com uma CA gerenciada pelo cliente.
  2. Adicione valores SAN personalizados à instância. Os valores de SAN personalizados são inseridos no campo SAN do certificado do servidor da instância.
  3. Determine o endereço IP da instância.
  4. Crie registros DNS personalizados para sua instância.
  5. Conecte-se à instância usando o nome DNS personalizado.

Antes de começar

Antes de configurar um nome DNS personalizado para sua instância, verifique se você tem as funções e permissões necessárias.

Se você estiver criando uma instância do Cloud SQL, para usar SANs personalizadas, ela também precisará usar uma autoridade de certificação (CA) gerenciada pelo cliente no modo de CA do servidor.

Criar uma instância com valores SAN personalizados

Para criar uma instância com valores SAN personalizados, use o seguinte comando gcloud sql instances create:

gcloud

gcloud sql instances create "INSTANCE_NAME" \
  --database-version=DATABASE_VERSION \
  --project=PROJECT_ID \
  --region=REGION \
  --server-ca-mode=CUSTOMER_MANAGED_CAS_CA \
  --server-ca-pool=projects/PROJECT_ID_CAS/locations/REGION/caPools/CA_POOL_ID
  --custom-subject-alternative-names=CUSTOM_DNS_NAME

Faça as seguintes substituições:

  • INSTANCE_NAME com o nome da instância do Cloud SQL que você quer criar.
  • DATABASE_VERSION com o enum da versão da instância do Cloud SQL que você quer criar. A opção de CA gerenciada pelo cliente é compatível apenas com o MySQL 8.0.30 e versões mais recentes.
  • PROJECT_ID com o ID do projeto em que você planeja criar as instâncias do Cloud SQL.
  • PROJECT_ID_CAS com o ID do projeto em que você criou seu CA_POOL_ID. Esse projeto pode ser igual ou diferente de onde você quer criar a instância do Cloud SQL.
  • REGION com a região em que você criou o pool de CA. É preciso criar a instância na mesma região do pool de CAs.
  • CA_POOL_ID com o ID do pool de CA que você criou.
  • CUSTOM_DNS_NAME com até três nomes de DNS personalizados, separados por vírgulas sem espaços entre os valores. Por exemplo, develop.example.com,test.example.com,production.example.com.

Adicionar ou atualizar valores de SAN personalizados para uma instância

Para adicionar ou atualizar valores de SAN personalizados em uma instância atual, faça o seguinte:

gcloud

gcloud sql instances patch INSTANCE_NAME \
  --custom-subject-alternative-names=CUSTOM_DNS_NAME
Atenção: se você estiver atualizando uma instância que já tem valores SAN personalizados, especifique os valores SAN personalizados atuais ou eles serão substituídos.

Faça as seguintes substituições:

  • INSTANCE_NAME com o nome da instância do Cloud SQL que você quer atualizar.
  • CUSTOM_DNS_NAME com até três nomes de DNS personalizados, separados por vírgulas sem espaços entre os valores. Por exemplo, develop.example.com,new-test.example.com,production.example.com.

Limpar todos os valores de SAN personalizados de uma instância

Para limpar todos os valores de SAN personalizados de uma instância, faça o seguinte:

gcloud

gcloud sql instances patch INSTANCE_NAME \
  --clear-custom-subject-alternative-names

Substitua INSTANCE_NAME pelo nome da instância do Cloud SQL que você quer atualizar.

Criar registros DNS personalizados

Antes de se conectar à instância usando o nome DNS personalizado com seus clientes e aplicativos, configure o mapeamento entre o nome DNS e o endereço IP. Esse mapeamento é conhecido como resolução de DNS. Se você estiver se conectando de forma particular, crie o registro DNS em uma zona DNS particular na rede da nuvem privada virtual (VPC) correspondente.

Para criar registros DNS personalizados para sua instância, faça o seguinte:

  1. Recupere o endereço IP da instância. Execute este comando:

    gcloud sql instances describe INSTANCE_NAME \
     --project=PROJECT_ID

    Faça as seguintes substituições:

    • INSTANCE_NAME: o nome da instância do Cloud SQL
    • PROJECT_ID: o ID ou número do projeto do projeto Google Cloud que contém a instância
  2. Na resposta, procure o campo ipAddresses:.

    Exemplo:

    ipAddresses:
    - ipAddress: 192.0.2.4
      type: PRIVATE
    

    É possível recuperar o endereço IP particular de uma instância configurada para acesso a serviços particulares, Private Service Connect ou ambos.

  3. Adicione dois registros DNS a uma zona DNS usada pelo seu aplicativo. É possível usar um servidor DNS gerenciado por você ou a zona privada do Cloud DNS usada pelo aplicativo.

    • Crie um registro A para o endereço IP da instância.
    • Crie um registro TXT que contenha o nome da conexão da instância.

    Os clientes de banco de dados padrão usam o registro A para procurar o endereço IP e fazer a conexão. Os conectores de linguagem do Cloud SQL e o proxy de autenticação do Cloud SQL usam o registro TXT para pesquisar o nome da conexão da instância.

    Por exemplo, a string de conexão da sua instância é my-project:region:my-instance, mas você quer se conectar usando o nome DNS prod-db.mycompany.example.com. Se o endereço IP da instância na rede da sua empresa for 192.0.2.4, crie os seguintes registros DNS:

    Record type: A
    Name: prod-db.mycompany.example.com
    Value: 192.0.2.4
    TTL: 600
    
    Record type: TXT
    Name: prod-db.mycompany.example.com
    Value: my-project:region:my-instance
    TTL: 600
    

Conectar-se a uma instância usando um nome DNS personalizado

Ao se conectar a uma instância do Cloud SQL para MySQL, configure o nome DNS personalizado como o nome do host e ative a verificação de identidade do servidor no cliente. Por exemplo, ao usar o cliente MySQL, especifique a flag --ssl-mode=VERIFY_IDENTITY. Outros drivers de cliente MySQL têm flags de configuração semelhantes.

Se você estiver se conectando a uma instância privada do Cloud SQL de uma rede externa, configure a instância do Cloud SQL e a rede de nuvem privada virtual (VPC) dela para permitir conexões externas e deixar o Cloud DNS se comunicar com sistemas locais. Para mais informações sobre essa configuração, consulte Conectar de uma fonte externa e Configurar o DNS para sistemas locais.

Limitações

  • Não é possível adicionar mais de três nomes de DNS como valores SAN personalizados ao certificado do servidor de uma instância do Cloud SQL.
  • O comprimento máximo de um nome de DNS que pode ser adicionado ao certificado como um valor SAN personalizado para uma instância é de 253 caracteres.
  • Os nomes de DNS adicionados ao certificado de uma instância não podem ter caracteres curinga (*) nem pontos finais. Por exemplo, test.example.com. não é permitido.
  • Os nomes de DNS precisam ser válidos, conforme especificado pela RFC 1034.
  • É possível especificar valores SAN personalizados apenas para instâncias CUSTOMER_MANAGED_CAS_CA.

A seguir