Quickstart

Installation Journey

Prerequisites → Quickstart (you are here)

Get a minimal NetBox Enterprise instance running with default settings. This guide uses internal PostgreSQL and Redis managed by the operator, and installs into the default namespace. For a dedicated namespace, see Standard Installation.

1. Log In to the Helm Registry

Authenticate with the registry using your email and license ID:

read -rsp "License ID: " NBE_LICENSE_ID && echo
helm registry login registry.enterprise.netboxlabs.com \
  --username your-email@example.com \
  --password-stdin <<< "$NBE_LICENSE_ID"
unset NBE_LICENSE_ID

2. Install CRDs

Install the three Custom Resource Definition charts before the operator:

helm install netbox-enterprise-crds \
  oci://registry.enterprise.netboxlabs.com/netbox-enterprise/stable-v2/netbox-enterprise-crds \
  --version 2.0.1

helm install netbox-enterprise-crds-pgo \
  oci://registry.enterprise.netboxlabs.com/netbox-enterprise/stable-v2/netbox-enterprise-crds-pgo \
  --version 2.0.1

helm install netbox-enterprise-crds-redis \
  oci://registry.enterprise.netboxlabs.com/netbox-enterprise/stable-v2/netbox-enterprise-crds-redis \
  --version 2.0.1

3. Install the Chart

helm install netbox-enterprise \
  oci://registry.enterprise.netboxlabs.com/netbox-enterprise/stable-v2/netbox-enterprise \
  --version 2.0.1

4. Apply Configuration

Apply a NetBoxEnterprise resource to configure the instance. Download the standard example manifest:

kubectl apply -f https://netboxlabs.com/docs/files/helm/examples/netbox-managed.yaml

This manifest deploys NetBox with one replica, internal PostgreSQL and Redis, and Diode enabled. See the full examples index for manifests covering external databases, SSO, object storage, custom plugins, and more.

5. Wait for Readiness

Watch the operator deploy all components:

kubectl get pods

All pods should reach Running (or Completed for jobs) within a few minutes.

6. Access NetBox

Port-forward to the NetBox service:

kubectl port-forward svc/netbox-managed-netbox 8080:80

Open http://localhost:8080 in your browser.

7. Log In

The operator auto-generates a superuser account with the username admin. Retrieve the password from the generated secret:

kubectl get secret netbox-managed-netbox-superuser \
  -o jsonpath='{.data.password}' | base64 -d

Log in with admin and the password retrieved above.

Next Steps

• Standard Installation — Production-ready install with custom values, TLS, and resource tuning