Docs
HelmGuides

Private Registry

Pull NetBox Enterprise images from your own private or proxy registry instead of the NetBox Labs proxy

By default, NetBox Enterprise pulls its Helm charts from registry.enterprise.netboxlabs.com and its container images from proxy.enterprise.netboxlabs.com, and the bundled Replicated SDK provisions the image-pull secret for you (see Registry Access).

To pull every image from your own private registry instead - for example an internal Harbor that mirrors or proxies the NetBox Labs images - use the settings below. This applies to Helm installs; Embedded Cluster handles registries through the Administration Console.

Redirect operator-built images

Set spec.registry on the NetBoxEnterprise custom resource. This redirects every image the operator builds - NetBox, workers, Diode, Redis, Sentinel, and the Redis exporter - to your registry:

netboxEnterprise:
  spec:
    registry: my-registry.example.com

spec.registry replaces the registry host on each image and keeps the repository path. Mirror the images under your registry with those paths intact:

Operator imageRenders as
ghcr.io/netboxlabs/nbe-coremy-registry.example.com/netboxlabs/nbe-core
docker.io/netboxlabs/diode-ingestermy-registry.example.com/netboxlabs/diode-ingester
quay.io/opstree/redismy-registry.example.com/opstree/redis
registry.developers.crunchydata.com/crunchydata/crunchy-postgresmy-registry.example.com/crunchydata/crunchy-postgres

The registry value can include a path prefix (for example my-registry.example.com/netbox), which the operator keeps in front of each repository path.

If your registry serves everything from a single flat project rather than nested repository paths - a Harbor project, for example - add spec.registryNamespace instead. The operator then reduces each image to its name and places it directly under that one project:

netboxEnterprise:
  spec:
    registry: harbor.example.com
    registryNamespace: netbox-enterprise
Operator imageRenders as
ghcr.io/netboxlabs/nbe-coreharbor.example.com/netbox-enterprise/nbe-core
docker.io/netboxlabs/diode-ingesterharbor.example.com/netbox-enterprise/diode-ingester
quay.io/opstree/redisharbor.example.com/netbox-enterprise/redis
registry.developers.crunchydata.com/crunchydata/crunchy-postgresharbor.example.com/netbox-enterprise/crunchy-postgres

Set registry to a bare host when you use registryNamespace - a path prefix on registry stacks in front of the namespace and produces a doubled path. The image tag is unchanged in both modes. Mirror the images your deployment uses before applying these settings, or the pods fail to pull.

Per-image redis value overrides do not reach the Redis containers - the operator sets those images itself, and only spec.registry moves them.

Redirect subchart images

The operator, Redis Operator, PostgreSQL Operator (PGO), Replicated SDK, Traefik, and Keycloak operator images are deployed by the chart directly and are not covered by spec.registry. Override them in your Helm values. Traefik is deployed only with gateway.enabled, and the Keycloak operator only with idp.enabled:

ImageValues key
Operatoroperator.image.*
Redis Operatorredis-operator.redisOperator.imageName / imageTag
PGOpgo.controllerImages.* and pgo.relatedImages.*
Replicated SDKreplicated.image.*
Traefikgateway.image.*
Traefik init container (sysctl-unprivileged-ports)gateway.deployment.initContainers[0].image. Helm replaces a list as a whole, so copy the full sysctl-unprivileged-ports entry from the chart's default values and change only its image.
Keycloak operatorkeycloak-operator.image

Pull credentials

Create a secret with your registry credentials in the namespace you installed into (default for Quickstart):

kubectl -n <namespace> create secret docker-registry my-registry-creds \
  --docker-server=my-registry.example.com \
  --docker-username=<username> \
  --docker-password=<password>

Then name it in spec.imagePullSecrets. Every pod the operator creates uses it, including NetBox, the workers, Diode, PostgreSQL, Redis, and Sentinel:

netboxEnterprise:
  spec:
    imagePullSecrets:
      - my-registry-creds

spec.imagePullSecrets does not reach the images the chart deploys itself, listed in Redirect subchart images. Name the same secret in each chart pull-secret key in your Helm values:

global:
  imagePullSecrets:          # the operator and the Replicated SDK
    - name: my-registry-creds
operator:
  imagePullSecrets:          # the pre-upgrade job, only with gateway.enabled
    - name: my-registry-creds
pgo:
  imagePullSecretNames:
    - my-registry-creds
redis-operator:
  redisOperator:
    imagePullSecrets:
      - name: my-registry-creds
gateway:
  deployment:
    imagePullSecrets:        # Traefik, only with gateway.enabled
      - name: my-registry-creds
keycloak-operator:
  imagePullSecrets:          # the Keycloak operator, only with idp.enabled
    - name: my-registry-creds

Each key except keycloak-operator.imagePullSecrets replaces the chart's default list, which names the netbox-enterprise-helm-registry and netbox-enterprise-registry secrets. The Keycloak operator key starts empty ([]). If some images still pull from the NetBox Labs registries, keep those two names in the list beside yours. The Replicated SDK uses global.imagePullSecrets unless you set replicated.imagePullSecrets.

Next Steps

On this page