Skip to main content
Enterprise

Prerequisites

Before installing NetBox Enterprise with the nbe-operator Helm chart, verify your environment meets these requirements.

Kubernetes Version

The nbe-operator chart requires Kubernetes 1.26 or later.

kubectl version --short

Required Tools

ToolMinimum VersionPurpose
Helm3.xChart installation and management
kubectlMatching cluster versionCluster interaction and debugging

Resource Requirements

Cluster Sizing

EnvironmentvCPUMemory (RAM)Disk Space
Production (recommended)8 vCPU24 GB100 GB SSD
Non-production (minimum)4 vCPU16 GB50 GB SSD

These recommendations account for the full stack: operator, NetBox application, workers, PostgreSQL, Redis, and Diode components. SSD or NVMe storage is recommended for database performance.

Per-Component Defaults

The chart ships with the following resource defaults. These are starting points — production deployments should allocate resources based on the cluster sizing above.

ComponentCPU RequestMemory RequestCPU LimitMemory Limit
Operator100m128Mi500m512Mi
NetBox app (per replica)200m750Mi1000m1500Mi
NetBox worker (per replica)100m128Mi1000m1500Mi
PostgreSQL (PGO-managed)
Redis250m256Mi

For Diode components (if enabled):

ComponentCPU RequestMemory RequestCPU LimitMemory Limit
Reconciler100m256Mi500m512Mi
Ingester100m256Mi500m512Mi
Auth50m128Mi200m256Mi
Hydra100m256Mi500m512Mi
warning

The per-component defaults are conservative requests to allow scheduling. For production workloads, ensure your nodes have sufficient headroom above these minimums — the cluster sizing recommendations above should be used as the target.

Registry Access

The nbe-operator images are hosted on the Replicated proxy registry at proxy.enterprise.netboxlabs.com. You need valid license credentials to authenticate with the Helm registry before installing.

Registry credentials are automatically injected when installing the chart through the Replicated registry — no manual image pull secret configuration is needed.

Chart Dependencies

The nbe-operator chart automatically installs these dependencies (can be disabled individually):

DependencyVersionPurposeToggle
PGO (Crunchy Postgres Operator)6.0.0Manages internal PostgreSQLpgo.enabled
Redis Operator0.22.2Manages internal Redisredis-operator.enabled
Replicated SDK1.11.2License managementreplicated.enabled
ingress-nginx4.14.1Ingress controller (embedded cluster only)ingress.enabled
info

When using an external PostgreSQL database, you can disable PGO with pgo.enabled: false. Similarly, set redis-operator.enabled: false when using external Redis. See the Configuration section for details.

RBAC Requirements

The operator requires cluster-level or namespace-level RBAC permissions depending on the rbac.scope setting:

  • cluster (default): Creates ClusterRole and ClusterRoleBinding. The operator watches for NetBoxEnterprise resources across all namespaces.
  • namespace: Creates Role and RoleBinding in the release namespace only. The operator watches only the namespace where it is installed.

The operator's service account needs permissions to manage Deployments, Services, ConfigMaps, Secrets, PVCs, Jobs, CronJobs, Ingresses, and the CRDs for PostgreSQL and Redis operators.

Persistent Storage

The cluster must have a default StorageClass or you must specify one explicitly. Storage is used for:

  • PostgreSQL data (default: 4Gi)
  • NetBox media files (default: 10Gi)
  • NetBox scripts (default: 1Gi)
  • Redis persistence (if enabled)

Next Steps