Overview¶

This Nautobot Helm Chart is used to deploy the Nautobot project in Kubernetes via Helm. This chart is intended to provide a starting point for users new to Nautobot to be able to quickly and easily deploy the stock Nautobot containers built by the Nautobot project straight to Kubernetes with as little friction as possible.

This chart is also provides a foundation for a much more complex production ready deployment of Nautobot see Advanced Features for more information.

Quick Start¶

Helm must be installed to use the charts. Please refer to Helm's documentation to get started.

Once Helm is set up properly, add the repo as follows:

helm repo add nautobot https://nautobot.github.io/helm-charts/

You can then run helm search repo nautobot to see the charts.

To install a chart from the nautobot repo run:

helm install {Release Name} {Repo Name}/{Chart Name} \
  --set postgresql.enabled=true \
  --set redis.enabled=true

for example:

helm install nautobot nautobot/nautobot \
  --set postgresql.enabled=true \
  --set redis.enabled=true

Note that the above example should only be used for development and testing purposes only. We recommend deploying an external PostgreSQL database and an external Redis instance for production and other use cases. The minimal configuration for those use cases is the following

helm install {Release Name} {Repo Name}/{Chart Name} \
    --set nautobot.db.host={Database host} \
    --set nautobot.db.user={Database username} \
    --set nautobot.db.password={Database password} \
    --set nautobot.redis.host={Redis host} \
    --set nautobot.redis.password={Redis password}

for example:

helm install nautobot nautobot/nautobot \
    --set nautobot.db.host=database.example.com \
    --set nautobot.db.user=nautobot \
    --set nautobot.db.password=changeme \
    --set nautobot.redis.host=redis.example.com \
    --set nautobot.redis.password=changeme

Check Advanced Usage for more details on how to define credentials for external databases.

Support¶

Slack: checkout the #nautobot channel on the Network to Code slack!

Contributing¶

See Contributing

Releases¶

See the Release Checklist