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

148 lines
4.7 KiB
Docker
Raw Normal View History

Add checks to verifiy if a new build is needed This checks if the source materials (python image, Netbox commit, netbox-docker commit) have changed since the last build. This check is done by comparing the digest and commit ids from the previous image with the given tag to the current values taken from the Git and Docker repositories. The checks are only performed for builds by the automated builds on Github.
2020-04-08 15:45:56 +02:00
ARG FROM
externalize netbox download with wget
2019-10-13 16:00:42 +02:00
FROM ${FROM} as builder
Copied Docker components from main repo
2017-04-19 16:48:21 +02:00
Reworked the Dockerfile with alpinelinux
2017-04-21 13:45:34 +02:00
RUN apk add --no-cache \
bash \
build-base \
Fix building cryptography pip
2021-02-08 09:02:14 +01:00
cargo \
Reworked the Dockerfile with alpinelinux
2017-04-21 13:45:34 +02:00
ca-certificates \
Improves google-cloud-storage performance And also fixes the build by providing a 'alpine version' of the google/crc32c library, which google-crc32c and google-cloud-storage and ultimately django-storages[google] depend on.
2021-09-03 09:15:41 +02:00
cmake \
Reworked the Dockerfile with alpinelinux
2017-04-21 13:45:34 +02:00
cyrus-sasl-dev \
Improves google-cloud-storage performance And also fixes the build by providing a 'alpine version' of the google/crc32c library, which google-crc32c and google-cloud-storage and ultimately django-storages[google] depend on.
2021-09-03 09:15:41 +02:00
git \
Reworked the Dockerfile with alpinelinux
2017-04-21 13:45:34 +02:00
graphviz \
jpeg-dev \
externalize netbox download with wget
2019-10-13 16:00:42 +02:00
libevent-dev \
Reworked the Dockerfile with alpinelinux
2017-04-21 13:45:34 +02:00
libffi-dev \
libxslt-dev \
Improves google-cloud-storage performance And also fixes the build by providing a 'alpine version' of the google/crc32c library, which google-crc32c and google-cloud-storage and ultimately django-storages[google] depend on.
2021-09-03 09:15:41 +02:00
make \
Fix building cryptography pip
2021-02-08 09:02:14 +01:00
musl-dev \
Reworked the Dockerfile with alpinelinux
2017-04-21 13:45:34 +02:00
openldap-dev \
Improves google-cloud-storage performance And also fixes the build by providing a 'alpine version' of the google/crc32c library, which google-crc32c and google-cloud-storage and ultimately django-storages[google] depend on.
2021-09-03 09:15:41 +02:00
openssl-dev \
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 15:23:07 +01:00
postgresql-dev \
py3-pip \
python3-dev \
Use black as formatter for python files
2021-02-08 11:59:33 +01:00
&& python3 -m venv /opt/netbox/venv \
&& /opt/netbox/venv/bin/python3 -m pip install --upgrade \
Fix building cryptography pip
2021-02-08 09:02:14 +01:00
pip \
setuptools \
wheel
externalize netbox download with wget
2019-10-13 16:00:42 +02:00
Improves google-cloud-storage performance And also fixes the build by providing a 'alpine version' of the google/crc32c library, which google-crc32c and google-cloud-storage and ultimately django-storages[google] depend on.
2021-09-03 09:15:41 +02:00
# Build libcrc32c for google-crc32c python module
RUN git clone https://github.com/google/crc32c \
&& cd crc32c \
&& git submodule update --init --recursive \
&& mkdir build \
&& cd build \
&& cmake \
-DCMAKE_BUILD_TYPE=Release \
-DCRC32C_BUILD_TESTS=no \
-DCRC32C_BUILD_BENCHMARKS=no \
-DBUILD_SHARED_LIBS=yes \
.. \
&& make all install
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 21:54:49 +02:00
ARG NETBOX_PATH
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 15:23:07 +01:00
COPY ${NETBOX_PATH}/requirements.txt requirements-container.txt /
Fix building cryptography pip
2021-02-08 09:02:14 +01:00
RUN /opt/netbox/venv/bin/pip install \
-r /requirements.txt \
-r /requirements-container.txt
externalize netbox download with wget
2019-10-13 16:00:42 +02:00
###
# Main stage
###
ARG FROM
FROM ${FROM} as main
RUN apk add --no-cache \
bash \
ca-certificates \
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 15:23:07 +01:00
curl \
externalize netbox download with wget
2019-10-13 16:00:42 +02:00
graphviz \
libevent \
libffi \
libjpeg-turbo \
libxslt \
Added container for Netbox housekeeping command Adds an additional container in which the new "housekeeping" command from Netbox v3.0.0 is run.
2021-09-03 12:48:30 +02:00
openssl \
externalize netbox download with wget
2019-10-13 16:00:42 +02:00
postgresql-libs \
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 15:23:07 +01:00
py3-pip \
Added container for Netbox housekeeping command Adds an additional container in which the new "housekeeping" command from Netbox v3.0.0 is run.
2021-09-03 12:48:30 +02:00
python3 \
tini \
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 15:23:07 +01:00
unit \
unit-python3
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 17:20:39 +02:00
Explain caching strategy in Dockerfile comments
2019-06-12 17:53:35 +02:00
WORKDIR /opt
Improves google-cloud-storage performance And also fixes the build by providing a 'alpine version' of the google/crc32c library, which google-crc32c and google-cloud-storage and ultimately django-storages[google] depend on.
2021-09-03 09:15:41 +02:00
COPY --from=builder /usr/local/lib/libcrc32c.* /usr/local/lib/
COPY --from=builder /usr/local/include/crc32c /usr/local/include
COPY --from=builder /usr/local/lib/cmake/Crc32c /usr/local/lib/cmake/
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 15:23:07 +01:00
COPY --from=builder /opt/netbox/venv /opt/netbox/venv
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 21:54:49 +02:00
ARG NETBOX_PATH
COPY ${NETBOX_PATH} /opt/netbox
Reworked the Dockerfile with alpinelinux
2017-04-21 13:45:34 +02:00
🐞 The upstream repo remove the docker config .. so I copied it over to this repo.
2017-10-13 10:10:43 +02:00
COPY docker/configuration.docker.py /opt/netbox/netbox/netbox/configuration.py
Explain caching strategy in Dockerfile comments
2019-06-12 17:53:35 +02:00
COPY docker/docker-entrypoint.sh /opt/netbox/docker-entrypoint.sh
Added container for Netbox housekeeping command Adds an additional container in which the new "housekeeping" command from Netbox v3.0.0 is run.
2021-09-03 12:48:30 +02:00
COPY docker/housekeeping.sh /opt/netbox/housekeeping.sh
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 15:23:07 +01:00
COPY docker/launch-netbox.sh /opt/netbox/launch-netbox.sh
🐞 Be More Explicit On Paths
2018-02-16 10:49:34 +01:00
COPY startup_scripts/ /opt/netbox/startup_scripts/
COPY initializers/ /opt/netbox/initializers/
Dynamically load configuration files
2020-10-18 02:34:45 +02:00
COPY configuration/ /etc/netbox/config/
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 15:23:07 +01:00
COPY docker/nginx-unit.json /etc/unit/
Copied Docker components from main repo
2017-04-19 16:48:21 +02:00
🐳 Change to the actual workdir
2017-08-30 11:09:24 +02:00
WORKDIR /opt/netbox/netbox
Remove the named user, change permissions to 'g+w'
2019-11-18 08:23:44 +01:00
# Must set permissions for '/opt/netbox/netbox/media' directory
# to g+w so that pictures can be uploaded to netbox.
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 15:23:07 +01:00
RUN mkdir -p static /opt/unit/state/ /opt/unit/tmp/ \
&& chmod -R g+w media /opt/unit/ \
Build documentation files in the image
2021-07-21 09:58:27 +02:00
&& cd /opt/netbox/ && /opt/netbox/venv/bin/python -m mkdocs build \
--config-file /opt/netbox/mkdocs.yml --site-dir /opt/netbox/netbox/project-static/docs/ \
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 15:23:07 +01:00
&& SECRET_KEY="dummy" /opt/netbox/venv/bin/python /opt/netbox/netbox/manage.py collectstatic --no-input
Adds netbox user
2019-11-17 18:03:59 +01: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 10:25:26 +01:00
ENTRYPOINT [ "/opt/netbox/docker-entrypoint.sh" ]
Copied Docker components from main repo
2017-04-19 16:48:21 +02:00
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 15:23:07 +01:00
CMD [ "/opt/netbox/launch-netbox.sh" ]
❇️ Adds new options to the build script
2018-02-02 12:48:38 +01: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 17:07:02 +01: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="" \
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 21:48:08 +01:00
org.label-schema.name="NetBox Docker" \
org.label-schema.description="A container based distribution of NetBox, the free and open IPAM and DCIM solution." \
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 17:07:02 +01:00
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="" \
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 21:48:08 +01:00
org.opencontainers.image.title="NetBox Docker" \
org.opencontainers.image.description="A container based distribution of NetBox, the free and open IPAM and DCIM solution." \
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 17:07:02 +01:00
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 16:00:42 +02: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 12:42:10 +02:00
#####
externalize netbox download with wget
2019-10-13 16:00:42 +02: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 12:42:10 +02:00
#####
FROM main as ldap
externalize netbox download with wget
2019-10-13 16:00:42 +02: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 12:42:10 +02:00
COPY docker/ldap_config.docker.py /opt/netbox/netbox/netbox/ldap_config.py