Os serviços do ClickHouse Managed Postgres podem ser criados e gerenciados usando o recurso clickhouse_postgres_service no provider Terraform do ClickHouse. Esta página aborda a configuração do provider e traz exemplos de configuração para o recurso e suas fontes de dados correspondentes.
Este recurso está em alpha, e seu comportamento pode mudar em versões futuras do provider. Ele é distribuído na compilação regular do provider e está disponível a partir da versão v3.17.1 do provider — consulte os lançamentos do provider para mais detalhes. terraform {
required_providers {
clickhouse = {
source = "ClickHouse/clickhouse"
version = ">= 3.17.1"
}
}
}
provider "clickhouse" {
organization_id = var.organization_id
token_key = var.token_key
token_secret = var.token_secret
}
clickhouse_postgres_service tem os seguintes argumentos:
| Argumento | Obrigatório | Descrição |
|---|
name | Sim | Nome legível por humanos para o serviço. Imutável — alterá-lo destrói e recria o serviço. |
cloud_provider | Para uma criação padrão | Provedor de Cloud que hospeda a instância. No momento, apenas aws é compatível. Omita para uma réplica de leitura ou restauração para um ponto no tempo (herdado da source). |
region | Para uma criação padrão | Região da Cloud (por exemplo, us-east-1). Omita para uma réplica de leitura ou restauração para um ponto no tempo (herdado da source). |
size | Para uma criação padrão | Tamanho da instância (SKU da VM), por exemplo m6gd.large. Pode ser redimensionada no local. Omita para uma restauração para um ponto no tempo (a instância restaurada sobe com o tamanho do backup). |
postgres_version | Não | Versão principal do Postgres (por exemplo, 18). Alterar a versão principal destrói e recria o serviço. |
ha_type | Não | Modo de alta disponibilidade: none, async ou sync. Consulte Alta disponibilidade. |
password | Não | Senha do superusuário. Omita para que o servidor gere uma. Armazenada no estado (sensível). |
pg_config | Não | Parâmetros do servidor Postgres como um mapa de chave-valor. |
pgbouncer_config | Não | Parâmetros do pooler de conexões PgBouncer como um mapa de chave-valor. |
tags | Não | Tags do recurso como um mapa de chave-valor. |
read_replica_of | Não | ID de um serviço primário a ser replicado. Consulte Réplicas de leitura. Mutuamente exclusivo com restore_to_point_in_time. |
restore_to_point_in_time | Não | Cria o serviço restaurando outro serviço para um ponto no tempo. Consulte Restauração para um ponto no tempo. Mutuamente exclusivo com read_replica_of. |
id, state, created_at, is_primary, hostname, port, username e connection_string (sensível).
A password é armazenada em texto simples no seu estado do Terraform. Proteja seu arquivo de estado adequadamente — por exemplo, use um backend remoto com criptografia em repouso. Se você omitir password, o servidor gerará uma, e o provedor a lerá de volta no estado a cada refresh.
resource "clickhouse_postgres_service" "example" {
name = "my-postgres"
cloud_provider = "aws"
region = "us-east-1"
size = "m6gd.large"
# High-availability mode — number of standby replicas:
# "none" – primary only, no standby (default)
# "async" – 1 standby, asynchronous replication
# "sync" – 2 standbys, synchronous replication
ha_type = "async"
tags = {
environment = "production"
team = "data"
}
}
password — ela deve ter pelo menos 12 caracteres, incluindo ao menos uma letra minúscula, uma letra maiúscula e um dígito. Se omiti-la, o servidor gerará uma.
O argumento ha_type controla o número de réplicas em standby:
ha_type | Standbys | Replicação |
|---|
none | Nenhuma (somente a primária) | — |
async | 1 standby | Assíncrona — o commit das gravações ocorre sem esperar pela standby |
sync | 2 standbys | Síncrona — a primária aguarda a confirmação de pelo menos uma standby |
ha_type pode ser alterado após a criação; mudá-lo aciona uma transição de HA. Consulte Alta disponibilidade para mais detalhes.
Defina read_replica_of como o id de um serviço primário para criar uma réplica de leitura via streaming. A réplica herda cloud_provider, region, postgres_version e o superusuário do primário — omita esses campos (e password):
resource "clickhouse_postgres_service" "replica" {
name = "my-postgres-replica"
size = "m6gd.large"
read_replica_of = clickhouse_postgres_service.example.id
}
Restauração para um ponto no tempo
restore_to_point_in_time para criar um serviço restaurando o backup de outro serviço para um ponto específico no tempo. cloud_provider, region e postgres_version são herdados do serviço de origem (omita-os); size e ha_type devem ser omitidos:
resource "clickhouse_postgres_service" "restored" {
name = "my-postgres-restored"
restore_to_point_in_time = {
source_id = clickhouse_postgres_service.example.id
restore_target = "2026-06-01T12:00:00Z"
}
}
source_id ou restore_target, ou remover o bloco, destrói e recria o serviço. Consulte Backup e restauração para mais detalhes.
Três fontes de dados complementares permitem consultar serviços existentes:
# A single service by ID.
data "clickhouse_postgres_service" "example" {
id = clickhouse_postgres_service.example.id
}
# All Managed Postgres services in the organization.
data "clickhouse_postgres_services" "all" {}
# The CA certificates for a service, for TLS connections.
data "clickhouse_postgres_service_ca_certificates" "certs" {
service_id = clickhouse_postgres_service.example.id
}
Importando serviços existentes
GET:
terraform import clickhouse_postgres_service.example xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
- Comandos operacionais (restart, promote, switchover).
- Listas de IPs permitidos, endpoints privados, configuração de backup, janelas de manutenção, chaves de criptografia gerenciadas pelo cliente e BYOC.
- Timeouts de ciclo de vida configuráveis — não há bloco
timeouts {}.
