matthew/netbox-docker
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity
ad0c04985b
netbox-docker/README.md

138 lines
6.2 KiB
Markdown
Raw Normal View History

Copied Docker components from main repo
2017-04-19 09:48:21 -05:00
# netbox-docker
Adds more labels to the Dockerfile It also updates the README and the bug_report template to reflect the changes. Additionally, in the README some relevant shields from shields.io are added. The labels follow [label-schema.org][lsorg] and the [OpenContainer image spec, section annotations][ocis], specifications. [lsorg]: http://label-schema.org/rc1/ [ocis]: https://github.com/opencontainers/image-spec/blob/master/annotations.md
2019-11-17 10:07:02 -06:00
[![GitHub release (latest by date)](https://img.shields.io/github/v/release/netbox-community/netbox-docker)][github-release]
[![GitHub stars](https://img.shields.io/github/stars/netbox-community/netbox-docker)][github-stargazers]
![GitHub closed pull requests](https://img.shields.io/github/issues-pr-closed-raw/netbox-community/netbox-docker)
Fix build status badge
2020-01-23 02:35:30 -06:00
![Github release workflow](https://img.shields.io/github/workflow/status/netbox-community/netbox-docker/release)
Adds more labels to the Dockerfile It also updates the README and the bug_report template to reflect the changes. Additionally, in the README some relevant shields from shields.io are added. The labels follow [label-schema.org][lsorg] and the [OpenContainer image spec, section annotations][ocis], specifications. [lsorg]: http://label-schema.org/rc1/ [ocis]: https://github.com/opencontainers/image-spec/blob/master/annotations.md
2019-11-17 10:07:02 -06:00
![Docker Pulls](https://img.shields.io/docker/pulls/netboxcommunity/netbox)
[![GitHub license](https://img.shields.io/github/license/netbox-community/netbox-docker)][netbox-docker-license]
NetBox should always be referred to as NetBox Fix all instances of "Netbox". ```Shell git ls-files -z . | xargs --null -I '{}' find './{}' -type f -print0 | xargs --null sed --in-place --regexp-extended 's#Netbox#NetBox#g;' ``` Ref: https://netbox.readthedocs.io/en/stable/development/style-guide/#branding
2021-02-04 14:48:08 -06:00
[The Github repository](netbox-docker-github) houses the components needed to build NetBox as a Docker container.
Add quay.io as fallback registry
2020-12-14 17:28:43 -06:00
Images are built using this code and are released to [Docker Hub][netbox-dockerhub] and [Quay.io][netbox-quayio] once a day.
❇️ Make the default configuration cluster ready This changes the default configuration to be better prepared for usage with container management platforms, such as Docker Swarm, Kubernetes or OpenShift. Closes #27.
2017-12-13 08:50:30 -06:00
Improved the README - adjust the _Quick Start_ section to match the instructions in the _Getting Started_ guide on our wiki - Adds a new _Getting Help_ section - Improvements in explaining the tags of the published Docker image
2020-03-17 10:07:15 -05:00
Do you have any questions?
Before opening an issue on Github, please join the [Network To Code][ntc-slack] Slack and ask for help in our [`#netbox-docker`][netbox-docker-slack] channel.
Update README.md
2018-09-27 02:44:14 -05:00
Adds more labels to the Dockerfile It also updates the README and the bug_report template to reflect the changes. Additionally, in the README some relevant shields from shields.io are added. The labels follow [label-schema.org][lsorg] and the [OpenContainer image spec, section annotations][ocis], specifications. [lsorg]: http://label-schema.org/rc1/ [ocis]: https://github.com/opencontainers/image-spec/blob/master/annotations.md
2019-11-17 10:07:02 -06:00
[github-stargazers]: https://github.com/netbox-community/netbox-docker/stargazers
[github-release]: https://github.com/netbox-community/netbox-docker/releases
[netbox-docker-microbadger]: https://microbadger.com/images/netboxcommunity/netbox
Add quay.io as fallback registry
2020-12-14 17:28:43 -06:00
[netbox-dockerhub]: https://hub.docker.com/r/netboxcommunity/netbox/
Adds a hyperlink for the #netbox-docker channel
2019-10-12 08:16:17 -05:00
[netbox-docker-github]: https://github.com/netbox-community/netbox-docker/
Update README.md
2018-09-27 02:44:14 -05:00
[ntc-slack]: http://slack.networktocode.com/
Adds a hyperlink for the #netbox-docker channel
2019-10-12 08:16:17 -05:00
[netbox-docker-slack]: https://slack.com/app_redirect?channel=netbox-docker&team=T09LQ7E9E
Fix link
2020-01-23 03:26:21 -06:00
[netbox-docker-license]: https://github.com/netbox-community/netbox-docker/blob/release/LICENSE
Add quay.io as fallback registry
2020-12-14 17:28:43 -06:00
[netbox-quayio]: https://quay.io/repository/netboxcommunity/netbox
Adds more labels to the Dockerfile It also updates the README and the bug_report template to reflect the changes. Additionally, in the README some relevant shields from shields.io are added. The labels follow [label-schema.org][lsorg] and the [OpenContainer image spec, section annotations][ocis], specifications. [lsorg]: http://label-schema.org/rc1/ [ocis]: https://github.com/opencontainers/image-spec/blob/master/annotations.md
2019-11-17 10:07:02 -06:00
## Docker Tags
NetBox should always be referred to as NetBox Fix all instances of "Netbox". ```Shell git ls-files -z . | xargs --null -I '{}' find './{}' -type f -print0 | xargs --null sed --in-place --regexp-extended 's#Netbox#NetBox#g;' ``` Ref: https://netbox.readthedocs.io/en/stable/development/style-guide/#branding
2021-02-04 14:48:08 -06:00
* `vX.Y.Z`: These are release builds, automatically built from [the corresponding releases of NetBox][netbox-releases].
* `latest`: These are release builds, automatically built from [the `master` branch of NetBox][netbox-master].
* `snapshot`: These are pre-release builds, automatically built from the [`develop` branch of NetBox][netbox-develop].
* `develop-X.Y`: These are pre-release builds, automatically built from the corresponding [branch of NetBox][netbox-branches].
Adds more labels to the Dockerfile It also updates the README and the bug_report template to reflect the changes. Additionally, in the README some relevant shields from shields.io are added. The labels follow [label-schema.org][lsorg] and the [OpenContainer image spec, section annotations][ocis], specifications. [lsorg]: http://label-schema.org/rc1/ [ocis]: https://github.com/opencontainers/image-spec/blob/master/annotations.md
2019-11-17 10:07:02 -06:00
Improved the README - adjust the _Quick Start_ section to match the instructions in the _Getting Started_ guide on our wiki - Adds a new _Getting Help_ section - Improvements in explaining the tags of the published Docker image
2020-03-17 10:07:15 -05:00
Then there is currently one extra tags for each of the above tags:
Adds more labels to the Dockerfile It also updates the README and the bug_report template to reflect the changes. Additionally, in the README some relevant shields from shields.io are added. The labels follow [label-schema.org][lsorg] and the [OpenContainer image spec, section annotations][ocis], specifications. [lsorg]: http://label-schema.org/rc1/ [ocis]: https://github.com/opencontainers/image-spec/blob/master/annotations.md
2019-11-17 10:07:02 -06:00
NetBox should always be referred to as NetBox Fix all instances of "Netbox". ```Shell git ls-files -z . | xargs --null -I '{}' find './{}' -type f -print0 | xargs --null sed --in-place --regexp-extended 's#Netbox#NetBox#g;' ``` Ref: https://netbox.readthedocs.io/en/stable/development/style-guide/#branding
2021-02-04 14:48:08 -06:00
* `-ldap`: Contains additional dependencies and configurations for connecting NetBox to an LDAP directory.
Adds more labels to the Dockerfile It also updates the README and the bug_report template to reflect the changes. Additionally, in the README some relevant shields from shields.io are added. The labels follow [label-schema.org][lsorg] and the [OpenContainer image spec, section annotations][ocis], specifications. [lsorg]: http://label-schema.org/rc1/ [ocis]: https://github.com/opencontainers/image-spec/blob/master/annotations.md
2019-11-17 10:07:02 -06:00
[Learn more about that in our wiki][netbox-docker-ldap].
Improved the README - adjust the _Quick Start_ section to match the instructions in the _Getting Started_ guide on our wiki - Adds a new _Getting Help_ section - Improvements in explaining the tags of the published Docker image
2020-03-17 10:07:15 -05:00
New images are built and published automatically every ~24h.
Adds more labels to the Dockerfile It also updates the README and the bug_report template to reflect the changes. Additionally, in the README some relevant shields from shields.io are added. The labels follow [label-schema.org][lsorg] and the [OpenContainer image spec, section annotations][ocis], specifications. [lsorg]: http://label-schema.org/rc1/ [ocis]: https://github.com/opencontainers/image-spec/blob/master/annotations.md
2019-11-17 10:07:02 -06:00
[netbox-releases]: https://github.com/netbox-community/netbox/releases
[netbox-master]: https://github.com/netbox-community/netbox/tree/master
[netbox-develop]: https://github.com/netbox-community/netbox/tree/develop
[netbox-branches]: https://github.com/netbox-community/netbox/branches
[netbox-docker-ldap]: https://github.com/netbox-community/netbox-docker/wiki/LDAP
Copied Docker components from main repo
2017-04-19 09:48:21 -05:00
## Quickstart
NetBox should always be referred to as NetBox Fix all instances of "Netbox". ```Shell git ls-files -z . | xargs --null -I '{}' find './{}' -type f -print0 | xargs --null sed --in-place --regexp-extended 's#Netbox#NetBox#g;' ``` Ref: https://netbox.readthedocs.io/en/stable/development/style-guide/#branding
2021-02-04 14:48:08 -06:00
To get NetBox Docker up and running run the following commands.
Improved the README - adjust the _Quick Start_ section to match the instructions in the _Getting Started_ guide on our wiki - Adds a new _Getting Help_ section - Improvements in explaining the tags of the published Docker image
2020-03-17 10:07:15 -05:00
There is a more complete [_Getting Started_ guide on our wiki][wiki-getting-started] which explains every step.
Copied Docker components from main repo
2017-04-19 09:48:21 -05:00
%s/digitalocean/netbox-community/gi Thank you Digitalocean for sponsoring Netbox! And thank you for letting it grow up and move out ;)
2019-07-02 14:32:58 -05:00
```bash
Prepares scripts and documentation for #184
2019-12-10 14:44:11 -06:00
git clone -b release https://github.com/netbox-community/netbox-docker.git
%s/digitalocean/netbox-community/gi Thank you Digitalocean for sponsoring Netbox! And thank you for letting it grow up and move out ;)
2019-07-02 14:32:58 -05:00
cd netbox-docker
Fix typo in overriding docker-compose config
2020-04-22 15:24:34 -05:00
tee docker-compose.override.yml <<EOF
Improved the README - adjust the _Quick Start_ section to match the instructions in the _Getting Started_ guide on our wiki - Adds a new _Getting Help_ section - Improvements in explaining the tags of the published Docker image
2020-03-17 10:07:15 -05:00
version: '3.4'
services:
Gunicorn is replaced with nginx-unit We now serve Netbox with an nginx-unit instance instead of Gunicorn. This allows us to get rid of the extra Nginx container because Unit is also serving the static files. The static files are now collected at container buildtime instead of every startup.
2020-11-10 08:23:07 -06:00
netbox:
Improved the README - adjust the _Quick Start_ section to match the instructions in the _Getting Started_ guide on our wiki - Adds a new _Getting Help_ section - Improvements in explaining the tags of the published Docker image
2020-03-17 10:07:15 -05:00
ports:
- 8000:8080
EOF
%s/digitalocean/netbox-community/gi Thank you Digitalocean for sponsoring Netbox! And thank you for letting it grow up and move out ;)
2019-07-02 14:32:58 -05:00
docker-compose pull
Improved the README - adjust the _Quick Start_ section to match the instructions in the _Getting Started_ guide on our wiki - Adds a new _Getting Help_ section - Improvements in explaining the tags of the published Docker image
2020-03-17 10:07:15 -05:00
docker-compose up
✏️ Overhaul of the README Plus some adjustment to the `build.sh` help text. Fixes #3
2017-09-11 08:30:52 -05:00
```
Copied Docker components from main repo
2017-04-19 09:48:21 -05:00
Improved the README - adjust the _Quick Start_ section to match the instructions in the _Getting Started_ guide on our wiki - Adds a new _Getting Help_ section - Improvements in explaining the tags of the published Docker image
2020-03-17 10:07:15 -05:00
The whole application will be available after a few minutes.
Open the URL `http://0.0.0.0:8000/` in a web-browser.
NetBox should always be referred to as NetBox Fix all instances of "Netbox". ```Shell git ls-files -z . | xargs --null -I '{}' find './{}' -type f -print0 | xargs --null sed --in-place --regexp-extended 's#Netbox#NetBox#g;' ``` Ref: https://netbox.readthedocs.io/en/stable/development/style-guide/#branding
2021-02-04 14:48:08 -06:00
You should see the NetBox homepage.
Improved the README - adjust the _Quick Start_ section to match the instructions in the _Getting Started_ guide on our wiki - Adds a new _Getting Help_ section - Improvements in explaining the tags of the published Docker image
2020-03-17 10:07:15 -05:00
In the top-right corner you can login.
Adds a link to the Getting Started wiki section to the README
2019-11-20 04:09:37 -06:00
The default credentials are:
Copied Docker components from main repo
2017-04-19 09:48:21 -05:00
* Username: **admin**
* Password: **admin**
✏️ Some README improvements in the process
2017-11-29 08:13:55 -06:00
* API Token: **0123456789abcdef0123456789abcdef01234567**
Copied Docker components from main repo
2017-04-19 09:48:21 -05:00
Adds a link to the Getting Started wiki section to the README
2019-11-20 04:09:37 -06:00
[wiki-getting-started]: https://github.com/netbox-community/netbox-docker/wiki/Getting-Started
Update README
2019-02-06 04:24:01 -06:00
[docker-reception]: https://github.com/nxt-engineering/reception
❇️ Make the default configuration cluster ready This changes the default configuration to be better prepared for usage with container management platforms, such as Docker Swarm, Kubernetes or OpenShift. Closes #27.
2017-12-13 08:50:30 -06:00
Improved the README - adjust the _Quick Start_ section to match the instructions in the _Getting Started_ guide on our wiki - Adds a new _Getting Help_ section - Improvements in explaining the tags of the published Docker image
2020-03-17 10:07:15 -05:00
## Documentation
NetBox should always be referred to as NetBox Fix all instances of "Netbox". ```Shell git ls-files -z . | xargs --null -I '{}' find './{}' -type f -print0 | xargs --null sed --in-place --regexp-extended 's#Netbox#NetBox#g;' ``` Ref: https://netbox.readthedocs.io/en/stable/development/style-guide/#branding
2021-02-04 14:48:08 -06:00
Please refer [to our wiki on Github][netbox-docker-wiki] for further information on how to use this NetBox Docker image properly.
Mention monitoring in README
2020-10-26 09:29:41 -05:00
It covers advanced topics such as using files for secrets, deployment to Kubernetes, monitoring and configuring NAPALM or LDAP.
Improved the README - adjust the _Quick Start_ section to match the instructions in the _Getting Started_ guide on our wiki - Adds a new _Getting Help_ section - Improvements in explaining the tags of the published Docker image
2020-03-17 10:07:15 -05:00
[netbox-docker-wiki]: https://github.com/netbox-community/netbox-docker/wiki/
## Getting Help
Introduce our Github Community
2020-12-14 17:50:02 -06:00
Feel free to ask questions in our [Github Community][netbox-community] or join [our Slack channel `#netbox-docker`][netbox-docker-slack] on the [Network To Code Slack][ntc-slack],
which is free to use and where there are almost always people online that can help you in the Slack channel.
Improved the README - adjust the _Quick Start_ section to match the instructions in the _Getting Started_ guide on our wiki - Adds a new _Getting Help_ section - Improvements in explaining the tags of the published Docker image
2020-03-17 10:07:15 -05:00
NetBox should always be referred to as NetBox Fix all instances of "Netbox". ```Shell git ls-files -z . | xargs --null -I '{}' find './{}' -type f -print0 | xargs --null sed --in-place --regexp-extended 's#Netbox#NetBox#g;' ``` Ref: https://netbox.readthedocs.io/en/stable/development/style-guide/#branding
2021-02-04 14:48:08 -06:00
If you need help with using NetBox or developing for it or against it's API you may find the `#netbox` channel on the same Slack instance very helpful.
Improved the README - adjust the _Quick Start_ section to match the instructions in the _Getting Started_ guide on our wiki - Adds a new _Getting Help_ section - Improvements in explaining the tags of the published Docker image
2020-03-17 10:07:15 -05:00
Introduce our Github Community
2020-12-14 17:50:02 -06:00
[netbox-community]: https://github.com/netbox-community/netbox-docker/discussions
Re-phrased the dependencies section
2017-10-16 06:09:17 -05:00
## Dependencies
Fix typo
2019-11-26 05:27:25 -06:00
This project relies only on *Docker* and *docker-compose* meeting these requirements:
Re-phrased the dependencies section
2017-10-16 06:09:17 -05:00
Move Documentation about Version to Wiki See https://github.com/netbox-community/netbox-docker/wiki/Version.
2021-02-10 05:35:06 -06:00
* The *Docker version* must be at least `19.03`.
* The *docker-compose version* must be at least `1.28.0`.
Re-phrased the dependencies section
2017-10-16 06:09:17 -05:00
Re-wording of dependencies check paragraph
2019-11-26 05:28:43 -06:00
To check the version installed on your system run `docker --version` and `docker-compose --version`.
Re-phrased the dependencies section
2017-10-16 06:09:17 -05:00
Prepare Version 0.12.0
2019-05-08 04:43:29 -05:00
## Breaking Changes
✨ Introduces a Netbox Docker project version
2018-04-04 02:44:58 -05:00
♻️ Make netbox-worker it's own container One container should ideally have one responsibility [1]. Therefore I implemented the netbox-worker to start in it's own container. This is possible, because netbox and the worker communicate via redis anyway. They still use the same image underneath, just the "command" they execute while starting different. Or in other words: I see no reason to introduce supervisord, when we already have docker-compose which can take care of running multiple processes. Also, here's another benefit: Now it's possible to view the logs of the webhook worker independently of the other netbox logs (and vice-versa). Other changes in this commit: * I don't see a reason to put a password for Redis in the docker-compose setup, so I removed it. * Slightly changed the nginx config, so that the nginx startup command becomes simpler and any error should be visible in the docker log. * Some housekeeping in the `Dockerfile`. * Added some troubleshooting advice regarding webhooks to the README. I'd like to thank Brady (@bdlamprecht [2]) here who did the harder work of figuring out what's even required to have webhooks working. [3] [1] https://docs.docker.com/develop/develop-images/dockerfile_best-practices/#decouple-applications [2] https://github.com/bdlamprecht [3] https://github.com/ninech/netbox-docker/pull/90
2018-08-13 16:04:09 -05:00
From time to time it might become necessary to re-engineer the structure of this setup.
Things like the `docker-compose.yml` file or your Kubernetes or OpenShift configurations have to be adjusted as a consequence.
Remove references to the old build system
2020-01-23 03:36:13 -06:00
Adds more labels to the Dockerfile It also updates the README and the bug_report template to reflect the changes. Additionally, in the README some relevant shields from shields.io are added. The labels follow [label-schema.org][lsorg] and the [OpenContainer image spec, section annotations][ocis], specifications. [lsorg]: http://label-schema.org/rc1/ [ocis]: https://github.com/opencontainers/image-spec/blob/master/annotations.md
2019-11-17 10:07:02 -06:00
Since November 2019 each image built from this repo contains a `org.opencontainers.image.version` label.
(The images contained labels since April 2018, although in November 2019 the labels' names changed.)
Remove references to the old build system
2020-01-23 03:36:13 -06:00
You can check the label of your local image by running `docker inspect netboxcommunity/netbox:v2.7.1 --format "{{json .Config.Labels}}"`.
Move large parts of the documentation in the README to the wiki
2019-10-09 05:36:26 -05:00
Please read [the release notes][releases] carefully when updating to a new image version.
[releases]: https://github.com/netbox-community/netbox-docker/releases
Update references to netboxcommunity
2019-02-06 04:46:20 -06:00
Remove references to the old build system
2020-01-23 03:36:13 -06:00
## Rebuilding the Image
✏️ Overhaul of the README Plus some adjustment to the `build.sh` help text. Fixes #3
2017-09-11 08:30:52 -05:00
Update README
2019-02-06 04:24:01 -06:00
`./build.sh` can be used to rebuild the Docker image. See `./build.sh --help` for more information.
🐳 Adds a sample on how to run netbox tests
2017-08-30 04:10:55 -05:00
Remove references to the old build system
2020-01-23 03:36:13 -06:00
For more details on custom builds [consult our wiki][netbox-docker-wiki-build].
[netbox-docker-wiki-build]: https://github.com/netbox-community/netbox-docker/wiki/Build
♻️ Make netbox-worker it's own container One container should ideally have one responsibility [1]. Therefore I implemented the netbox-worker to start in it's own container. This is possible, because netbox and the worker communicate via redis anyway. They still use the same image underneath, just the "command" they execute while starting different. Or in other words: I see no reason to introduce supervisord, when we already have docker-compose which can take care of running multiple processes. Also, here's another benefit: Now it's possible to view the logs of the webhook worker independently of the other netbox logs (and vice-versa). Other changes in this commit: * I don't see a reason to put a password for Redis in the docker-compose setup, so I removed it. * Slightly changed the nginx config, so that the nginx startup command becomes simpler and any error should be visible in the docker log. * Some housekeeping in the `Dockerfile`. * Added some troubleshooting advice regarding webhooks to the README. I'd like to thank Brady (@bdlamprecht [2]) here who did the harder work of figuring out what's even required to have webhooks working. [3] [1] https://docs.docker.com/develop/develop-images/dockerfile_best-practices/#decouple-applications [2] https://github.com/bdlamprecht [3] https://github.com/ninech/netbox-docker/pull/90
2018-08-13 16:04:09 -05:00
🐳 Adds a sample on how to run netbox tests
2017-08-30 04:10:55 -05:00
## Tests
Remove references to the old build system
2020-01-23 03:36:13 -06:00
We have a test script.
NetBox should always be referred to as NetBox Fix all instances of "Netbox". ```Shell git ls-files -z . | xargs --null -I '{}' find './{}' -type f -print0 | xargs --null sed --in-place --regexp-extended 's#Netbox#NetBox#g;' ``` Ref: https://netbox.readthedocs.io/en/stable/development/style-guide/#branding
2021-02-04 14:48:08 -06:00
It runs NetBox's own unit tests and ensures that all initializers work:
🐳 Adds a sample on how to run netbox tests
2017-08-30 04:10:55 -05:00
%s/digitalocean/netbox-community/gi Thank you Digitalocean for sponsoring Netbox! And thank you for letting it grow up and move out ;)
2019-07-02 14:32:58 -05:00
```bash
Remove references to the old build system
2020-01-23 03:36:13 -06:00
IMAGE=netboxcommunity/netbox:latest ./test.sh
🐳 Adds a sample on how to run netbox tests
2017-08-30 04:10:55 -05:00
```
✏️ Overhaul of the README Plus some adjustment to the `build.sh` help text. Fixes #3
2017-09-11 08:30:52 -05:00
## About
Update references to netboxcommunity
2019-02-06 04:46:20 -06:00
This repository is currently maintained and funded by [nxt][nxt].
[nxt]: https://nxt.engineering/en/
Reference in New Issue Copy Permalink