avalonhawk / netbox-docker

🐳 Docker Image of NetBox

netbox-docker for EVE-NG

[][github-release] [][github-stargazers] [][netbox-docker-microbadger] [][netbox-docker-microbadger] [][netbox-docker-license]

The Github repository houses the components needed to build Netbox as a Docker container.

Do you have any questions? Please reach out to Knox Hutchinson https://Twitter.com/Data_Knox [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 [netbox-dockerhub]: https://hub.docker.com/r/netboxcommunity/netbox/tags/ [netbox-docker-github]: https://github.com/netbox-community/netbox-docker/ [ntc-slack]: http://slack.networktocode.com/ [netbox-docker-slack]: https://slack.com/app_redirect?channel=netbox-docker&team=T09LQ7E9E [netbox-docker-license]: https://github.com/netbox-community/netbox-docker/blob/release/LICENSE

Docker Tags

• vX.Y.Z: These are release builds, automatically built from the corresponding releases of Netbox.
• latest: These are release builds, automatically built from the master branch of Netbox.
• snapshot: These are pre-release builds, automatically built from the develop branch of Netbox.
• develop-X.Y: These are pre-release builds, automatically built from the corresponding branch of Netbox.

Then there is currently one extra tags for each of the above tags:

• -ldap: Contains additional dependencies and configurations for connecting Netbox to an LDAP directory. Learn more about that in our wiki.

New images are built and published automatically every ~24h.

Quickstart

EVE-NG Users

1. First make sure that the docker-in-docker container is installed

apt update
apt install eve-ng-dind

2. Create a new lab

3. Add the DinD node to the lab.

• Edit the node and check the box allowing DHCP on the eth0 interface
• Set the console to Telnet

4. Add an outbound network to the lab (Management Cloud0 or NAT)

5. Connect the node to the cloud

6. Turn on the node

7. Connect to the console

8. Run the following commands

git clone -b release https://github.com/DataKnox/netbox-docker.git
cd netbox-docker
docker-compose pull
docker-compose up

9. Run ip addr to see what the IP address of the node is

• If using cloud0, wait a few minutes for Netbox to start and connect to the device http://IPADD:8000
• If using NAT, add another container like Firefox to the topology, enable DHCP on the container, and access the address like above

10. SSH into EVE-NG

11. Run the following command

dc ps -a

• You should see your DinD container running
• Copy the Container ID

12. Stop BUT DO NOT Wipe the container in the topology

13. Run the following command in the EVE-NG terminal

dc commit <CONTAINER-ID-GOES-HERE> eve-netbox

• this will take several minutes because Netbox is over 5GB

14. You now have Netbox in EVE-NG

Regular

To get Netbox Docker up and running run the following commands. There is a more complete Getting Started guide on our wiki which explains every step.

git clone -b release https://github.com/netbox-community/netbox-docker.git
cd netbox-docker
tee docker-compose.override.yml <<EOF
version: '3.4'
services:
  nginx:
    ports:
      - 8000:8080
EOF
docker-compose pull
docker-compose up

The whole application will be available after a few minutes. Open the URL http://0.0.0.0:8000/ in a web-browser. You should see the Netbox homepage. In the top-right corner you can login. The default credentials are:

• Username: admin
• Password: admin
• API Token: 0123456789abcdef0123456789abcdef01234567

Documentation

Please refer to our wiki on Github for further information on how to use this Netbox Docker image properly. It covers advanced topics such as using files for secrets, deployment to Kubernetes, monitoring and configuring NAPALM or LDAP.

Getting Help

Please join [our Slack channel #netbox-docker][netbox-docker-slack] on the [Network To Code Slack][ntc-slack]. It's free to use and there are almost always people online that can help.

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.

Dependencies

This project relies only on Docker and docker-compose meeting these requirements:

• The Docker version must be at least 17.05.
• The docker-compose version must be at least 1.17.0.

To check the version installed on your system run docker --version and docker-compose --version.

Use a Specific Netbox Version

The docker-compose.yml file is prepared to run a specific version of Netbox, instead of latest. To use this feature, set and export the environment-variable VERSION before launching docker-compose, as shown below. VERSION may be set to the name of [any tag of the netboxcommunity/netbox Docker image on Docker Hub][netbox-dockerhub].

export VERSION=v2.7.1
docker-compose pull netbox
docker-compose up -d

You can also build a specific version of the Netbox Docker image yourself. VERSION can be any valid git ref in that case.

export VERSION=v2.7.1
./build.sh $VERSION
docker-compose up -d

Breaking Changes

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.

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.) You can check the label of your local image by running docker inspect netboxcommunity/netbox:v2.7.1 --format "{{json .Config.Labels}}".

Please read the release notes carefully when updating to a new image version.

Rebuilding the Image

./build.sh can be used to rebuild the Docker image. See ./build.sh --help for more information.

For more details on custom builds consult our wiki.

Tests

We have a test script. It runs Netbox's own unit tests and ensures that all initializers work:

IMAGE=netboxcommunity/netbox:latest ./test.sh

About

This repository is currently maintained and funded by nxt.