Skip to main content
Enterprise

Helm Values Reference

Complete reference for the nbe-operator values.yaml organized by section. All values below are set at the top level of your values file.

Global Configuration

KeyTypeDefaultDescription
global.imagePullSecretslist[{name: netbox-enterprise-helm-registry}, {name: netbox-enterprise-registry}]Image pull secrets applied to all pods
global.database.enabledbooltrueEnable internal PGO-managed PostgreSQL
global.image.pullPolicystringIfNotPresentDefault image pull policy
global.kubernetesVersionstring>=1.26.0Kubernetes version constraint

Operator Configuration

KeyTypeDefaultDescription
operator.enabledbooltrueDeploy the operator
operator.image.registrystringproxy.enterprise.netboxlabs.com/...Operator image registry
operator.image.repositorystringnbe-netbox-enterprise/netboxlabs/nbe-operatorOperator image repository
operator.image.tagstring2.0.0Operator image tag
operator.image.pullPolicystringIfNotPresentOperator image pull policy
operator.metricsPortint8080Port for metrics endpoint
operator.healthPortint8081Port for health endpoints
operator.metricsScrapeIntervalSecsint30Seconds between metrics scrape operations
note

The cluster DNS suffix is now configured in the NetBoxEnterprise CRD via spec.clusterDnsSuffix instead of a Helm value.

Operator Logging

KeyTypeDefaultDescription
operator.logging.levelstringinfoLog level using RUST_LOG syntax (e.g., info, debug, info,kube=warn)
operator.logging.formatstringautoLog format: auto, json, compact, pretty, gcp, aws, otlp
operator.logging.otlp.endpointstringDefault: OTLP on port 4318OTLP exporter endpoint URL (when format is otlp)
operator.logging.otlp.serviceNamestringnbe-operatorService name for OTLP traces

Operator Probes

KeyTypeDefaultDescription
operator.livenessProbe.initialDelaySecondsint15Delay before liveness checks start
operator.livenessProbe.periodSecondsint20Interval between liveness checks
operator.readinessProbe.initialDelaySecondsint5Delay before readiness checks start
operator.readinessProbe.periodSecondsint10Interval between readiness checks

Operator Environment

KeyTypeDefaultDescription
operator.envlist[]Additional environment variables
operator.envFromlist[]Environment variable sources (ConfigMaps, Secrets)
operator.configobject{}Additional operator configuration

Service Account & RBAC

KeyTypeDefaultDescription
serviceAccount.createbooltrueCreate a ServiceAccount for the operator
serviceAccount.annotationsobject{}Annotations for the ServiceAccount
serviceAccount.namestring""Override ServiceAccount name (auto-generated if empty)
rbac.createbooltrueCreate RBAC resources
rbac.scopestringclusterRBAC scope: cluster or namespace

Service

KeyTypeDefaultDescription
service.enabledbooltrueCreate a Service for the operator
service.typestringClusterIPService type
service.metricsPortint8080Metrics port exposed by the Service
service.annotationsobject{}Service annotations

Metrics

KeyTypeDefaultDescription
metrics.enabledbooltrueEnable Prometheus discovery annotations on the operator pod
metrics.podAnnotationsbooltrueAdd prometheus.io/scrape, prometheus.io/port, prometheus.io/path annotations

See Monitoring for details on application-level metrics.

ServiceMonitor

KeyTypeDefaultDescription
serviceMonitor.enabledboolfalseCreate a Prometheus Operator ServiceMonitor
serviceMonitor.namespacestring""Namespace for the ServiceMonitor (defaults to release namespace)
serviceMonitor.labelsobject{}Additional labels for the ServiceMonitor
serviceMonitor.annotationsobject{}Additional annotations
serviceMonitor.intervalstring30sScrape interval
serviceMonitor.scrapeTimeoutstring10sScrape timeout
serviceMonitor.schemestringhttpHTTP scheme (http or https)
serviceMonitor.tlsConfigobject{}TLS config for scraping
serviceMonitor.honorLabelsbooltrueHonor labels from scraped metrics
serviceMonitor.relabelingslist[]Relabeling configurations
serviceMonitor.metricRelabelingslist[]Metric relabeling configurations
serviceMonitor.targetLabelslist[]Target labels for scraped metrics

Pod Configuration

KeyTypeDefaultDescription
replicaCountint1Operator replica count
podAnnotationsobject{}Additional pod annotations
podLabelsobject{}Additional pod labels
resources.requests.cpustring100mOperator CPU request
resources.requests.memorystring128MiOperator memory request
resources.limits.cpustring500mOperator CPU limit
resources.limits.memorystring512MiOperator memory limit
nodeSelectorobject{}Node selector constraints
tolerationslist[]Pod tolerations
affinityobject{}Pod affinity/anti-affinity rules
volumeslist[]Additional volumes
volumeMountslist[]Additional volume mounts

Pod Security

KeyTypeDefaultDescription
podSecurityContext.runAsNonRootbooltrueEnforce non-root
podSecurityContext.runAsUserint65532UID for operator process
podSecurityContext.fsGroupint65532Filesystem group
securityContext.allowPrivilegeEscalationboolfalseBlock privilege escalation
securityContext.capabilities.droplist[ALL]Drop all capabilities
securityContext.readOnlyRootFilesystembooltrueRead-only root filesystem

Dependency Toggles

KeyTypeDefaultDescription
pgo.enabledbooltrueInstall Crunchy Postgres Operator
redis-operator.enabledbooltrueInstall Redis Operator
replicated.enabledbooltrueInstall Replicated SDK
ingress.enabledboolfalseInstall ingress-nginx controller

NetBoxEnterprise Configuration

The netboxEnterprise section controls the NetBoxEnterprise custom resource that the operator reconciles. See the dedicated configuration pages for each subsection:

KeyTypeDefaultDescription
netboxEnterprise.enabledboolfalseCreate a NetBoxEnterprise CR
netboxEnterprise.namestringnetboxName of the NetBoxEnterprise resource
netboxEnterprise.annotationsobject{}Annotations merged with defaults
netboxEnterprise.spec.suspendboolfalseSuspend reconciliation
netboxEnterprise.spec.maintenanceModeboolfalseEnable maintenance mode
netboxEnterprise.spec.backupsboolfalseEnable Velero backups

For the full spec reference, see the NetBoxEnterprise CRD documentation.

  • NetBoxnetboxEnterprise.spec.netbox.* (app, worker, config)
  • PostgreSQLnetboxEnterprise.spec.postgresql.* (internal/external DB)
  • RedisnetboxEnterprise.spec.redis.* (internal/external cache)
  • DiodenetboxEnterprise.spec.diode.* (data ingestion pipeline)
  • Ingress & TLS — Networking and certificates
  • Monitoring — Metrics and ServiceMonitor