What's New?

A large amount of the chart has been cleaned up, updated, polished, and improved, including the use of Bitnami Common for normalizing how configuration is integrated, major updates to dependent charts, and tons of small quality-of-life adjustments to the values.yaml.

It also includes a major uplift of the CI guts to automate releases, handle semver changes, and more.

Upgrade notes

NetBox has been updated to version 4.x. This chart should still work with 3.7.x as well by overriding the image, but it is not officially supported.

Potentially breaking changes

The externalDatabase.sslMode setting has been removed and replaced by an options map that can take an arbitrary number of extra PostgreSQL options.
The extraContainers setting has been renamed sidecars to match conventions.
The extraInitContainers setting has been renamed initContainers to match conventions.
The metricsEnabled setting has been renamed metrics.enabled to match conventions.
The serviceMonitor setting has been moved to metrics.serviceMonitor to match conventions.
The jobResultRetention setting has been renamed jobRetention to match the change in more recent versions of NetBox.
The remoteAuth.backend setting has been renamed remoteAuth.backends and is now an array.
The remoteAuth.autoCreateUser setting now defaults to false.
NAPALM support has been moved into a plugin since NetBox 3.5, so all NAPALM-specific configuration has been removed from this chart.
Please consult the NetBox and netbox-docker release notes in case there are any other changes that may affect your configuration.
The Bitnami PostgreSQL sub-chart was upgraded from 10.x to 15.x; please read the upstream upgrade notes if you are using the bundled PostgreSQL.
The Bitnami Redis sub-chart was upgraded from 15.x to 20.x; please read the upstream upgrade notes if you are using the bundled Redis.

Migration Guide

Caution

We still suggest moving to an external, high-availability PostgreSQL and Redis, rather than continuing to use the built-in ones in the chart which exist primarily for ease of trying out a proof-of-concept. Managing PostgreSQL and Redis separately lets you manage them and their versioning outside of the chart release cycle.

Here are the steps you can take to move from the 4.x chart running NetBox 3.2.8 (or higher), to the 5.x chart.

Back Up the PostgreSQL Database

Find the PostgreSQL pod:
```
kubectl get pods -A | grep postgres
```

Dump the database:

kubectl exec -n <namespace> <pod_name> -- \
    pg_dump --format=custom \
      -cU postgres \
      -d "dbname=netbox" \
      > /tmp/postgresql/netbox.sql

Start a New Temporary PostgreSQL

You will need a temporary PostgreSQL so you can migrate the data before switching to the newer chart.

Bring up a temporary PostgreSQL, either in your cluster using the chart of your choice (postgres-operator, Crunchy Postgres, etc.) or in another machine/VM/whatever.
PostgreSQL 16 is the highest version supported by the Bitnami chart as of this writing, so if you intend to go back to the built-in chart after migrating, that's the recommended version to work with for now.
Restore the database dump you made earlier into your new PostgreSQL.
```
pg_restore -v -Fc -c -U netbox -d netbox < /tmp/netbox.sql
```
Point NetBox at the temporary database.

Once your temporary PostgreSQL is started and accessible, update the externalDatabase section of your values.yaml to match the new database and apply it, or update them using helm upgrade:
```
helm upgrade netbox \
  --set `externalDatabase.host=your-host` \
  --set `externalDatabase.port=5432` \
  ...etc...
```

Upgrade to NetBox `3.5.9` (if starting with an older version)

If you are currently using a version older than 3.5.9, like the default value of 3.2.8 the current chart defines, then it's best to upgrade to that version first.
3.5.9 is the last release that supports the PostgreSQL 11 version that was provided with the 4.x charts.

Take note of the warning about Deletion of Legacy Data in the NetBox release notes. You must either migrate ASN and contact changes to the new model, or set NETBOX_DELETE_LEGACY_DATA in your values.yaml to allow deletion anyway.
```
extraEnvs:
  NETBOX_DELETE_LEGACY_DATA: "1"
```
Alternately, you can use helm upgrade to update the chart with new settings:
```
helm upgrade netbox --reuse-values \
  --set 'extraEnvs.NETBOX_DELETE_LEGACY_DATA=1'
```
Upgrade to NetBox 3.5.9

Update the image to the 3.5.9 tag in values.yaml:

image:
  tag: "3.5.9"

Or, you can use helm upgrade to update in-place:

helm upgrade netbox --reuse-values \
  --set 'image.tag=3.5.9'

Note

You can pass more than one --set option, so you can combine the helm options when updating:

helm upgrade netbox --reuse-values \
  --set 'extraEnvs.NETBOX_DELETE_LEGACY_DATA=1' \
  --set 'image.tag=3.5.9'

Switch to the New Chart Repository

Note

It is recommended that you upgrade to the latest version of each minor release to make sure migrations run successfully, and give enough time for the migrations to finish running before moving to the next version.
Watch your pods and confirm everything is Running before doing the next step.

Once NetBox is back up and talking to the new database, you can upgrade further until you are up-to-date.
- 3.5.9 ⇒ 3.6.9
- 3.6.9 ⇒ 3.7.8
- 3.7.8 ⇒ 4.0.11
- 4.0.11 ⇒ 4.1.8

Switch to the new chart repository.

helm upgrade netbox --reuse-values \
  oci://ghcr.io/netbox-community/netbox-chart/netbox

Caveats

Don't forget to check the potentially breaking changes up above.
You may need to re-set some values to match the new schema.

If you are using other tools alongside Helm (like ArgoCD), you might run into additional issues.
IP address management (IPAM) and data center infrastructure management (DCIM) tool

Change Log

README.md: add note about persistent storage by @bootc in #141
Create optional ServiceMonitor for Netbox by @rjhenry in #116
add examples for sso backend config by @tobikris in #112
add topologySpreadConstraints to deployment by @brycelowe in #138
Add ability to set target_session_attrs value for externalDatabase by @vriabyk in #140
Fix typo in README by @jlost in #142
Allow PodIP to be included as part of the ALLOWED_HOSTS setting by @rossigee in #167
adding support for create groups via remote authentication by @Schluggi in #159
Set the automountServiceAccountToken to false by @joachimBurket in #144
Add 'serviceAccount.imagePullSecrets' option. by @rossigee in #153
Enable bots/apps for automatic dependencies updates by @LeoColomb in #180
Bump dependabot/fetch-metadata from 2.0.0 to 2.1.0 by @dependabot in #186
Restructure as a standard chart repository by @LeoColomb in #182
Use GitHub Actions for CI & CD by @LeoColomb in #181
Fix default branch for GitHub Actions workflows by @LeoColomb in #188
Remove the unused secret variable for GHA by @LeoColomb in #189
Refresh repo meta files by @LeoColomb in #183
Only run the releaser on master branch by @LeoColomb in #190
Leverage Bitnami common chart helpers by @LeoColomb in #184
Use a template for image name by @LeoColomb in #191
Add standard namespace and metadata by @LeoColomb in #192
Bump helm/kind-action from 1.9.0 to 1.10.0 by @dependabot in #193
feat: add settings for controlling http message sizes by @sjurtf in #194
feat: enable GPG signing (ENT-12) by @RangerRick in #195
Render a proper backend definition for ingress by @LeoColomb in #198
bump to NetBox 4.0.0 by @ran...