Conectar-se a uma instância usando o Private Service Connect

Console

1. No console Google Cloud , acesse a página Private Service Connect.

   Acessar a página "Private Service Connect"

2. Clique na guia Políticas de conexão.

3. Clique em Criar política de conexão.

4. Digite um nome para a conexão.

5. Especifique a classe de serviço fazendo o seguinte:

   1. Em Source service class, selecione Google services.
   2. No menu Classe de serviço, selecione google-cloud-alloydb porque o AlloyDB é o serviço gerenciado para a política de conexão.

6. Na seção Escopo de endpoints de destino, selecione uma Rede e uma Região a que essa política se aplica.

7. Na seção Política, selecione uma ou mais sub-redes no menu Sub-redes. As sub-redes são usadas para alocar endereços IP para endpoints.

8. Opcional: especifique um Limite de conexão para a política. O limite determina quantos endpoints o AlloyDB pode criar para essa política de conexão. Se você não especificar um limite de conexão, não haverá limite.

9. Clique em Criar política.

gcloud

Para criar uma política de conexão de serviço, use o comando service-connection-policies create.

gcloud network-connectivity service-connection-policies create POLICY_NAME \
    --network=NETWORK \
    --project=PROJECT_ID \
    --region=REGION \
    --service-class=SERVICE_CLASS \
    --subnets=https://www.googleapis.com/compute/v1/projects/PROJECT_ID/regions/REGION/subnetworks/SUBNETS \
    --psc-connection-limit=LIMIT \
    --description="DESCRIPTION" \
    --producer-instance-location=PRODUCER_INSTANCE_LOCATION \
    --allowed-google-producers-resource-hierarchy-level=LIST_OF_NODES

Substitua:

• POLICY_NAME: o nome da política de conexão de serviço.
• NETWORK: a rede em que essa política é aplicada.
• PROJECT_ID: o ID do projeto ou o número do projeto da rede VPC. Para redes VPC compartilhadas, implante políticas de conexão de serviço no projeto host, porque elas não são compatíveis com projetos de serviço.
• REGION: a região a que essa política se aplica. A mesma política precisa existir para todas as regiões em que você quer automatizar a conectividade do serviço.
• SERVICE_CLASS: o identificador de recurso fornecido pelo produtor da classe de serviço. Para o AlloyDB, a classe de serviço é google-cloud-alloydb.
• SUBNETS: uma ou mais sub-redes de consumidor regulares usadas para alocar endereços IP para endpoints do Private Service Connect. Esses endereços IP são alocados automaticamente e retornados ao pool da sub-rede à medida que as instâncias de serviço gerenciado são criadas e excluídas. As sub-redes precisam estar na mesma região que a política de conexão do serviço. Se várias políticas de conexão compartilharem a mesma região, será possível reutilizar a mesma sub-rede nessas políticas. É possível fornecer várias sub-redes em uma lista separada por vírgulas.
• LIMIT: o número máximo de endpoints que podem ser criados com essa política. Se você não especificar um limite, não haverá nenhum.
• DESCRIPTION: uma descrição opcional do política de conexão de serviço.

• PRODUCER_INSTANCE_LOCATION: especifica se a política automatiza as conexões com instâncias do AlloyDB. Você pode definir esse valor de uma das seguintes maneiras:

  • none (padrão): a instância do AlloyDB está no mesmo projeto que a política de conexão de serviço (ou, no caso da VPC compartilhada, em projetos conectados).
  • custom-resource-hierarchy-levels: exige que você defina o caminho do local do Resource Manager para os projetos em que quer automatizar a conectividade usando o parâmetro allowed-google-producers-resource-hierarchy-level.

• LIST_OF_NODES: defina esse parâmetro se o local da instância do produtor estiver definido como custom-resource-hierarchy-levels. Esse parâmetro é uma lista de projetos, pastas e organizações em que residem as instâncias para as quais você quer automatizar a conectividade. A lista está no formato projects/PROJECT_ID, folders/FOLDER_ID ou organizations/ORGANIZATION_ID.

Por exemplo, o comando a seguir cria uma política de conexão de serviço para a classe de serviço
google-cloud-alloydb que aloca endereços IP da sub-rede managed-services. É possível criar até 10 endpoints do Private Service Connect com esta política. Os endpoints precisam ser criados em projetos que estejam na mesma organização da instância de serviço gerenciado. A instância do AlloyDB está localizada no projeto myproject.

gcloud network-connectivity service-connection-policies create alloydb-policy \
    --network=default \
    --project=my-project \
    --region=us-central1 \
    --service-class=google-cloud-alloydb \
    --subnets=managed-service-subnet \
    --psc-connection-limit=10 \
    --producer-instance-location=custom-resource-hierarchy-levels \
    --allowed-google-producers-resource-hierarchy-level=projects/myproject

Console

1. No console Google Cloud , acesse a página Clusters.

   Acessar Clusters

2. Clique em Criar cluster.

3. Em ID do cluster, insira my-cluster.

4. Digite uma senha. Anote essa senha porque você a usará neste guia de início rápido.

5. Mantenha a versão padrão do banco de dados.

6. Selecione a região us-central1 (Iowa).

7. Mantenha o ID da instância padrão, my-cluster-primary.

8. Em Disponibilidade por zona, mantenha Zona única como a opção selecionada. Embora não recomendemos uma instância de zona única para produção, você vai usar uma única zona neste guia de início rápido para minimizar os custos. Para mais informações, consulte Reduzir custos usando instâncias básicas.

9. Selecione o tipo de máquina 2 vCPU, 16 GB.

10. Manter a conectividade de IP particular.

    1. Selecione Private Service Connect (PSC).
    2. Clique em Adicionar um endpoint.
    3. Selecione o projeto em que você quer criar o endpoint.
    4. Selecione a rede.
    5. Clique em Verificar política para conferir informações sobre a política de conexão de serviço.

11. Mantenha as configurações padrão em Segurança de rede.

12. Não faça mudanças em Mostrar opções avançadas.

13. Clique em Criar cluster. O AlloyDB pode levar vários minutos para criar o cluster e mostrá-lo na página Visão geral do cluster principal.

gcloud

Para criar o cluster, use o comando gcloud alloydb clusters create.

gcloud alloydb clusters create CLUSTER_ID \
  --password=PASSWORD \
  --region=REGION_ID \
  --project=PROJECT_ID \
  --enable-private-service-connect

Substitua:

• CLUSTER_ID: o ID do cluster que você está criando. Ele precisa começar com uma letra minúscula e pode conter letras minúsculas, números e hífens.

• PASSWORD: a senha a ser usada para o usuário padrão postgres.

• REGION_ID: a região em que você quer colocar o cluster.

• PROJECT_ID: o ID do projeto em que você quer colocar o cluster.

Esse comando inicia uma operação de longa duração, retornando um ID de operação.

Para criar a instância do AlloyDB, seja primária ou um pool de leitura para usar o Private Service Connect, use o comando gcloud alloydb instances create. Inclua o parâmetro --allowed-psc-projects para especificar quais projetos consumidores podem criar endpoints para se conectar a essa instância.

gcloud alloydb instances create INSTANCE_ID \
    --instance-type=PRIMARY \
    --cpu-count=CPU_COUNT \
    --availability-type=AVAILABILITY \
    --region=REGION_ID \
    --cluster=CLUSTER_ID \
    --project=PROJECT_ID \
    --allowed-psc-projects=ALLOWED_PROJECT_LIST \
    --psc-network-attachment-uri=NETWORK_ATTACHMENT_URI \
    --psc-auto-connections=network=CONSUMER_NETWORK,project=CONSUMER_PROJECT

Substitua:

• INSTANCE_ID: o ID da instância que você está criando. Ele precisa começar com uma letra minúscula e pode conter letras minúsculas, números e hifens.
• CPU_COUNT: o número de vCPUs que você quer para a instância. Os valores válidos incluem:
  • 2: 2 vCPUs, 16 GB de RAM
  • 4: 4 vCPUs, 32 GB de RAM
  • 8: 8 vCPUs, 64 GB de RAM
  • 16: 16 vCPUs, 128 GB de RAM
  • 32: 32 vCPUs, 256 GB de RAM
  • 64: 64 vCPUs, 512 GB de RAM
  • 96: 96 vCPUs, 768 GB de RAM
  • 128: 128 vCPUs, 864 GB de RAM
• AVAILABILITY: indica se a instância precisa ser de alta disponibilidade (HA), com nós em várias zonas. Valores válidos incluem:
  • REGIONAL: cria uma instância de alta disponibilidade com nós ativos e em espera separados e failover automatizado entre eles. Esse é o valor padrão, adequado para ambientes de produção.
  • ZONAL: cria uma instância básica, contendo apenas um nó e sem failover automático.
• REGION_ID: a região em que você quer que a instância seja colocada.
• CLUSTER_ID: o ID do cluster que você criou anteriormente.
• ALLOWED_PROJECT_LIST: a lista separada por vírgulas de IDs ou números de projetos que você quer permitir o acesso à instância. Por exemplo, my-project-1, 12345,my-project-n.
• NETWORK_ATTACHMENT_URI (opcional): o nome completo do recurso do URI de anexo de rede que você cria para conectividade de saída. Por exemplo: projects/PROJECT_ID/regions/REGION_ID/networkAttachments/NETWORK_ATTACHMENT_ID.
• CONSUMER_NETWORK: o caminho para a rede VPC em que os endpoints do Private Service Connect precisam ser criados. Por exemplo, projects/my-host-project/global/networks/default. Essa opção é válida quando você cria endpoints automaticamente. Verifique se a política de conexão de serviço foi criada. É possível criar a política antes ou depois da instância.
• CONSUMER_PROJECT: o projeto em que o endpoint do Private Service Connect é criado. Se você estiver usando uma rede VPC compartilhada, pode ser o projeto host ou o projeto de serviço. Todos os projetos especificados nos parâmetros de conexão automática são adicionados automaticamente aos projetos permitidos. Se quiser criar endpoints do Private Service Connect manualmente em algum projeto, adicione esses projetos à sua lista de projetos permitidos.

Um cluster secundário criado para um cluster principal ativado para o Private Service Connect herda automaticamente a configuração do Private Service Connect. Para mais informações, consulte Criar um cluster secundário.

Terraform

Para criar uma instância no cluster de banco de dados, use um recurso do Terraform.

resource "google_alloydb_instance" "default" {
  cluster       = google_alloydb_cluster.default.name
  instance_id   = "alloydb-instance"
  instance_type = "PRIMARY"
  machine_config {
    cpu_count = 2
  }
  psc_instance_config {
  allowed_consumer_projects = ["123456789"]
  psc_interface_configs {
    network_attachment_resource = google_compute_network_attachment.default.id
  }
  }
}

resource "google_compute_network" "default" {
    name = "alloydb-network"
    auto_create_subnetworks = false
}

resource "google_compute_subnetwork" "default" {
    name = "alloydb-subnetwork"
    region = "us-central1"
    network = google_compute_network.default.id
    ip_cidr_range = "10.0.0.0/16"
}

resource "google_compute_network_attachment" "default" {
  name                  = "alloydb-network-attachment"
  region                = "us-central1"
  connection_preference = "ACCEPT_AUTOMATIC"
  subnetworks = [
    google_compute_subnetwork.default.self_link
  ]
}

data "google_project" "project" {}

Para saber como aplicar ou remover uma configuração do Terraform, consulte Comandos básicos do Terraform.

Console

1. No console Google Cloud , acesse a página Clusters.

   Acessar Clusters

2. Clique em Criar cluster.

3. Em ID do cluster, insira my-cluster.

4. Digite uma senha. Anote essa senha porque você a usará neste guia de início rápido.

5. Mantenha a versão padrão do banco de dados.

6. Selecione a região us-central1 (Iowa).

7. Mantenha o ID da instância padrão, my-cluster-primary.

8. Em Disponibilidade por zona, mantenha Zona única como a opção selecionada. Embora não recomendemos uma instância de zona única para produção, você vai usar uma única zona neste guia de início rápido para minimizar os custos. Para mais informações, consulte Reduzir custos usando instâncias básicas.

9. Selecione o tipo de máquina 2 vCPU, 16 GB.

10. Manter a conectividade de IP particular.

    1. Selecione Private Service Connect(PSC).
    2. Clique em Adicionar um endpoint.
    3. Selecione o projeto em que você quer criar o endpoint.
    4. Selecione a rede.
    5. Clique em Verificar política para conferir informações sobre a política de conexão de serviço.

11. Mantenha as configurações padrão em Segurança de rede.

12. Não faça mudanças em Mostrar opções avançadas.

13. Clique em Criar cluster. O AlloyDB pode levar vários minutos para criar o cluster e mostrá-lo na página Visão geral do cluster principal.

gcloud

Para criar o cluster, use o comando gcloud alloydb clusters create.

gcloud alloydb clusters create CLUSTER_ID \
  --password=PASSWORD \
  --region=REGION_ID \
  --project=PROJECT_ID \
  --enable-private-service-connect

Substitua:

• CLUSTER_ID: o ID do cluster que você está criando. Ele precisa começar com uma letra minúscula e pode conter letras minúsculas, números e hífens.

• PASSWORD: a senha a ser usada para o usuário padrão postgres.

• REGION_ID: a região em que você quer colocar o cluster.

• PROJECT_ID: o ID do projeto em que você quer colocar o cluster.

Esse comando inicia uma operação de longa duração, retornando um ID de operação.

Para criar a instância principal, use o comando gcloud alloydb instances create.

gcloud alloydb instances create INSTANCE_ID \
    --instance-type=PRIMARY \
    --cpu-count=CPU_COUNT \
    --availability-type=AVAILABILITY \
    --region=REGION_ID \
    --cluster=CLUSTER_ID \
    --project=PROJECT_ID \
    --allowed-psc-projects=ALLOWED_PROJECT_LIST \
    --psc-network-attachment-uri=NETWORK_ATTACHMENT_URI \

Substitua:

• INSTANCE_ID: o ID da instância que você está criando. Ele precisa começar com uma letra minúscula e pode conter letras minúsculas, números e hifens.
• CPU_COUNT: o número de vCPUs que você quer para a instância. Os valores válidos incluem:
  • 2: 2 vCPUs, 16 GB de RAM
  • 4: 4 vCPUs, 32 GB de RAM
  • 8: 8 vCPUs, 64 GB de RAM
  • 16: 16 vCPUs, 128 GB de RAM
  • 32: 32 vCPUs, 256 GB de RAM
  • 64: 64 vCPUs, 512 GB de RAM
  • 96: 96 vCPUs, 768 GB de RAM
  • 128: 128 vCPUs, 864 GB de RAM
• AVAILABILITY: indica se a instância precisa ser de alta disponibilidade (HA), com nós em várias zonas. Valores válidos incluem:
  • REGIONAL: cria uma instância de alta disponibilidade com nós ativos e em espera separados e failover automatizado entre eles. Esse é o valor padrão, adequado para ambientes de produção.
  • ZONAL: cria uma instância básica, contendo apenas um nó e sem failover automático.
• REGION_ID: a região em que você quer que a instância seja colocada.
• CLUSTER_ID: o ID do cluster que você criou anteriormente.
• ALLOWED_PROJECT_LIST: a lista separada por vírgulas de IDs de projetos ou o número do projeto a que você quer permitir o acesso à instância. Por exemplo, my-project-1, 12345,my-project-n.
• NETWORK_ATTACHMENT_URI (opcional): o nome completo do recurso do URI de anexo de rede que você cria para conectividade de saída. Por exemplo: projects/PROJECT_ID/regions/REGION_ID/networkAttachments/NETWORK_ATTACHMENT_ID.
• CONSUMER_NETWORK: o caminho para a rede VPC de onde os endpoints do Private Service Connect precisam ser criados. Por exemplo, projects/my-host-project/global/networks/default. Essa opção é válida quando você cria endpoints automaticamente. Verifique se a política de conexão de serviço foi criada. É possível criar a política antes ou depois da instância.
• CONSUMER_PROJECT: o projeto em que o endpoint do Private Service Connect é criado. Se você estiver usando uma rede VPC compartilhada, pode ser o projeto host ou o projeto de serviço. Todos os projetos especificados nos parâmetros de conexão automática são adicionados automaticamente aos projetos permitidos. Se quiser criar endpoints do Private Service Connect manualmente em algum projeto, adicione esses projetos à sua lista de projetos permitidos.

Um cluster secundário criado para um cluster principal ativado para o Private Service Connect herda automaticamente a configuração do Private Service Connect. Para mais informações, consulte Criar um cluster secundário.

Terraform

Para criar uma instância no cluster de banco de dados, use um recurso do Terraform.

resource "google_alloydb_instance" "default" {
  cluster       = google_alloydb_cluster.default.name
  instance_id   = "alloydb-instance"
  instance_type = "PRIMARY"
  machine_config {
    cpu_count = 2
  }
  psc_instance_config {
  allowed_consumer_projects = ["123456789"]
  psc_interface_configs {
    network_attachment_resource = google_compute_network_attachment.default.id
  }
  }
}

resource "google_compute_network" "default" {
    name = "alloydb-network"
    auto_create_subnetworks = false
}

resource "google_compute_subnetwork" "default" {
    name = "alloydb-subnetwork"
    region = "us-central1"
    network = google_compute_network.default.id
    ip_cidr_range = "10.0.0.0/16"
}

resource "google_compute_network_attachment" "default" {
  name                  = "alloydb-network-attachment"
  region                = "us-central1"
  connection_preference = "ACCEPT_AUTOMATIC"
  subnetworks = [
    google_compute_subnetwork.default.self_link
  ]
}

data "google_project" "project" {}

Para saber como aplicar ou remover uma configuração do Terraform, consulte Comandos básicos do Terraform.

Java

Se você estiver usando o Private Service Connect para se conectar à instância do AlloyDB, inclua o seguinte:

config.addDataSourceProperty("alloydbIpType", "PSC");

Para mais informações sobre como usar o endpoint do Private Service Connect nos conectores de linguagem Java, consulte o repositório do GitHub.

Python (pg8000)

Se você estiver usando o Private Service Connect para se conectar à instância do AlloyDB, inclua o seguinte:

  def getconn() -> pg8000.dbapi.Connection:
      conn: pg8000.dbapi.Connection = connector.connect(
          inst_uri,
          "pg8000",
          user=user,
          password=password,
          db=db,
          # use ip_type to specify PSC
          ip_type=IPTypes.PSC,
      )
      return conn

Para mais informações sobre como usar o endpoint do Private Service Connect nos conectores de linguagem Python, consulte o repositório do GitHub.

Python (asyncpg)

Se você estiver usando o Private Service Connect para se conectar à instância do AlloyDB, inclua o seguinte:

  async def getconn() -> asyncpg.Connection:
    conn: asyncpg.Connection = await connector.connect(
        inst_uri,
        "asyncpg",
        user=user,
        password=password,
        db=db,
        # use ip_type to specify PSC
        ip_type=IPTypes.PSC,
    )
    return conn

Para mais informações sobre como usar o endpoint do Private Service Connect nos conectores de linguagem Python, consulte o repositório do GitHub.

Go (pgx)

Se você estiver usando o Private Service Connect para se conectar à instância do AlloyDB, inclua o seguinte:

d.Dial(ctx, instURI, alloydbconn.WithPSC())

Para mais informações sobre como usar o endpoint do Private Service Connect nos conectores da linguagem Go, consulte o repositório do GitHub.

Go (database/sql)

Se você estiver usando o Private Service Connect para se conectar à instância do AlloyDB, inclua o seguinte:

  cleanup, err := pgxv5.RegisterDriver(
    "alloydb",
    alloydbconn.WithDefaultDialOptions(alloydbconn.WithPSC())
)

Para mais informações sobre como usar o endpoint do Private Service Connect nos conectores da linguagem Go, consulte o repositório do GitHub.