NetBox Enterprise Helm Documentation

Deploy NetBox Enterprise on Kubernetes using the nbe-operator Helm chart. The operator manages the full lifecycle of your NetBox deployment — from initial install through upgrades, scaling, and backups.

Installation

Prerequisites

Setup

Kubernetes version requirements, tooling, resource baseline, and registry access.

Quickstart

5 min

Minimal path to a running NetBox instance with default settings.

Standard Installation

Install

Full installation with custom values, TLS, resource tuning, and production settings.

Upgrading

Operations

Version upgrade procedures, CRD updates, and rollback strategies.

Configuration

Helm Values Reference

Reference

Complete reference for all values.yaml fields organized by section.

NetBox

Config

Application replicas, worker configuration, resources, and superuser setup.

PostgreSQL

Database

Internal PGO-managed database or external PostgreSQL with TLS.

Redis

Cache

Internal operator-managed Redis or external Redis with auth and TLS.

Diode

Ingestion

Data ingestion pipeline — reconciler, ingester, auth, and Hydra OIDC.

Ingress & TLS

Networking

Ingress controller setup, TLS certificates, and custom CA chains.

Monitoring

Observability

Prometheus metrics, ServiceMonitor, and health check endpoints.

Guides

Architecture

Overview

Component diagram, operator reconciliation flow, and data flow topology.

External Database

Guide

Step-by-step guide to connecting an external PostgreSQL database.

Maintenance Mode

Operations

Safely take NetBox offline for database migrations, backups, and repairs.

Backups

Operations

Velero backup integration for disaster recovery.

Security

Hardening

RBAC modes, pod security, TLS configuration, and network policies.

Troubleshooting

Debug

Common issues, diagnostic commands, and status condition reference.

API Reference

NetBoxEnterprise CRD

API

Complete field reference for the NetBoxEnterprise custom resource definition.

Status & Conditions

API

Status fields, condition types, component health, and kubectl inspection.