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

123 lines
4.5 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 08:45:56 -05:00
ARG FROM
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
First version of Debian based image
2021-08-31 03:57:37 -05:00
RUN export DEBIAN_FRONTEND=noninteractive \
&& apt-get update -qq \
Changed the ignored warnings
2022-06-15 02:04:00 -05:00
&& apt-get upgrade \
--yes -qq --no-install-recommends \
&& apt-get install \
--yes -qq --no-install-recommends \
First version of Debian based image
2021-08-31 03:57:37 -05:00
build-essential \
Reworked the Dockerfile with alpinelinux
2017-04-21 06:45:34 -05:00
ca-certificates \
First version of Debian based image
2021-08-31 03:57:37 -05:00
libldap-dev \
Added psycopg2 as additionnal dependency With psycopg2-binary the images doesn't work on ARM64.
2022-06-10 03:38:21 -05:00
libpq-dev \
First version of Debian based image
2021-08-31 03:57:37 -05:00
libsasl2-dev \
Added psycopg2 as additionnal dependency With psycopg2-binary the images doesn't work on ARM64.
2022-06-10 03:38:21 -05:00
libssl-dev \
Enable SAML & OPENIDCONNECT for social-auth-core
2022-10-31 10:00:18 -05:00
libxml2-dev \
libxmlsec1 \
libxmlsec1-dev \
libxmlsec1-openssl \
libxslt-dev \
pkg-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 08:23:07 -06:00
python3-dev \
First version of Debian based image
2021-08-31 03:57:37 -05:00
python3-pip \
python3-venv \
&& python3 -m venv /opt/netbox/venv \
&& /opt/netbox/venv/bin/python3 -m pip install --upgrade \
Fix building cryptography pip
2021-02-08 02:02:14 -06:00
pip \
setuptools \
wheel
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
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
COPY ${NETBOX_PATH}/requirements.txt requirements-container.txt /
Fixed version conflicts for social-auth-core
2023-04-06 02:52:28 -05:00
RUN sed -i -e '/psycopg2-binary/d' /requirements.txt && \
# We need 'social-auth-core[all]' in the Docker image. But if we put it in our own requirements-container.txt
# we have potential version conflicts and the build will fail.
# That's why we just replace it in the original requirements.txt.
sed -i -e 's/social-auth-core\[openidconnect\]/social-auth-core\[all\]/g' /requirements.txt && \
Optimize psycopg2 dependency We have beeing installing psycopg2 for a while now. This updates to the latest version. Because psycopg2-binary is a direct dependency of Netbox both versions were installled. Now we remove the pre-compiled version from the dependency file.
2022-11-30 07:36:53 -06:00
/opt/netbox/venv/bin/pip install \
Fix building cryptography pip
2021-02-08 02:02:14 -06:00
-r /requirements.txt \
-r /requirements-container.txt
externalize netbox download with wget
2019-10-13 09:00:42 -05:00
###
# Main stage
###
ARG FROM
FROM ${FROM} as main
First version of Debian based image
2021-08-31 03:57:37 -05:00
RUN export DEBIAN_FRONTEND=noninteractive \
&& apt-get update -qq \
&& apt-get upgrade \
--yes -qq --no-install-recommends \
&& apt-get install \
--yes -qq --no-install-recommends \
Installed bzip2 In the Wiki backup section we use bzip2 in some of the examples. So it should be installed in the image.
2022-08-31 07:11:05 -05:00
bzip2 \
externalize netbox download with wget
2019-10-13 09:00:42 -05:00
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 08:23:07 -06:00
curl \
Install libldap-common This installs the LDAP configurationn file which is needed to load the trusted root certificates from the system.
2022-07-21 02:13:11 -05:00
libldap-common \
Added psycopg2 as additionnal dependency With psycopg2-binary the images doesn't work on ARM64.
2022-06-10 03:38:21 -05:00
libpq5 \
Enable SAML & OPENIDCONNECT for social-auth-core
2022-10-31 10:00:18 -05:00
libxmlsec1-openssl \
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 05:48:30 -05:00
openssl \
python3 \
First version of Debian based image
2021-08-31 03:57:37 -05:00
python3-distutils \
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 05:48:30 -05:00
tini \
First version of Debian based image
2021-08-31 03:57:37 -05:00
&& curl -sL https://nginx.org/keys/nginx_signing.key \
> /etc/apt/trusted.gpg.d/nginx.asc && \
Using Ubuntu 22.04 because Debian has old packages With Debian the Quay.io security checker found several issues in the image. With Ubuntu we have never versions of all packages and therefore less (or no) issues.
2022-07-14 15:54:28 -05:00
echo "deb https://packages.nginx.org/unit/ubuntu/ jammy unit" \
First version of Debian based image
2021-08-31 03:57:37 -05:00
> /etc/apt/sources.list.d/unit.list \
&& apt-get update -qq \
&& apt-get install \
--yes -qq --no-install-recommends \
Updated to new unit version
2022-10-07 01:08:30 -05:00
unit=1.29.1-1~jammy \
unit-python3.10=1.29.1-1~jammy \
First version of Debian based image
2021-08-31 03:57:37 -05:00
&& rm -rf /var/lib/apt/lists/*
Explain caching strategy in Dockerfile comments
2019-06-12 10:53:35 -05: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 08:23:07 -06: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 14:54:49 -05:00
ARG NETBOX_PATH
COPY ${NETBOX_PATH} /opt/netbox
Fixed version conflicts for social-auth-core
2023-04-06 02:52:28 -05:00
# Copy the modified 'requirements*.txt' files, to have the files actually used to install
COPY --from=builder /requirements.txt /requirements-container.txt /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
First version of Debian based image
2021-08-31 03:57:37 -05:00
COPY docker/ldap_config.docker.py /opt/netbox/netbox/netbox/ldap_config.py
Explain caching strategy in Dockerfile comments
2019-06-12 10:53:35 -05: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 05:48:30 -05: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 08:23:07 -06:00
COPY docker/launch-netbox.sh /opt/netbox/launch-netbox.sh
Dynamically load configuration files
2020-10-17 19:34:45 -05: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 08:23:07 -06:00
COPY docker/nginx-unit.json /etc/unit/
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
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.
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
RUN mkdir -p static /opt/unit/state/ /opt/unit/tmp/ \
Use user name instead of userid Nginx unit needs the user and group parameter as names.
2021-09-24 01:16:07 -05:00
&& chown -R unit:root media /opt/unit/ \
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
&& chmod -R g+w media /opt/unit/ \
Fixed build for Netbox feature branch
2022-02-02 09:49:29 -06:00
&& cd /opt/netbox/ && SECRET_KEY="dummy" /opt/netbox/venv/bin/python -m mkdocs build \
Build documentation files in the image
2021-07-21 02:58:27 -05:00
--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 08:23:07 -06:00
&& SECRET_KEY="dummy" /opt/netbox/venv/bin/python /opt/netbox/netbox/manage.py collectstatic --no-input
Adds netbox user
2019-11-17 11:03:59 -06:00
Updated to new unit version
2022-10-07 01:08:30 -05:00
ENV LANG=C.utf8 PATH=/opt/netbox/venv/bin:$PATH
First version of Debian based image
2021-08-31 03:57:37 -05:00
ENTRYPOINT [ "/usr/bin/tini", "--" ]
Copied Docker components from main repo
2017-04-19 09:48:21 -05:00
Changed entrypoint to "tini".
2021-09-13 01:18:23 -05:00
CMD [ "/opt/netbox/docker-entrypoint.sh", "/opt/netbox/launch-netbox.sh" ]
❇️ Adds new options to the build script
2018-02-02 05:48:38 -06:00
First version of Debian based image
2021-08-31 03:57:37 -05:00
LABEL netbox.original-tag="" \
netbox.git-branch="" \
netbox.git-ref="" \
netbox.git-url="" \
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
# 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 14:48:08 -06: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 10:07:02 -06: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="" \
Updated image labels and build script
2022-06-15 08:47:57 -05:00
org.opencontainers.image.version=""
Reference in New Issue Copy Permalink