netbox-k8s docs: Charm Architecture

charm
1

Charm architecture

The NetBox charm initial version has been generated with the help of the paas-charm project. The 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).
  • SAML integration.
  • S3 integration.

For the static assets, gunicorn is used with the help of the WhiteNoiseMiddleware.

There is only one container for each unit of NetBox 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 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.