extern/netbox-docker
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox-docker.git synced 2025-06-09 11:36:40 +02:00
Code Issues Packages Projects Releases Wiki Activity

Updated Deployment (markdown)

Ryan Merolle 2022-01-18 11:44:37 -05:00
parent 81a0707a4a
commit 0f26910a05
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
Deployment.md

@ -1,9 +1,9 @@
**Important: Also consider [the advice about configuring Netbox for production](configuration#configure-for-production)!** **Important: Also consider [the advice about configuring NetBox for production](configuration#configure-for-production)!**
If run this image in a cluster such as Docker Swarm, Kubernetes or OpenShift, the following will come in extra handy for you. If run this image in a cluster such as Docker Swarm, Kubernetes or OpenShift, the following will come in extra handy for you.
But these techniques work equally well in the regular _docker-compose_-based approach. But these techniques work equally well in the regular _docker-compose_-based approach.
In this case, we encourage you to statically configure Netbox by starting from [Netbox's example config file][default-config], and mounting it into your container in the directory `/etc/netbox/config/` using the mechanism provided by your container platform (i.e. [Docker Swarm configs][swarm-config], [Kubernetes ConfigMap][k8s-config], [OpenShift ConfigMaps][openshift-config]). In this case, we encourage you to statically configure NetBox by starting from [NetBox's example config file][default-config], and mounting it into your container in the directory `/etc/netbox/config/` using the mechanism provided by your container platform (i.e. [Docker Swarm configs][swarm-config], [Kubernetes ConfigMap][k8s-config], [OpenShift ConfigMaps][openshift-config]).
But if you rather continue to configure your application through environment variables, you may continue to use [the built-in configuration file][docker-config]. But if you rather continue to configure your application through environment variables, you may continue to use [the built-in configuration file][docker-config].
**We discourage storing secrets in environment variables**, as environment variable are passed on to all sub-processes and may leak easily into other systems, e.g. error collecting tools that often collect all environment variables whenever an error occurs. **We discourage storing secrets in environment variables**, as environment variable are passed on to all sub-processes and may leak easily into other systems, e.g. error collecting tools that often collect all environment variables whenever an error occurs.
@ -34,7 +34,7 @@ If a secret is defined by an environment variable and in the respective file at
## _docker-compose_-based Deployments ## _docker-compose_-based Deployments
If you are about to deploy Netbox using this project's Docker image and _docker-compose_ file on a more permanent basis here you'll find some hints from our community. If you are about to deploy NetBox using this project's Docker image and _docker-compose_ file on a more permanent basis here you'll find some hints from our community.
**Please make sure you also read the [_Configure for Production_ section of the _Configuration_ wiki page](Configuration#configure-for-production). You need to change the passwords and other secrets!** **Please make sure you also read the [_Configure for Production_ section of the _Configuration_ wiki page](Configuration#configure-for-production). You need to change the passwords and other secrets!**
### Restart Policy ### Restart Policy
@ -72,7 +72,7 @@ Learn more on [the dedicated _TLS_ wiki page](https://github.com/netbox-communit
* [Helm Chart][netbox-helm] by @bootc * [Helm Chart][netbox-helm] by @bootc
* [Kubernetes objects][netbox-kubernetes] by @CENGN * [Kubernetes objects][netbox-kubernetes] by @CENGN
See also the [Community Contributions wiki page](etbox-community/netbox/wiki/Community-Contributions) of the Netbox project. See also the [Community Contributions wiki page](netbox-community/netbox/wiki/Community-Contributions) of the NetBox project.
[netbox-kubernetes]: https://github.com/CENGN/netbox-kubernetes [netbox-kubernetes]: https://github.com/CENGN/netbox-kubernetes
[netbox-helm]: https://github.com/bootc/netbox-chart [netbox-helm]: https://github.com/bootc/netbox-chart