Skip to main content

Documentation Index

Fetch the complete documentation index at: https://langchain-5e9cc07a-preview-featse-1779998369-ad736a3.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Reference for every input variable exposed by the GCP Terraform modules. Set non-sensitive variables in infra/terraform.tfvars. For sensitive variables (license key, passwords, encryption keys), make setup-env writes them to Secret Manager and the deploy script wires them into the cluster.

Core

VariableDefaultRequiredDescription
project_idyesGCP project ID.
regionus-west2noGCP region.
zoneus-west2-anoGCP zone for zonal resources.
environmentprodnoEnvironment: dev, staging, prod, test, uat.
name_prefixlsnoResource name prefix (1 to 11 chars).
unique_suffixtruenoAppend a random suffix to resource names.
ownerplatform-teamnoOwner label applied to all resources.
cost_center""noCost center label for billing attribution.
labels{}noAdditional labels applied to all resources.

Networking

VariableDefaultRequiredDescription
subnet_cidr10.0.0.0/20noCIDR for the GKE subnet.
pods_cidr10.4.0.0/14noCIDR for GKE pods.
services_cidr10.8.0.0/20noCIDR for GKE services.

GKE

VariableDefaultRequiredDescription
gke_use_autopilotfalsenoUse GKE Autopilot mode.
gke_node_count2noInitial node count per zone (Standard mode).
gke_min_nodes2noMinimum nodes per zone for autoscaling.
gke_max_nodes10noMaximum nodes per zone for autoscaling.
gke_machine_typee2-standard-4noGKE node machine type.
gke_disk_size100noNode disk size in GB.
gke_release_channelREGULARnoGKE release channel: RAPID, REGULAR, STABLE.
gke_deletion_protectiontruenoEnable deletion protection on the GKE cluster.
gke_network_policy_providerDATA_PLANE_V2noNetwork policy: CALICO or DATA_PLANE_V2.

PostgreSQL (Cloud SQL)

VariableDefaultRequiredDescription
postgres_sourceexternalnoexternal (Cloud SQL) or in-cluster (Helm).
postgres_versionPOSTGRES_15noPostgreSQL version for Cloud SQL.
postgres_tierdb-custom-2-8192noCloud SQL machine tier.
postgres_disk_size50noCloud SQL disk size in GB.
postgres_high_availabilitytruenoEnable Cloud SQL HA (regional standby).
postgres_deletion_protectiontruenoEnable deletion protection on Cloud SQL.
postgres_password""when externalPostgreSQL password. Use TF_VAR_postgres_password.

Redis (Memorystore)

VariableDefaultRequiredDescription
redis_sourceexternalnoexternal (Memorystore) or in-cluster (Helm).
redis_versionREDIS_7_0noRedis version for Memorystore.
redis_memory_size5noMemorystore Redis memory size in GB.
redis_high_availabilitytruenoEnable Memorystore HA tier (Standard HA).
redis_prevent_destroyfalsenoPrevent accidental Terraform destroy of Redis.

ClickHouse

VariableDefaultRequiredDescription
clickhouse_sourcein-clusternoin-cluster, langsmith-managed, or external.
clickhouse_host""when externalClickHouse host (external or managed only).
clickhouse_port9440noClickHouse native protocol port.
clickhouse_http_port8443noClickHouse HTTP port.
clickhouse_userdefaultnoClickHouse username.
clickhouse_tlstruenoEnable TLS for ClickHouse connections.

GCS storage

VariableDefaultRequiredDescription
storage_ttl_short_days14noGCS TTL for ttl_s/ prefix.
storage_ttl_long_days400noGCS TTL for ttl_l/ prefix.
storage_force_destroyfalsenoAllow bucket deletion with objects inside.

LangSmith application

VariableDefaultRequiredDescription
langsmith_namespacelangsmithnoKubernetes namespace for LangSmith.
langsmith_domainlangsmith.example.comnoFully qualified domain name.
langsmith_license_key""noLicense key. Use TF_VAR_langsmith_license_key.
langsmith_helm_chart_version""noPin Helm chart version (empty = latest).

Ingress and TLS

VariableDefaultRequiredDescription
install_ingresstruenoInstall Envoy Gateway via Terraform.
ingress_typeenvoynoIngress type: envoy, istio, or other.
tls_certificate_sourcenonenonone, letsencrypt, or existing.
letsencrypt_email""when letsencryptEmail for Let’s Encrypt notifications.
tls_secret_namelangsmith-tlsnoName for the TLS secret in Kubernetes.

Add-on pass flags

VariableDefaultRequiredDescription
enable_langsmith_deploymenttruenoEnable LangSmith Deployment. Installs KEDA automatically.

Optional GCP modules

VariableDefaultDescription
enable_gcp_iam_moduletrueWires modules/iam for Workload Identity and bucket IAM binding.
enable_secret_manager_modulefalseWires modules/secrets for Secret Manager bootstrap secret.
enable_dns_modulefalseWires modules/dns for Cloud DNS and managed cert.
dns_create_zonetrueCreate a DNS zone when the DNS module is enabled.
dns_existing_zone_name""Existing zone to use when dns_create_zone = false.
dns_create_certificatetrueCreate a Google-managed cert when the DNS module is enabled.

Sensitive variables (set with setup-env.sh)

make setup-env writes these to Secret Manager. Never set these inline in terraform.tfvars.
VariableDescription
langsmith_license_keyLangSmith enterprise license key.
langsmith_admin_passwordInitial org admin password.
langsmith_api_key_saltSalt for hashing API keys. Must stay stable after first deploy.
langsmith_jwt_secretJWT secret for Basic Auth sessions.
langsmith_deployments_encryption_keyFernet key for LangSmith Deployment. Must never change.
langsmith_agent_builder_encryption_keyFernet key for Agent Builder. Must never change.
langsmith_insights_encryption_keyFernet key for Insights. Must never change.
langsmith_polly_encryption_keyFernet key for Polly. Must never change.