Proveedor de Terraform
El proveedor gestiona las bases de datos de NamiDB Cloud (incluidas copias y restauraciones a un punto en el tiempo), las API keys que usan tus aplicaciones, las entradas de IP allowlists y tokens de gestión para otras herramientas, a través de la API de gestión. Terraform 1.5 o posterior. Apache-2.0.
terraform { required_providers { namidb = { source = "namidb/namidb" version = "~> 0.1" } }}
provider "namidb" {} # reads NAMIDB_MANAGEMENT_TOKENAutenticación
El proveedor usa un token de gestión. Pásalo por el entorno para que quede fuera de tu configuración:
export NAMIDB_MANAGEMENT_TOKEN=nmdb_mgmt_…terraform plan| Scope | Permite |
|---|---|
read | Data sources |
write | read, más namidb_database |
admin | write, más namidb_api_key, namidb_management_token y namidb_ip_allowlist_entry |
Argumentos del proveedor (ambos opcionales): token (sensible; por defecto
NAMIDB_MANAGEMENT_TOKEN) y url (por defecto NAMIDB_MANAGEMENT_URL, y si
no https://app.namidb.com/api/v1). Crea el token propio del proveedor en la
consola; con un token admin, Terraform puede crear después tokens más
acotados y con vencimiento para otras herramientas con
namidb_management_token.
namidb_database
resource "namidb_database" "movies" { name = "movies" deletion_protection = true}
# A new database restored from a backup of another one.resource "namidb_database" "movies_staging" { name = "movies-staging" restore_from_backup_id = "0b4c7f2e-5d1a-4c3b-9e8f-1a2b3c4d5e6f"
timeouts = { create = "45m" }}
# A copy of movies taken now, for tests against current data.resource "namidb_database" "movies_qa" { name = "movies-qa" clone_from = { database = namidb_database.movies.name source = "fresh_snapshot" }}
# movies as it was at a point in time.resource "namidb_database" "movies_before_migration" { name = "movies-before-migration" clone_from = { database = namidb_database.movies.name at = "2026-11-03T09:00:00Z" }}
output "movies_endpoint" { value = namidb_database.movies.http_endpoint}| Argumento | |
|---|---|
name (obligatorio) | Letras minúsculas, números, - y _; empieza con una letra o un número; como máximo 63 caracteres. Cambiarlo reemplaza la base de datos y borra los datos de la anterior. |
deletion_protection | Cuando es true, Terraform se niega a destruirla. Por defecto false |
restore_from_backup_id | La crea restaurando este backup; Terraform espera a que termine la restauración. Solo se usa al crearla |
clone_from | La crea como copia de otra base de datos: database (obligatorio), source (latest_backup, por defecto; fresh_snapshot; o point_in_time, por defecto cuando se define at) y at (RFC 3339). Dentro de la ventana de puntos de restauración del plan (Pro 48 horas, Scale 7 días) at se copia exactamente; antes, el backup más reciente en ese momento o antes. Terraform espera a que termine la copia. Solo se usa al crearla: cambiarlo reemplaza la base de datos, y agregarlo a una existente o importada no cambia nada |
timeouts.create | Por defecto 30m |
Atributos de solo lectura: id, status (ready, restoring, failed),
read_only, http_endpoint, bolt_uri, created_at,
restored_from_backup y recovery_point (con clone_from: el momento del
que son los datos; los cambios posteriores en el origen no están incluidos).
Importación por nombre: terraform import namidb_database.movies movies.
namidb_api_key
resource "time_rotating" "every_90_days" { rotation_days = 90}
resource "namidb_api_key" "movies_reader" { name = "movies-reader" role = "read-only" databases = [namidb_database.movies.name]
rotation_triggers = { rotated = time_rotating.every_90_days.id }
lifecycle { create_before_destroy = true # the new key exists before the old one is revoked }}
output "movies_reader_key" { value = namidb_api_key.movies_reader.token sensitive = true}| Argumento | |
|---|---|
name (obligatorio) | De 1 a 64 caracteres |
role | read-write (por defecto) o read-only |
databases | Nombres de bases de datos; omítelo para todas las bases de datos, incluidas las futuras |
expires_at | RFC 3339; dentro de 2 años y de la política de vida útil de keys de la organización |
rotation_triggers | Cualquier valor; cambiar uno crea una key nueva y revoca esta |
Atributos de solo lectura: id, prefix, last4, status, created_at y
token (sensible; solo se conoce para las keys que creó Terraform). Cualquier
cambio de argumento reemplaza la key. Importación por id; el token de una
key importada queda en null.
namidb_management_token
Un token más acotado y con vencimiento para un job de CI u otra herramienta.
resource "time_rotating" "monthly" { rotation_days = 30}
resource "namidb_management_token" "deploy" { name = "github-actions-deploy" scope = "write" expires_at = timeadd(time_rotating.monthly.rfc3339, "840h") # 35 days: a few days of overlap
rotation_triggers = { rotated = time_rotating.monthly.id }
lifecycle { create_before_destroy = true # the new token exists before the old one is revoked }}
output "deploy_token" { value = namidb_management_token.deploy.token sensitive = true}| Argumento | |
|---|---|
name (obligatorio) | 1–64 caracteres |
scope | read (por defecto), write o admin; como máximo el scope del token del proveedor |
expires_at | RFC 3339; dentro de 2 años, de la política de vida útil de las keys de la organización y, cuando el token del proveedor vence, no después que él |
rotation_triggers | Cualquier valor; cambiar uno crea un token nuevo y revoca este |
El token nuevo actúa por la misma persona que el token del proveedor, no puede
ser más amplio y no puede durar más que él; esa persona necesita la
autenticación en dos pasos en su cuenta. Atributos de solo lectura: id,
prefix, last4, status, created_by, created_at y token (sensible;
solo se conoce en los tokens que creó Terraform). Cualquier cambio de
argumento reemplaza el token. Importación por id. No gestiones el propio
token del proveedor con este recurso: destruirlo revocaría la credencial que
usa Terraform.
namidb_ip_allowlist_entry
Una entrada de la IP allowlist de la organización, o de la lista propia de una API key.
resource "namidb_ip_allowlist_entry" "office" { cidr = "203.0.113.0/24" label = "office"}
resource "namidb_ip_allowlist_entry" "batch_host" { api_key_id = namidb_api_key.movies_reader.id # this key only works from here cidr = "198.51.100.17" label = "batch runner"}| Argumento | |
|---|---|
cidr (obligatorio) | Una dirección o rango IPv4 o IPv6. La API guarda la dirección de red, así que 203.0.113.7/24 y 203.0.113.0/24 son la misma entrada |
label | Una nota que se muestra en la consola. Cambiarla reemplaza la entrada |
api_key_id | Pone la entrada en la lista propia de esta API key en lugar de la de la organización |
Una lista con entradas admite peticiones a la API de datos (HTTP, Bolt, MCP)
solo desde sus direcciones; cuando tanto la organización como la key tienen
entradas, una petición debe coincidir con ambas. Agrega tus propias
direcciones antes de que se aplique la primera entrada, o tus aplicaciones
pierden el acceso. La cantidad de entradas por lista depende del plan.
Importación por id, o <api-key-id>/<entry-id> para la lista de una key. Ver
IP allowlists.
Data sources
data "namidb_organization" "this" {}
data "namidb_databases" "tenants" { name_prefix = "tenant-"}
data "namidb_database" "analytics" { name = "analytics" # created in the console}
output "plan" { value = data.namidb_organization.this.plan }output "tenants" { value = data.namidb_databases.tenants.names }namidb_organization:id,slug,name,plan,status,spend_cap,require_mfa,created_atylimits(databases,api_keys,members; null significa sin límite).namidb_databases: todas las bases de datos (opcionalmente filtradas porname_prefix), las más nuevas primero, comodatabases(conid,name,status,read_only,http_endpoint,bolt_uri,created_at) ynames.namidb_database: una base de datos porname, para bases de datos que Terraform no gestiona, conid,status,read_only,http_endpoint,bolt_uri,created_atyrestored_from_backup.
Comportamiento a tener en cuenta
- Secretos en el state.
namidb_api_key.tokenynamidb_management_token.tokenson credenciales completas, guardadas en el state y marcadas como sensibles. Usa un backend de state cifrado y con acceso restringido. - Drift. Una base de datos eliminada fuera de Terraform, o reemplazada por
otra con el mismo nombre, se quita del state y se vuelve a planificar. Una key
o un token revocados fuera de Terraform se quitan y se vuelven a
planificar, con una advertencia. Los vencidos quedan en el state con
status = "expired". - Reintentos. Los
429(respetandoRetry-Afterhasta 60 s), los503y los errores de conexión se reintentan hasta 4 veces; cada creación conserva suIdempotency-Key, así que un reintento nunca crea dos veces. - Los errores incluyen el mensaje, el código, el estado y el id de petición de la API; incluye el id de petición al hablar con soporte.