Skip to main content
Enterprise

Quickstart

Get a minimal NetBox Enterprise instance running with default settings. This guide uses internal PostgreSQL and Redis managed by the operator.

1. Log In to the Helm Registry​

Authenticate with the Replicated registry using your license ID:

helm registry login registry.enterprise.netboxlabs.com \
  --username your-email@example.com \
  --password <your-license-id>

2. Create a Namespace​

kubectl create namespace netbox

3. Install the Chart​

Install with the operator and a NetBoxEnterprise resource enabled:

helm install netbox-enterprise \
  oci://registry.enterprise.netboxlabs.com/library/nbe-operator \
  --namespace netbox \
  --set netboxEnterprise.enabled=true
tip

Registry credentials and Replicated SDK configuration are automatically injected when installing through the Replicated registry. No manual global.replicated values are needed.

4. Wait for Readiness​

Watch the operator deploy all components:

kubectl -n netbox get pods -w

You should see pods for:

  • netbox-enterprise-nbe-operator-* — the operator
  • netbox-* — the NetBox application
  • netbox-worker-* — the background worker
  • postgres-cluster-* — PGO-managed PostgreSQL
  • redis-* — Redis instance

Check the NetBoxEnterprise status:

kubectl -n netbox get netboxenterprises

When the READY column shows True, your instance is running.

5. Access NetBox​

Port-forward to the NetBox service:

kubectl -n netbox port-forward svc/netbox 8080:8080

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

6. Log In​

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

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

See Superuser Configuration for full details, including how to retrieve the API token or use your own credentials.

Next Steps​