matthew/netbox-docker
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity
fd87c7cb98
netbox-docker/Dockerfile

126 lines
4.1 KiB
Docker
Raw Normal View History

Refactor to multistage builds This commit introduces a huge change in the build process. What changed: - Dockerfile.ldap was integrated into Dockerfile as a seperate [build stage][multistage-build]. - All the build scripts were refactored according to this. - The `docker-compose.yml` file was adjusted likewise. - The main build script, `/build.sh`, now always builds all targets (formerly called variants). - The minimal requirements for Docker and docker-compose have increased. - The build on hub.docker.com must be adjusted. This change should also fix #156 permanently. [multistage-build]: https://docs.docker.com/develop/develop-images/multistage-build/
2019-10-10 05:42:10 -05:00
ARG FROM=python:3.7-alpine
externalize netbox download with wget
2019-10-13 09:00:42 -05:00
FROM ${FROM} as builder
Copied Docker components from main repo
2017-04-19 09:48:21 -05:00
Reworked the Dockerfile with alpinelinux
2017-04-21 06:45:34 -05:00
RUN apk add --no-cache \
bash \
build-base \
ca-certificates \
cyrus-sasl-dev \
graphviz \
jpeg-dev \
externalize netbox download with wget
2019-10-13 09:00:42 -05:00
libevent-dev \
Reworked the Dockerfile with alpinelinux
2017-04-21 06:45:34 -05:00
libffi-dev \
libxslt-dev \
openldap-dev \
externalize netbox download with wget
2019-10-13 09:00:42 -05:00
postgresql-dev
WORKDIR /install
🔼 Introduces a more recent gunicorn
2017-08-30 04:08:21 -05:00
Optimize pip install command As mentioned by @sdktr the "--install-option" is redundant. The added "--no-warn-script-location" is used to silence warnings when installing into a directory that is not on $PATH.
2019-10-31 04:11:33 -05:00
RUN pip install --prefix="/install" --no-warn-script-location \
✨ Include Initializers Initializers are startup scripts for common tasks like creating custom fields. These are problems many users of Netbox Docker potentially face and are therefore worth sharing.
2018-02-16 03:25:26 -06:00
# gunicorn is used for launching netbox
Revert "Fix #179 'libc not found'" This reverts commit feb810ab27bf459a54a3e2055e7c399ed478f1f5.
2019-11-26 04:40:10 -06:00
gunicorn \
externalize netbox download with wget
2019-10-13 09:00:42 -05:00
greenlet \
eventlet \
Adding in support for NAPALM
2018-03-05 18:56:18 -06:00
# napalm is used for gathering information from network devices
napalm \
✨ Include Initializers Initializers are startup scripts for common tasks like creating custom fields. These are problems many users of Netbox Docker potentially face and are therefore worth sharing.
2018-02-16 03:25:26 -06:00
# ruamel is used in startup_scripts
fix AttributeError for ruamel.yaml
2019-07-30 06:09:02 -05:00
'ruamel.yaml>=0.15,<0.16' \
externalize netbox download with wget
2019-10-13 09:00:42 -05:00
# django_auth_ldap is required for ldap
Prepare for Netbox 2.7
2019-12-16 05:51:59 -06:00
django_auth_ldap \
# django-storages was introduced in 2.7 and is optional
django-storages
externalize netbox download with wget
2019-10-13 09:00:42 -05:00
Checkout the repository with git This changes the build process even further. Instead f using `wget` to fetch the current code, `git` is used. This allows for faster switching between branches, because only the differences between them have to be fetched from the server. But the main advantage is that the build cache can finally be used as designed by Docker. Repetitive builds are very fast now. This is also true between branches and tags, as long as the `requirements.txt` file doesn't change.
2019-10-14 14:54:49 -05:00
ARG NETBOX_PATH
COPY ${NETBOX_PATH}/requirements.txt /
Optimize pip install command As mentioned by @sdktr the "--install-option" is redundant. The added "--no-warn-script-location" is used to silence warnings when installing into a directory that is not on $PATH.
2019-10-31 04:11:33 -05:00
RUN pip install --prefix="/install" --no-warn-script-location -r /requirements.txt
externalize netbox download with wget
2019-10-13 09:00:42 -05:00
###
# Main stage
###
ARG FROM
FROM ${FROM} as main
RUN apk add --no-cache \
bash \
ca-certificates \
graphviz \
libevent \
libffi \
libjpeg-turbo \
libressl \
libxslt \
postgresql-libs \
ttf-ubuntu-font-family
Adding REF to GitHub repo HEAD for cache busting After installing requirements, check if HEAD has changed and bust cache for RUN instruction for wget archive
2019-05-23 10:20:39 -05:00
Explain caching strategy in Dockerfile comments
2019-06-12 10:53:35 -05:00
WORKDIR /opt
externalize netbox download with wget
2019-10-13 09:00:42 -05:00
COPY --from=builder /install /usr/local
Checkout the repository with git This changes the build process even further. Instead f using `wget` to fetch the current code, `git` is used. This allows for faster switching between branches, because only the differences between them have to be fetched from the server. But the main advantage is that the build cache can finally be used as designed by Docker. Repetitive builds are very fast now. This is also true between branches and tags, as long as the `requirements.txt` file doesn't change.
2019-10-14 14:54:49 -05:00
ARG NETBOX_PATH
COPY ${NETBOX_PATH} /opt/netbox
Reworked the Dockerfile with alpinelinux
2017-04-21 06:45:34 -05:00
🐞 The upstream repo remove the docker config .. so I copied it over to this repo.
2017-10-13 03:10:43 -05:00
COPY docker/configuration.docker.py /opt/netbox/netbox/netbox/configuration.py
Move config to /etc/netbox/config (Fixes #54) With this the configuration is moved to /etc/netbox/config and the default reports directory is set to /etc/netbox/reports. This enables the user to mount reports from a config map or persistent volume in OpenShift.
2018-04-03 02:02:19 -05:00
COPY configuration/gunicorn_config.py /etc/netbox/config/
Added nginx.conf netbox image Without it, the nginx container of the docker-compose.yml refuses to start.
2017-05-09 03:12:36 -05:00
COPY docker/nginx.conf /etc/netbox-nginx/nginx.conf
Explain caching strategy in Dockerfile comments
2019-06-12 10:53:35 -05:00
COPY docker/docker-entrypoint.sh /opt/netbox/docker-entrypoint.sh
🐞 Be More Explicit On Paths
2018-02-16 03:49:34 -06:00
COPY startup_scripts/ /opt/netbox/startup_scripts/
COPY initializers/ /opt/netbox/initializers/
Move config to /etc/netbox/config (Fixes #54) With this the configuration is moved to /etc/netbox/config and the default reports directory is set to /etc/netbox/reports. This enables the user to mount reports from a config map or persistent volume in OpenShift.
2018-04-03 02:02:19 -05:00
COPY configuration/configuration.py /etc/netbox/config/configuration.py
Copied Docker components from main repo
2017-04-19 09:48:21 -05:00
🐳 Change to the actual workdir
2017-08-30 04:09:24 -05:00
WORKDIR /opt/netbox/netbox
Adds netbox user
2019-11-17 11:03:59 -06:00
# Must set permissions for '/opt/netbox/netbox/static' directory
Remove the named user, change permissions to 'g+w'
2019-11-18 01:23:44 -06:00
# to g+w so that `./manage.py collectstatic` can be executed during
Adds netbox user
2019-11-17 11:03:59 -06:00
# container startup.
Remove the named user, change permissions to 'g+w'
2019-11-18 01:23:44 -06:00
# Must set permissions for '/opt/netbox/netbox/media' directory
# to g+w so that pictures can be uploaded to netbox.
Dockerfile: Fixed file permissions for media
2020-04-18 09:08:42 -05:00
RUN mkdir static && chmod -R g+w static media
Adds netbox user
2019-11-17 11:03:59 -06:00
✨ Include Initializers Initializers are startup scripts for common tasks like creating custom fields. These are problems many users of Netbox Docker potentially face and are therefore worth sharing.
2018-02-16 03:25:26 -06:00
ENTRYPOINT [ "/opt/netbox/docker-entrypoint.sh" ]
Copied Docker components from main repo
2017-04-19 09:48:21 -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
CMD ["gunicorn", "-c /etc/netbox/config/gunicorn_config.py", "netbox.wsgi"]
❇️ Adds new options to the build script
2018-02-02 05:48:38 -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
LABEL ORIGINAL_TAG="" \
NETBOX_GIT_BRANCH="" \
NETBOX_GIT_REF="" \
NETBOX_GIT_URL="" \
# See http://label-schema.org/rc1/#build-time-labels
# Also https://microbadger.com/labels
org.label-schema.schema-version="1.0" \
org.label-schema.build-date="" \
org.label-schema.name="Netbox Docker" \
org.label-schema.description="A container based distribution of Netbox, the free and open IPAM and DCIM solution." \
org.label-schema.vendor="The netbox-docker contributors." \
org.label-schema.url="https://github.com/netbox-community/netbox-docker" \
org.label-schema.usage="https://github.com/netbox-community/netbox-docker/wiki" \
org.label-schema.vcs-url="https://github.com/netbox-community/netbox-docker.git" \
org.label-schema.vcs-ref="" \
org.label-schema.version="snapshot" \
# See https://github.com/opencontainers/image-spec/blob/master/annotations.md#pre-defined-annotation-keys
org.opencontainers.image.created="" \
org.opencontainers.image.title="Netbox Docker" \
org.opencontainers.image.description="A container based distribution of Netbox, the free and open IPAM and DCIM solution." \
org.opencontainers.image.licenses="Apache-2.0" \
org.opencontainers.image.authors="The netbox-docker contributors." \
org.opencontainers.image.vendor="The netbox-docker contributors." \
org.opencontainers.image.url="https://github.com/netbox-community/netbox-docker" \
org.opencontainers.image.documentation="https://github.com/netbox-community/netbox-docker/wiki" \
org.opencontainers.image.source="https://github.com/netbox-community/netbox-docker.git" \
org.opencontainers.image.revision="" \
org.opencontainers.image.version="snapshot"
externalize netbox download with wget
2019-10-13 09:00:42 -05:00
Refactor to multistage builds This commit introduces a huge change in the build process. What changed: - Dockerfile.ldap was integrated into Dockerfile as a seperate [build stage][multistage-build]. - All the build scripts were refactored according to this. - The `docker-compose.yml` file was adjusted likewise. - The main build script, `/build.sh`, now always builds all targets (formerly called variants). - The minimal requirements for Docker and docker-compose have increased. - The build on hub.docker.com must be adjusted. This change should also fix #156 permanently. [multistage-build]: https://docs.docker.com/develop/develop-images/multistage-build/
2019-10-10 05:42:10 -05:00
#####
externalize netbox download with wget
2019-10-13 09:00:42 -05:00
## LDAP specific configuration
Refactor to multistage builds This commit introduces a huge change in the build process. What changed: - Dockerfile.ldap was integrated into Dockerfile as a seperate [build stage][multistage-build]. - All the build scripts were refactored according to this. - The `docker-compose.yml` file was adjusted likewise. - The main build script, `/build.sh`, now always builds all targets (formerly called variants). - The minimal requirements for Docker and docker-compose have increased. - The build on hub.docker.com must be adjusted. This change should also fix #156 permanently. [multistage-build]: https://docs.docker.com/develop/develop-images/multistage-build/
2019-10-10 05:42:10 -05:00
#####
FROM main as ldap
externalize netbox download with wget
2019-10-13 09:00:42 -05:00
RUN apk add --no-cache \
libsasl \
libldap \
util-linux
Refactor to multistage builds This commit introduces a huge change in the build process. What changed: - Dockerfile.ldap was integrated into Dockerfile as a seperate [build stage][multistage-build]. - All the build scripts were refactored according to this. - The `docker-compose.yml` file was adjusted likewise. - The main build script, `/build.sh`, now always builds all targets (formerly called variants). - The minimal requirements for Docker and docker-compose have increased. - The build on hub.docker.com must be adjusted. This change should also fix #156 permanently. [multistage-build]: https://docs.docker.com/develop/develop-images/multistage-build/
2019-10-10 05:42:10 -05:00
COPY docker/ldap_config.docker.py /opt/netbox/netbox/netbox/ldap_config.py
COPY configuration/ldap_config.py /etc/netbox/config/ldap_config.py
Reference in New Issue Copy Permalink