Skip to main content
When you’re deploying NexusOne, you set its variables in two ways:
  1. For the core and modules tiers, the deployer script reads a NexusOne YAML configuration file, and Terraform picks up every key in it automatically.
  2. For the tenant tier, you set its variables separately, through Tenant Manager, when you create a tenant.

Core and module variables

You set these variables in the deployer’s YAML configuration file for the core and modules tiers.
Use these variables if you run more than one NexusOne deployment on the same cluster. They let the deployments share a single ClusterRole instead of each creating its own.
bool
default:"false"
Whether Terraform creates Grafana Alloy’s ClusterRole.
bool
default:"true"
Whether Terraform creates Grafana Alloy’s ServiceAccount.
string
default:"alloy"
Name of Grafana Alloy’s ServiceAccount.
bool
default:"false"
Whether Terraform creates kube-state-metrics’ ClusterRole.
bool
default:"true"
Whether Terraform creates kube-state-metrics’ ServiceAccount.
bool
default:"false"
Whether Terraform creates the observability router’s ClusterRole.
bool
default:"true"
Whether Terraform creates the observability router’s ServiceAccount.
string
Name of the observability router’s ServiceAccount. Defaults to <shared_services_namespace>-observability-router when left empty, or to the namespace’s default ServiceAccount if obs_router_create_service_account is false.
bool
default:"true"
Whether Terraform creates the observability webhook’s ServiceAccount.
string
default:"observability-webhook"
Name of the observability webhook’s ServiceAccount.
Turn NexusOne components on or off, such as Tenant Manager and YuniKorn.
bool
default:"false"
Whether to restrict network access to DataHub so only NexusOne platform components can connect to it. When false, other non-NexusOne pods in your cluster can connect.
bool
default:"false"
Whether Grafana adds a dashboard and alerts for the shared PostgreSQL instance. Required when monitoring_type is embedded.
bool
default:"false"
Whether to deploy Tenant Manager, the web app and API you use to create and manage tenants. This deploys Tenant Manager only, not the tenant modules tier.
bool
default:"false"
Whether Terraform creates YuniKorn’s ClusterRole, rather than reusing one that already exists on your cluster.
bool
default:"true"
Whether to deploy YuniKorn, the resource scheduler for data workloads.
Use these variables to pull NexusOne’s component images from somewhere other than the default registry, such as an internal mirror.
string
default:"nx1registry-hgb9hgbwd8baguad.azurecr.io"
Container registry NexusOne pulls its component images from.
By default, Terraform deploys and manages PostgreSQL for you. Set these only if you’d rather point NexusOne at a PostgreSQL instance you already run.
bool
default:"true"
Whether Terraform deploys the shared PostgreSQL instance for you.
string
Hostname of a custom PostgreSQL instance to use instead. Required when postgres is false.
string
Database name on the instance set in dbhost. Required when postgres is false.
string
Username for the instance set in dbhost. Required when postgres is false.
string
Password for the instance set in dbhost. Required when postgres is false.
number
default:"5432"
Port for the instance set in dbhost. Required when postgres is false.
Connect Keycloak to your existing Active Directory or LDAP server, so your users sign in with accounts they already have.
string
Password for the service account Keycloak uses to authenticate to your directory server.
string
Distinguished name of the service account Keycloak uses to authenticate to your directory server.
string
LDAP connection URL, for example ldaps://ad.example.com:636.
bool
default:"true"
Whether Keycloak federates users from Active Directory or LDAP. Defaults to true, but does nothing useful until you also set:
  • ad_bind_credential
  • ad_bind_dn
  • ad_connection_url
  • ad_groups_dn
  • ad_users_dn
Set this to false if you don’t use Active Directory or LDAP.
string
Distinguished name of the directory branch Keycloak searches for groups, for example OU=Groups,DC=example,DC=com. NexusOne only applies this on the first deployment. To change it later, update it in Keycloak directly.
string
Distinguished name of the directory branch Keycloak searches for users, for example OU=Users,DC=example,DC=com. NexusOne only applies this on the first deployment. To change it later, update it in Keycloak directly.
string
default:"( )"
LDAP search filter that selects which groups sync into Keycloak. NexusOne only applies this on the first deployment. To change it later, update it in Keycloak directly.
bool
default:"true"
Whether Keycloak requires an email, first name, and last name for each user in the shared-services realm. Set it to false to make them optional.
string
LDAP search filter that selects which users sync into Keycloak. NexusOne only applies this on the first deployment. To change it later, update it in Keycloak directly.
Set the namespace, storage classes, and base domain NexusOne uses for a deployment.
string
required
Kubernetes namespace and Terraform workspace name for your core and modules tiers. In a disaster recovery pair, use the same value on both the main and standby sites.
string
required
Kubernetes StorageClass for volumes that multiple pods share read-write access to at once.
string
required
Kubernetes StorageClass for volumes that only one pod accesses read-write at a time.
string
required
Base domain shared by every NexusOne component, for example example.com. Each component’s hostname combines its own prefix, your shared_services_namespace, and this domain. For example, if your namespace is nx1 and your domain is example.com, Grafana is at grafana-nx1.example.com.
string
An optional domain for disaster recovery, steered to whichever site is currently active. When set, NexusOne creates a second ingress for it, and DataHub and Keycloak use it instead of domain in their URLs.
Configure the SMTP server NexusOne uses to send email, such as Keycloak password-reset emails and Grafana alert notifications.
bool
default:"false"
Whether to turn on email notifications.
string
default:"localhost"
SMTP server hostname.
number
default:"25"
SMTP server port.
string
default:"admin@nx1cloud.com"
SMTP username.
string
SMTP password. Set this whenever email_enabled is true, since NexusOne has no working default for it.
string
default:"admin@nx1cloud.com"
The “from” address on outgoing emails.
string
Default recipient address for platform notifications.
bool
default:"false"
Whether to connect to the SMTP server over SSL.
Control the Observability component, which collects and shows metrics, logs, and traces.
bool
default:"true"
Whether to deploy Grafana Alloy, the Observability component’s data collector. Required when obs_router_enabled is true.
string
default:"Bearer"
Authorization scheme Grafana uses when it sends alerts to BigPanda. Grafana puts it in the Authorization header, followed by the bigpanda_webhook_token. For example, Authorization: Bearer <token>.Required when bigpanda_enabled is true.
string
Certificate authority Grafana uses to verify BigPanda’s TLS certificate. Paste its certificate as text. Leave it empty to use the certificate authority that signs your NexusOne routes.Required when bigpanda_enabled is true and a different certificate authority signs your BigPanda endpoint.
bool
default:"false"
Whether to add BigPanda, your external incident management platform, as a place Grafana can send alerts. Alerts don’t reach BigPanda until you route them there with a notification policy in Grafana.This variable follows these rules:
  • Required when monitoring_type is embedded and grafana_content_enabled is true.
  • Fails if bigpanda_webhook_url or bigpanda_webhook_token is empty.
string
Token Grafana sends to BigPanda in the Authorization header to authenticate each alert.Required when bigpanda_enabled is true.
string
BigPanda webhook URL Grafana sends alerts to.Required when bigpanda_enabled is true.
string
Password for the central Grafana’s local administrator account. NexusOne generates a random value when you leave it unset. Required when central_grafana_enabled is true.
bool
default:"false"
Whether to deploy one central Grafana that shows metrics, logs, and traces from your tenants.After the first deploy, the nx1_grafana_platform_admin and nx1_grafana_platform_viewer roles appear in NexusOne. Assign one to each person who needs access, as described in Assign a role. Without one of these roles, nobody can sign in.
bool
default:"true"
Whether to deploy nx1-grafana-sync, a background pod that adds each tenant to the central Grafana.Required when central_grafana_enabled, obs_router_enabled, and obs_router_create_cluster_role are all true. Otherwise, the central Grafana shows no tenants.
bool
default:"true"
Whether NexusOne creates its baseline Grafana alert rules. Ignored when grafana_content_enabled is false.
bool
default:"true"
Whether NexusOne manages Grafana content, such as dashboards, datasources, alert rules, and notification policy.Set to false to manage that content yourself. Grafana, Mimir, Loki, and Tempo keep running either way. Required when monitoring_type is embedded.
string
default:"none"
Which observability stack to deploy. Set to embedded for NexusOne’s own Grafana, Mimir, Loki, and Tempo, or leave as none to skip it.
bool
default:"false"
Whether to deploy the parts of the Observability component that collect data, such as Grafana Alloy, the observability router, the observability webhook, and kube-state-metrics.Required when central_grafana_enabled and central_grafana_sync_enabled are both true.
string
Namespace where the observability router runs. Leave it empty to use the router that obs_router_enabled deploys.Required when all of the following are true:
  • monitoring_type is embedded
  • obs_router_enabled is false because another deployment on your cluster already runs the router
bool
default:"false"
Whether to deploy the observability webhook, which labels new pods in namespaces marked observability=enabled so Grafana Alloy can discover them.
Control how NexusOne deploys OpenSearch.
bool
default:"false"
Whether to publish OpenSearch on your ingress. Requires opensearch_security_enabled, since otherwise this would expose an unauthenticated search API.
bool
default:"false"
Whether to turn on OpenSearch’s security plugin, such as HTTP basic auth and transport TLS. New deployments come up secured. To turn it on for a running cluster, restart all OpenSearch pods together after applying, which causes a brief search outage.
bool
default:"false"
Whether to turn on automated OpenSearch snapshot backups. See the Deployment architecture page for what this covers.
object
A separate S3-compatible bucket to store snapshots in, for disaster recovery pairs where a standby site restores from the main site’s bucket. Takes these fields:
  • accesskey
  • bucket
  • endpoint
  • pathstyle
  • secretkey Defaults to the value of the state_bucket variable when not set. Write the opensearch_snapshot_s3 values as a nested mapping in your configuration file, for example:
bool
default:"false"
Whether OpenSearch stores its indices on S3-compatible object storage.
By default, NexusOne generates a secure random password or secret for each of these variables. Set your own value if you’ll need to know it later.NexusOne itself never shows you an auto-generated one. Retrieving it afterward requires direct Terraform command-line access to the state file.
string
Keycloak realm administrator password. NexusOne generates a random value when you leave it unset.
string
Grafana administrator password. Ignored unless monitoring_type is embedded. NexusOne generates a random value when you leave it unset.
string
OpenSearch administrator password. Requires opensearch_security_enabled. NexusOne generates a random value when you leave it unset, though a disaster recovery pair should pin the same value on both sites.
string
Pre-shared key used for authentication between NexusOne components. NexusOne generates a random value when you leave it unset.
string
Ranger administrator password. NexusOne generates a random value when you leave it unset.
string
Override for the signing secrets and tokens each NexusOne component generates for itself. NexusOne generates a random value per component when you leave it unset.
string
Keycloak master realm administrator password. NexusOne generates a random value when you leave it unset.
Configure how NexusOne issues certificates and makes its components reachable from outside your cluster. For example, this lets your browser reach the Keycloak login page, Grafana, or the DataHub catalog.
string
Name of a Venafi custom field that NexusOne sets to your Terraform workspace name on each certificate. The field must exist in your Venafi zone policy.Optional when ssl_type is venafi.
bool
default:"true"
When you reach NexusOne over HTTPS, this variable tells the NexusOne platform components that the original connection used HTTPS. Use one of the following:
  • Set it to true if your load balancer terminates TLS, so the ingress gateway adds the X-Forwarded-Proto: https header to each request.
  • Set it to false if the ingress gateway terminates TLS.
Required when ingress_type is envoy.
string
default:"eg"
Name of the Gateway resource, for Gateway API ingress types such as Envoy or Traefik.
string
default:"envoy-gateway-system"
Namespace that Gateway resource lives in.
string
default:"http"
Picks which port on your ingress gateway NexusOne uses to route traffic to its platform components. The value must match the name your ingress gateway gives that port.
  • Set it to http if your load balancer terminates TLS, so traffic reaches the ingress gateway as plain HTTP.
  • Set it to https if the ingress gateway terminates TLS.
Required when ingress_type is envoy.
string
default:"ocp"
Ingress mechanism. One of ocp, ingress_nginx, or envoy.
bool
default:"true"
Whether your cluster is OpenShift.
bool
default:"true"
Whether to set a certificate on OpenShift Routes.
string
default:"venafi"
Certificate source. One of venafi or internal.
string
Venafi password. Required when ssl_type is venafi.
string
Venafi server URL. Required when ssl_type is venafi.
string
Venafi username. Required when ssl_type is venafi.
string
Venafi policy zone. Required when ssl_type is venafi.
Point Terraform at an S3-compatible bucket to store its state file in.
string
required
S3-compatible bucket name where Terraform stores its state.
string
required
S3-compatible endpoint URL for that bucket.
string
required
Access key for that bucket.
string
required
Secret key for that bucket.
string
default:"us-east-1"
Region for the state bucket and other region-aware resources.
Set multi-site settings, resource sizing, and NexusOne component versions. A site is a NexusOne installation in another cluster, such as a standby for disaster recovery.
string
default:"0.3"
nx1-grafana-sync image tag to deploy. Its version is independent of the NexusOne release. Required when central_grafana_sync_enabled is true.
string
Name that gives each site its own Grafana database schema. Leave it empty for a single site.Required when your main and standby sites share one physical database. Set a different cluster_name on each site, such as primary and standby.
string
default:"medium"
DataHub’s resource sizing. One of small, medium, large, or xlarge.
string
default:"26.5.6.1"
Keycloak image tag to deploy.
string
default:"0.16"
Tenant Manager image tag to deploy.
bool
default:"true"
Whether this is your main site. Set to false on your standby site.

Tenant variables

You configure tenant modules tier variables separately from core and module variables. Instead of a YAML configuration file, you set them through Tenant Manager’s web app or API when you create a tenant.
Choose the large language model provider that NexusOne’s AI features use. You can also deploy the LLM router, a gateway that adds policy-based routing, semantic caching, and request auditing to your LLM traffic.
bool
default:"false"
Whether Ollama runs on GPU nodes. Ignored unless llm_provider is ollama.
string
Overrides the base URL for the Anthropic API, so you can reach Claude through your Claude on AWS API, instead of Anthropic’s standard one.Leave it empty to use Anthropic’s standard API endpoint.
string
Workspace ID for Claude on AWS. Set together with llm_anthropic_base_url when llm_provider = "anthropic".
string
API key for your LLM provider, for example your Anthropic API key. Not required when llm_provider is ollama.
string
Base URL of your LLM backend.Required when llm_provider is openai, and must end in /v1, for example https://inference.baseten.co/v1. Leave it empty for ollama and anthropic.
string
If your LLM gateway or backend needs custom authentication headers, set them here. NexusOne attaches them to every LLM call.Check your LLM gateway’s documentation for the exact header, for example:
string
default:"ollama/ministral-3:8b"
Model name NexusOne’s AI features use. Also used by Trino’s AI functions when llm_provider is ollama or anthropic. Trino’s AI functions aren’t configured when llm_provider is openai.
string
default:"none"
LLM provider. One of none, ollama, anthropic, or openai. Setting ollama also deploys Ollama in a tenant. Setting openai requires llm_endpoint.
bool
default:"false"
Whether to deploy the NexusOne LLM router so your own applications can call it instead of an LLM provider directly. It forwards only to anthropic or ollama, not openai.
Connect Spark and Trino to HashiCorp Vault, where they fetch the keys for column encryption.
bool
default:"false"
Whether Spark and Trino fetch column encryption keys from Vault.
string
Vault server URL. Required when vault_enabled is true.
string
Field in the Vault secret that holds the default encryption key. Required when vault_enabled is true.
string
Path to the Vault secret that holds the encryption keys. Required when vault_enabled is true.
string
Token Spark and Trino use to authenticate to Vault. Required when vault_enabled is true.
Turn tenant components on or off, or have a tenant reuse components that already exist.
bool
default:"true"
Whether Trino and Spark connect to a tenant’s Gravitino Iceberg REST catalog. Gravitino itself deploys either way.
bool
default:"false"
Whether components that support KEDA-based autoscaling, such as Trino, the S3 gateway, and Ollama, autoscale with Kubernetes Event-driven Autoscaling (KEDA). Requires a self-managed KEDA running on your cluster.
bool
default:"false"
Whether to deploy MLflow.
bool
default:"false"
Whether to deploy a NiFi cluster for a tenant. Requires an administrator to enable the NiFiKop operator in the core and modules tiers first, and add a tenant’s namespace to its watch list. Otherwise the apply fails immediately.
bool
default:"false"
Whether to expose Kyuubi’s Spark Connect over gRPC at spark-connect-<client>.<domain>.This variable follows these rules:
  • Required when spark_version is 4.
  • On OpenShift, ocp_set_cert must be true and your IngressController must allow HTTP/2.
bool
default:"false"
Whether a tenant runs in the same namespace as the core and modules tiers. When true, the tenant reuses that namespace’s Keycloak realm and observability stack instead of creating its own.
bool
default:"false"
Whether a tenant’s workload uses the YuniKorn scheduler. Required when yunikorn_enabled is true.
Use this variable to pull a tenant’s component images from somewhere other than the default registry, such as an internal mirror.
string
default:"nx1registry-hgb9hgbwd8baguad.azurecr.io"
Container registry a tenant pulls its component images from.
Control whether Trino and Spark can call business rules as SQL functions.
bool
default:"true"
Whether Trino and Spark let you call published business rules, called decisions, as SQL functions. They appear in a catalog named decisions, with one schema for each decision workspace.Set to false to stop Trino and Spark from calling decisions. In the portal, you can still create, simulate, approve, and publish decisions.
number
default:"30000"
Time in milliseconds that Trino and Spark have to wait before they refresh the list of published decisions. A newly published decision can take this long to appear in SQL.Optional when decisions_enabled is true.
string
Comma-separated list of decision workspaces to show in the decisions catalog. Leave it empty to show every workspace.Optional when decisions_enabled is true.
Connect a tenant’s Keycloak realm to your existing Active Directory or LDAP server, so your users sign in with accounts they already have.
string
Password for the service account Keycloak uses to authenticate to your directory server.
string
Distinguished name of the service account Keycloak uses to authenticate to your directory server.
string
LDAP connection URL, for example ldaps://ad.example.com:636.
bool
default:"true"
Whether Keycloak federates users from Active Directory or LDAP. Defaults to true, but does nothing useful until you also set:
  • ad_bind_credential
  • ad_bind_dn
  • ad_connection_url
  • ad_groups_dn
  • ad_users_dn
Set this to false if you don’t use Active Directory or LDAP.
string
Distinguished name of the directory branch Keycloak searches for groups, for example OU=Groups,DC=example,DC=com. NexusOne only applies this on the first deployment. To change it later, update it in Keycloak directly.
string
Distinguished name of the directory branch Keycloak searches for users, for example OU=Users,DC=example,DC=com. NexusOne only applies this on the first deployment. To change it later, update it in Keycloak directly.
string
LDAP search filter that selects which groups sync into Keycloak. NexusOne only applies this on the first deployment. To change it later, update it in Keycloak directly.
bool
default:"true"
Whether users can sign in to Kyuubi with their NexusOne API key, alongside Keycloak tokens. Set it to false if a tenant can’t reach the NexusOne API. Kyuubi then accepts only Keycloak tokens.
bool
default:"true"
Whether Keycloak requires an email, first name, and last name for each user in the tenant realm. Set it to false to make them optional.
string
LDAP search filter that selects which users sync into Keycloak. NexusOne only applies this on the first deployment. To change it later, update it in Keycloak directly.
Tenant Manager fills in these variables from the core and modules tiers, so every tenant uses the same values. You don’t need to set these.
string
Address of DataHub’s metadata service in the core and modules tiers.
string
Base domain shared by every NexusOne component. A tenant’s component hostnames combine their own prefix, the tenant’s namespace, and this domain. For example, if a tenant’s namespace is demo and your domain is example.com, that tenant’s Airflow is at airflow-demo.example.com.
string
default:"us-east-1"
Region for the state bucket and other region-aware resources.
string
Kubernetes StorageClass for volumes that only one pod accesses read-write at a time.
string
Kubernetes StorageClass for volumes that multiple pods share read-write access to at once.
string
Kubernetes namespace of the core and modules tiers.
string
Access key for the Terraform state bucket.
string
S3-compatible bucket name where Terraform stores its state.
string
S3-compatible endpoint URL for the Terraform state bucket.
string
Secret key for the Terraform state bucket.
Control how Trino workers and Spark executors run on Karpenter nodes.
bool
default:"false"
Whether Trino workers and Spark executors run on nodes that Karpenter provisions. Set to false to keep them on your default worker nodes.
map
Kubernetes node labels that Trino workers and Spark executors must run on, such as { "karpenter.sh/nodepool" = "workers" }.Required when karpenter_enabled is true.
object
Kubernetes toleration that lets Trino workers and Spark executors run on your tainted Karpenter nodes. Takes these fields:
  • effect: One of NoSchedule, PreferNoSchedule, or NoExecute. Defaults to NoSchedule.
  • key: Key of the taint to tolerate.
  • operator: Either Equal or Exists. Defaults to Equal.
  • value: Value of the taint to match.
Defaults to effect = "NoSchedule", key = "worker", and operator = "Exists".Required when karpenter_enabled is true.
Generally, a Postgres instance contains databases, and each database contains schemas. NexusOne lets you point a tenant’s Hive Metastore at a different database on the core tier’s Postgres instance, instead of the core tier’s shared database.
string
Name of the different database for the Hive Metastore. Leave it empty to use the shared database. You create this database in the Postgres instance yourself. NexusOne only connects to it.
Configure the SMTP server a tenant uses to send email, such as Keycloak password-reset emails, Grafana alert notifications, and Airflow’s canary reports.
string
default:"admin@nx1cloud.com"
Comma-separated list of addresses that receive the results of the periodic health check against these components:
  • Airflow
  • Trino
  • Superset
  • JupyterHub
  • Kyuubi
  • Ranger
  • The NexusOne API
  • Portal
  • Keycloak
bool
default:"true"
Whether to turn on email notifications.
string
default:"admin@nx1cloud.com"
The “from” address on outgoing emails.
string
Default recipient address for Grafana alert notifications.
string
default:"localhost"
SMTP server hostname.
string
SMTP password. Set this whenever email_enabled is true, since NexusOne has no working default for it.
number
default:"25"
SMTP server port.
bool
default:"false"
Whether to connect to the SMTP server over SSL.
string
default:"admin@nx1cloud.com"
SMTP username.
Point a tenant to an S3-compatible bucket where it stores its data.
string
required
S3-compatible bucket name for a tenant’s data.
string
required
Access key for the bucket.
string
required
S3-compatible endpoint URL for the bucket.
bool
required
Whether to use path-style addressing for the bucket. Most S3-compatible storage outside of Amazon S3 needs this.
string
Region for the bucket. Leave it empty to use region.
string
required
Secret key for the bucket.
Control the Observability component, which collects and shows metrics, logs, and traces.
string
default:"Bearer"
Authorization scheme a tenant’s Grafana uses when it sends alerts to BigPanda. Grafana puts it in the Authorization header, followed by the bigpanda_webhook_token. For example, Authorization: Bearer <token>.Required when bigpanda_enabled is true.
string
Certificate authority a tenant’s Grafana uses to verify BigPanda’s TLS certificate. Paste its certificate as text. Leave it empty to use the certificate authority that signs your NexusOne routes.Required when bigpanda_enabled is true and a different certificate authority signs your BigPanda endpoint.
bool
default:"false"
Whether to add BigPanda, your external incident management platform, as a place a tenant’s Grafana can send alerts. Alerts don’t reach BigPanda until you route them there with a notification policy in Grafana.This variable follows these rules:
  • Required when monitoring_type is embedded and grafana_content_enabled is true.
  • Ignored when tenant_shares_namespace is true.
  • Fails if bigpanda_webhook_url or bigpanda_webhook_token is empty.
string
Token a tenant’s Grafana sends to BigPanda in the Authorization header to authenticate each alert.Required when bigpanda_enabled is true.
string
BigPanda webhook URL a tenant’s Grafana sends alerts to.Required when bigpanda_enabled is true.
bool
default:"true"
Whether NexusOne creates its baseline Grafana alert rules. Ignored when grafana_content_enabled is false.
bool
default:"true"
Whether NexusOne manages a tenant’s Grafana content, such as dashboards, datasources, alert rules, and notification policy. Set to false to manage that content yourself. Grafana, Mimir, Loki, and Tempo keep running either way.
string
default:"none"
Which observability stack to deploy for a tenant. Set to embedded for a tenant’s own Grafana, Mimir, Loki, and Tempo, or leave as none to skip it.
string
Namespace where the observability router runs. Leave it empty to use the router in the core and modules namespace.Required when monitoring_type is embedded and the router runs in a different namespace.
string
default:"4318"
Port Airflow uses to send metrics over HTTP, in the OpenTelemetry format. The default matches the Grafana Alloy collector that NexusOne deploys. If you run your own Alloy collector on a different port, then ensure you set this to that port.Required when monitoring_type is embedded.
string
Name of the Kubernetes Service that Airflow sends metrics to. Leave it empty to use the Alloy collector that NexusOne runs on each node.If you run your own Alloy collector as a Deployment, then ensure you set this to its Service name. If the Service is outside the tenant namespace, then use its full address. For example, alloy.monitoring.svc.cluster.local.Required when monitoring_type is embedded and you run your own Alloy collector.
bool
default:"false"
Whether Spark and Airflow send traces to a tenant’s Tempo. This includes traces from JupyterHub notebooks, Airflow DAG tasks, and Kyuubi engines.If you change tracing_enabled on a running tenant, then ensure you restart the notebook servers and Kyuubi engines that are already running.Required when monitoring_type is embedded.
Control how NexusOne deploys OpenSearch.
bool
default:"false"
Whether a tenant’s OpenSearch stores its data on S3-compatible object storage. Ignored unless reuse_opensearch is false.
bool
default:"false"
Whether Ranger uses an OpenSearch that already runs in a tenant’s namespace for its audit logs, instead of deploying its own.
Control where a tenant’s Ranger data lives in Postgres, whether it shares its Ranger service with other tenants, and how it names its Gravitino catalog.
string
default:"ranger"
PostgreSQL schema where Ranger stores its data.
string
The name of the group of tenants that share one Ranger service. Set this when ranger_repo_mode is group. Every tenant in the group shares the nx1-unifiedsql-grp-<group> service in Ranger.Tenants in a group must also use the shared metastore and Ranger schema. Leave the metastore_dbname variable empty, and keep the ranger_db_schema variable set to ranger.Use between 2 and 31 lowercase letters, numbers, or hyphens, starting with a letter or number. Don’t include the namespace of any tenant in the group name, because NexusOne would then treat the Ranger service as that tenant’s own.
string
default:"tenant"
Who a tenant shares its Ranger policies with. Choose one of the following:
  • tenant: Nobody. The tenant keeps its own policies, in the nx1-unifiedsql-<namespace> service in Ranger.
  • shared: Every other tenant that’s also set to shared. They all use the nx1-unifiedsql service in Ranger.
  • group: Only the tenants that use the same value for the ranger_repo_group variable. They all use the nx1-unifiedsql-grp-<group> service in Ranger. Set ranger_repo_group when you use group, and only then.
If you leave this ranger_repo_mode variable unset, then NexusOne falls back to the deprecated single_ranger_repo variable. A single_ranger_repo value of true becomes shared, and false becomes tenant.If you update the ranger_repo_mode value on a running tenant, then the tenant moves to the Ranger service that matches the new value. Also, the policies you created in the old Ranger service don’t carry over to the new one.
bool
default:"false"
Whether the Ranger sync agent can remove a tenant’s default access to storage paths, not only add it.When false, the agent only extends a tenant’s default access. When true, the main site’s agent narrows each tenant’s access to its own tmp/<tenant>/ and spark/<tenant>/ paths.Only set it to true after both sites and every tenant sharing the repo run ranger-sync 0.10.0 or later. Refer to the Deployed images page for the ranger-sync version in each release.
string
Catalog name Trino and Spark both use for a tenant’s Gravitino tables, so a table created from one is queryable from the other. Defaults to the tenant’s namespace, with hyphens replaced by underscores.
bool
default:"false"
Deprecated. Use ranger_repo_mode instead. Setting this to true is the same as setting ranger_repo_mode to shared.Whether a tenant shares its Ranger service, and the policies under it, with other tenants, instead of having its own. Shows up as the nx1-unifiedsql service in Ranger, instead of nx1-unifiedsql-<namespace>.
Deploy a NexusOne S3 gateway, which gives users S3 access to a tenant’s data through their Keycloak sign-in, with Ranger controlling what they can reach.
bool
default:"false"
Whether to deploy a NexusOne S3 gateway. The default gateway instance always serves a tenant’s own bucket.
string
default:"[]"
JSON array of extra gateway instances, each backed by S3, HDFS, or Azure storage, alongside the default instance that s3_gateway_enabled already deploys. Leave it empty if you only need that default instance.Each entry needs a unique name and a backend of s3, hdfs, or azure, plus a block named after that backend with these fields:
  • s3: endpoint, access_key, secret_key, region, path_style, meta_bucket, ssl_skip
  • hdfs: namenodes, subpath, user, data_transfer_protection, kerberos, kerberos_spn, kerberos_user, kerberos_realm, hadoop_conf_secret, krb5_conf_secret, keytab_secret
  • azure: account and url. Add access_key or sas_token to authenticate, or leave both out to use url alone For example:
By default, NexusOne generates a secure random password or secret for each of these variables. Set your own value if you’ll need to know it later.
string
Administrator password for a tenant’s Keycloak realm. NexusOne generates a random value when you leave it unset.
string
Administrator password for Airflow, also used by Superset and the portal. NexusOne generates a random value when you leave it unset.
string
Pre-shared key used for authentication between a tenant’s components. NexusOne generates a random value when you leave it unset.
string
Override for the signing secrets and tokens each tenant component generates for itself. NexusOne generates a random value per component when you leave it unset.
string
Password for the Trino administrator identity. NexusOne generates a random value when you leave it unset.
string
default:"trino-admin"
Username NexusOne’s components use to sign in to Trino as an administrator. With the default, NexusOne creates a matching Keycloak user. With any other value, NexusOne assumes you manage that user yourself.
Configure how a tenant issues certificates and makes its components reachable from outside your cluster, for example the portal, Airflow, and JupyterHub.
string
An optional domain for disaster recovery, steered to whichever site is currently active. When set, NexusOne creates a second ingress for it. Airflow, Spark History Server, the portal, and Superset then use it instead of domain in their URLs.
string
Name of a Venafi custom field that NexusOne sets to your Terraform workspace name on each certificate. The field must exist in your Venafi zone policy.Optional when ssl_type is venafi.
bool
default:"true"
When you reach NexusOne over HTTPS, this variable tells the NexusOne platform components that the original connection used HTTPS. Use one of the following:
  • Set it to true if your load balancer terminates TLS, so the ingress gateway adds the X-Forwarded-Proto: https header to each request.
  • Set it to false if the ingress gateway terminates TLS.
Required when ingress_type is envoy.
string
default:"eg"
Name of the Gateway resource, for Gateway API ingress types such as Envoy or Traefik.
string
default:"envoy-gateway-system"
Namespace that Gateway resource lives in.
string
default:"http"
Picks which port on your ingress gateway NexusOne uses to route traffic to its platform components. The value must match the name your ingress gateway gives that port.
  • Set it to http if your load balancer terminates TLS, so traffic reaches the ingress gateway as plain HTTP.
  • Set it to https if the ingress gateway terminates TLS.
Required when ingress_type is envoy.
string
default:"ocp"
Ingress mechanism. One of ocp, ingress_nginx, or envoy.
bool
default:"true"
Whether your cluster is OpenShift.
bool
default:"true"
Whether to set a certificate on OpenShift Routes.
string
default:"venafi"
Certificate source. One of venafi or internal.
string
Venafi password. Required when ssl_type is venafi.
string
Venafi server URL. Required when ssl_type is venafi.
string
Venafi username. Required when ssl_type is venafi.
string
Venafi policy zone. Required when ssl_type is venafi.
Set a tenant’s multi-site settings, resource sizing, timeouts, and component versions.
string
default:"3.3.10"
Airflow image tag to deploy.
string
Name that gives each site its own JupyterHub, Kyuubi, and Grafana database schemas for a tenant. Leave it empty for a single site.Required when your main and standby sites share one physical database. Set a different cluster_name on each site, such as primary and standby.
number
default:"3600"
Seconds a user’s JupyterHub notebook server can sit idle before NexusOne stops it and its kernel.
string
default:"5.4-nx1.24"
Notebook image tag to deploy for JupyterHub. NexusOne also uses this image to serve your deployed Python models.
string
default:"5.4-nx1.24"
JupyterHub hub image tag to deploy. Set it to the same value as jupyter_tag, unless you need to pin the hub separately.
string
default:"large"
Resource sizing for Kyuubi and the Hive metastore. One of small, medium, large, or xlarge.
bool
default:"true"
Whether this is your main site. Set to false on your standby site.
string
default:"2.11.0"
NiFi image tag to deploy. Ignored unless nifi_enabled is true.
string
default:"1.649"
NLP image tag to deploy. NLP is the portal’s backend API.
string
default:"1.649"
Portal image tag to deploy.
string
default:"3.12"
Python version of your notebook image, such as 3.12. NexusOne can’t deploy unless you saved the model with this Python version.
string
default:"nx1-0.10"
Spark image tag to deploy, used by JupyterHub and the portal.
string
default:"3"
Spark major version:
  • 3: Spark 3.5.6 on Scala 2.12
  • 4: Spark 4.2.0 on Scala 2.13 Airflow, JupyterHub, and Kyuubi each match the Spark version automatically, so the whole tenant stays on one consistent Scala version.
string
default:"dynamic"
How JupyterHub stores user home directories:
  • dynamic: Each user gets their own volume
  • static: Each user gets a folder on one shared volume
string
default:"[{'name':'app','profile':'app'}]"
JSON array of Trino clusters to deploy. Each entry takes these fields:
  • name: Unique identifier for the cluster
  • profile: Workload type, each tuned differently:
    • app
    • etl
    • bi
    • analytics
  • min_workers: Optional minimum worker count
  • max_workers: Optional maximum worker count
  • autoscaling: Optional, whether to autoscale workers

Additional resources