yba-terraform

Use when writing, generating, or troubleshooting Terraform that drives YugabyteDB Anywhere (YBA) via the `yugabyte/yba` provider — installing YBA on a VM, registering the first customer, and creating cloud (AWS/GCP/Azure) or on-prem providers, storage configs, universes, backups, schedules, and restores. Also covers the upstream cloud Terraform (IAM user / service account / service principal) that grants YBA its node-deployment permissions, and the CLI commands to discover the VPC/subnet/security-group network info those manifests need. Triggers on `yba_installer`, `yba_customer_resource`, `yba_aws_provider`/`yba_gcp_provider`/`yba_azure_provider`, `yba_universe`, `yba_backup`, `source = "yugabyte/yba"`, or any mention of the YBA Terraform provider. Does NOT cover the YBA REST API directly (use the yba-api skill) or YugabyteDB Aeon.

Jump to install

Repository: yugabyte/yugabytedb-skills
Last source activity: June 12, 2026 at 08:06
Detected SKILL.md language: English
Stars: 6
Forks: 4

Install options

The review-first prompt is selected by default. You can switch to a direct command or download a local copy.

Install with Codex or Claude Copy this prompt, paste it into Codex, Claude, or another assistant, and let it review the skill page and install it for you.

A direct command skips the review prompt. Inspect the source before running it.

npx skills add https://github.com/yugabyte/yugabytedb-skills --skill yba-terraform

The command stays on one line. Scroll horizontally to inspect it before copying.

Prefer a local copy? Download the files currently available to SkillsMP.

Review the source files

Read SKILL.md and any companion files shown by SkillsMP before deciding whether to install.

File Explorer

5 files

SKILL.md

Source instructions · Read-only preview

Back to search Back to installation

operator

Use when provisioning, managing, or troubleshooting YugabyteDB universes on Kubernetes via the YugabyteDB Kubernetes Operator and YugabyteDB Anywhere CRDs (YBUniverse, YBProvider, Release, Backup, StorageConfig, PitrRestore, DrConfig, etc.). Triggers on kubectl apply, Helm install of yugaware, operator CRDs, or any mention of YugabyteDB with Kubernetes.

2026-07-27

yb-rag-langchain

Use this skill when building RAG, semantic search, or hybrid (vector + full-text) search on YugabyteDB with LangChain — including PGVectorStore setup, vector/GIN index creation, hybrid search configuration, metadata filtering, and relational + vector queries. Triggers on mentions of YugabyteDB + LangChain, PGVectorStore on YugabyteDB, pgvector + YSQL, or RAG pipelines using `langchain_postgres` against a YugabyteDB cluster.

2026-06-09

explain-plan-analyzer

Analyzes PostgreSQL (and YugabyteDB) EXPLAIN / EXPLAIN ANALYZE query plans to identify performance issues. Use this skill whenever a user pastes an explain plan, asks to analyze a query plan, mentions seq scans or full table scans, wants index recommendations, or asks why a query is slow. Trigger even if the user just says "look at this plan", "what's wrong with this query", or pastes raw EXPLAIN output.

2026-05-26

View all from this repository

name

yba-terraform

description

YugabyteDB Anywhere (YBA) Terraform Provider

This skill generates correct Terraform for the yugabyte/yba provider — the official provider that installs and drives a self-managed YugabyteDB Anywhere control plane.

Registry: https://registry.terraform.io/providers/yugabyte/yba/latest/docs
Source: https://github.com/yugabyte/terraform-provider-yba (branch main)
Current version: 1.0.0 (Early Access). Requires YBA stable >= 2024.2.0.0 or preview >= 2.23.1.0. Kubernetes universes are not supported by this provider — for those use the yb-k8s-operator skill.

It is not about:

The YBA REST API directly — use the yba-api skill (this provider calls that API for you).
YugabyteDB Aeon (managed DBaaS) or database access.

Anti-pattern

Consequence

Do instead

Configuring the authenticated provider with an api_token computed in the same apply

Provider config can't depend on a not-yet-known value; flaky/failed apply

Split into Stage 1 (install + customer) and Stage 2 (everything else); pass the token between states/modules.

Using yba_cloud_provider / yba_storage_config_resource / yba_backups

Deprecated; removed in v2.0.0

Use yba_aws_provider/…, the per-backend *_storage_config, and yba_backup_schedule.

Adding a nested zones {} block to yba_gcp_provider

Schema error — GCP has no per-zone block

GCP: regions { code, shared_subnet }; zones auto-discover. AWS/Azure use zones { code, subnet }.

Putting AMI IDs in region_overrides for GCP/Azure

Wrong field

AWS uses image_bundles.details.region_overrides (map); GCP/Azure use details.global_yb_image (string). Or use yba_managed_image_bundles.

Hard-coding a 215 GB / smaller root volume

Install runs out of space mid-deploy

Provision 250 GB; YBA data lives in /opt/yugabyte/data.

Using keyspaces on yba_restore

Schema error

Restore uses repeatable backup_storage_info { keyspace = ... } (singular); backups/schedules use keyspaces (list).

device_info with storage_type = "GP3" but no disk_iops/throughput

Passes validate, fails plan — GP3 requires both (IO1/IO2 require disk_iops)

Set disk_iops and throughput for GP3 (baseline 3000 / 125). See the device_info table in providers-universe.md.

Trusting a clean terraform validate

The yba provider enforces many cross-field rules only at plan time

Always run terraform plan — validate checks schema shape, not the provider's conditional requirements.

Granting YBA broad cloud admin

Over-privileged credentials

Apply the scoped policy/role in references/cloud-iam-setup.md (AWS JSON policy, GCP roles/compute.admin, Azure Network + VM Contributor).

Committing state with api_token/password in plaintext

Credential leak — token does not expire

Use an encrypted remote backend; mark vars sensitive.

Expecting terraform destroy to remove the customer

yba_customer_resource destroy is a no-op (no delete-customer API)

Understand it only drops from state; the YBA customer persists.

Argument	Env var (preferred → legacy)	Notes
`host`	`YBA_HOST` → `YB_HOST`	IP/DNS, optionally with `:port`.
`api_token`	`YBA_API_TOKEN` / `YBA_API_KEY` → `YB_API_KEY`	Customer API token. Omit for the unauthenticated provider.
`enable_https`	`YBA_ENABLE_HTTPS` → `YB_ENABLE_HTTPS`	`true` by default. Set `false` for HTTP-only YBA (then put the HTTP port in `host`).

Purpose	Resource	Notes
Install YBA on a VM	`yba_installer`	SSH-based; unauthenticated provider.
Register first customer	`yba_customer_resource`	Outputs `api_token`, `cuuid`. `destroy` is a no-op.
Cloud provider	`yba_aws_provider`, `yba_gcp_provider`, `yba_azure_provider`	Prefer these. `yba_cloud_provider` is deprecated (removed in v2.0.0).
On-prem / VM provider	`yba_onprem_provider` + `yba_onprem_node_instance`	v1.0.0 has known on-prem issues — see reference file.
Backup storage	`yba_s3_storage_config`, `yba_gcs_storage_config`, `yba_azure_storage_config`, `yba_nfs_storage_config`	`yba_storage_config_resource` is deprecated.
Universe	`yba_universe`	References provider via `provider`, `region_list`, plus `yba_provider_key` + `yba_release_version` data sources.
Backups	`yba_backup` (on-demand), `yba_backup_schedule` (cron/frequency)	`yba_backups` is deprecated → use `yba_backup_schedule`.
Restore	`yba_restore`	Uses `backup_storage_info { keyspace = ... }` (singular).

yba-terraform

Install options

Review the source files

YugabyteDB Anywhere (YBA) Terraform Provider

YugabyteDB Anywhere (YBA) Terraform Provider

Reference files (read before generating non-trivial manifests)

The end-to-end workflow

Provider configuration (the two-provider pattern)

Resource cheat-sheet (use the per-cloud resources, not the deprecated generics)

Getting the network info a cloud provider needs

Prerequisites (always state these when planning an install)

Anti-patterns

yba-terraform

Source facts

Install options

Review the source files

More from this repository

More from this repository

YugabyteDB Anywhere (YBA) Terraform Provider

YugabyteDB Anywhere (YBA) Terraform Provider

Reference files (read before generating non-trivial manifests)

The end-to-end workflow

Provider configuration (the two-provider pattern)

Resource cheat-sheet (use the per-cloud resources, not the deprecated generics)

Getting the network info a cloud provider needs

Prerequisites (always state these when planning an install)

Anti-patterns