---
title: Charmhub | Deploy NetBox K8S Charm using Charmhub - The Open Operator Collection
description: Deploy the latest version of NetBox K8S Charm as a Kubernetes Operator
  on any cloud.
url: https://charmhub.io/netbox-k8s/docs/explanation-charm-architecture
---

# NetBox K8S Charm

[Canonical IS DevOps](https://charmhub.io/publisher/canonical-is-devops "View all packages from Canonical IS DevOps")

* [Canonical IS DevOps](https://charmhub.io/publisher/canonical-is-devops "View all packages from Canonical IS DevOps")

Platform:

4/stable 19

```
juju deploy netbox-k8s --channel 4/stable
```

[Learn to deploy on juju >](https://juju.is/docs/juju/manage-applications)

---

#### Relevant links

* [Homepage](https://github.com/canonical/netbox-k8s-operator)

---

#### Contacts

* [Submit a bug](https://github.com/canonical/netbox-k8s-operator/issues)

---

Share your thoughts on this charm with the community on discourse.

[Join the discussion](https://discourse.charmhub.io/)

# Charm architecture

The NetBox K8s charm initial version has been generated with the help of
the [paas-charm](https://github.com/canonical/paas-charm/)
project. [The paas-charm](https://github.com/canonical/paas-charm/)
project provides many of the functionalities needed by this charm like:

* PostgreSQL integration
* Redis integration
* Django migrations
* Ingress integration
* COS (Prometheus metrics and Loki logs for `gunicorn`).
* OIDC integration.
* S3 integration.

For the static assets, `gunicorn` is used with the help of the [WhiteNoiseMiddleware](https://whitenoise.readthedocs.io/en/stable/index.html).

There is only one container for each unit of NetBox K8s that runs the following
services managed by Pebble:

* `django`: runs `gunicorn`.
* `cron`: periodically runs the `housekeeping` and `syncdatasource` management commands.
* `statsd_exporter`: exposes `gunicorn` metrics.

The NetBox K8s charm is designed for a high availability (HA) environment.
The NetBox application can be scaled to more than one unit to provide
HA. See Configure Scripts and Reports for
HA for the requirements to
use scripts and reports in HA configuration.

---