mirror of
https://github.com/netbox-community/netbox-docker.git
synced 2024-11-28 10:54:17 +01:00
198 lines
7.3 KiB
Bash
Executable File
198 lines
7.3 KiB
Bash
Executable File
#!/bin/bash
|
|
# Builds the Dockerfile[.variant] and injects tgz'ed Netbox code from Github
|
|
|
|
echo "▶️ $0 $*"
|
|
|
|
set -e
|
|
|
|
if [ "${1}x" == "x" ] || [ "${1}" == "--help" ] || [ "${1}" == "-h" ]; then
|
|
echo "Usage: ${0} <branch> [--push|--push-only]"
|
|
echo " branch The branch or tag to build. Required."
|
|
echo " --push Pushes built the Docker image to the registry."
|
|
echo " --push-only Does not build. Only pushes the Docker image to the registry."
|
|
echo ""
|
|
echo "You can use the following ENV variables to customize the build:"
|
|
echo " DEBUG If defined, the script does not stop when certain checks are unsatisfied."
|
|
echo " DRY_RUN Prints all build statements instead of running them."
|
|
echo " DOCKER_OPTS Add parameters to Docker."
|
|
echo " Default:"
|
|
echo " When <TAG> starts with 'v': \"\""
|
|
echo " Else: \"--no-cache\""
|
|
echo " BRANCH The branch to build."
|
|
echo " Also used for tagging the image."
|
|
echo " TAG The version part of the docker tag."
|
|
echo " Default:"
|
|
echo " When <BRANCH>=master: latest"
|
|
echo " When <BRANCH>=develop: snapshot"
|
|
echo " Else: same as <BRANCH>"
|
|
echo " DOCKER_ORG The Docker registry (i.e. hub.docker.com/r/<DOCKER_ORG>/<DOCKER_REPO>) "
|
|
echo " Also used for tagging the image."
|
|
echo " Default: netboxcommunity"
|
|
echo " DOCKER_REPO The Docker registry (i.e. hub.docker.com/r/<DOCKER_ORG>/<DOCKER_REPO>) "
|
|
echo " Also used for tagging the image."
|
|
echo " Default: netbox"
|
|
echo " DOCKER_TAG The name of the tag which is applied to the image."
|
|
echo " Useful for pushing into another registry than hub.docker.com."
|
|
echo " Default: <DOCKER_ORG>/<DOCKER_REPO>:<BRANCH>"
|
|
echo " DOCKER_SHORT_TAG The name of the short tag which is applied to the image."
|
|
echo " This is used to tag all patch releases to their containing version e.g. v2.5.1 -> v2.5"
|
|
echo " Default: <DOCKER_ORG>/<DOCKER_REPO>:\$MAJOR.\$MINOR"
|
|
echo " SRC_ORG Which fork of netbox to use (i.e. github.com/<SRC_ORG>/<SRC_REPO>)."
|
|
echo " Default: digitalocean"
|
|
echo " SRC_REPO The name of the netbox for to use (i.e. github.com/<SRC_ORG>/<SRC_REPO>)."
|
|
echo " Default: netbox"
|
|
echo " URL Where to fetch the package from."
|
|
echo " Must be a tar.gz file of the source code."
|
|
echo " Default: https://github.com/<SRC_ORG>/<SRC_REPO>/archive/\$BRANCH.tar.gz"
|
|
echo " VARIANT The variant to build."
|
|
echo " The value will be used as a suffix to the \$TAG and for the Dockerfile"
|
|
echo " selection. The TAG being build must exist for the base variant and"
|
|
echo " corresponding Dockerfile must start with the following lines:"
|
|
echo " ARG DOCKER_ORG=netboxcommunity"
|
|
echo " ARG DOCKER_REPO=netbox"
|
|
echo " ARG FROM_TAG=latest"
|
|
echo " FROM \$DOCKER_ORG/\$DOCKER_REPO:\$FROM_TAG"
|
|
echo " Example: VARIANT=ldap will result in the tag 'latest-ldap' and the"
|
|
echo " Dockerfile './Dockerfile.ldap' being used."
|
|
echo " Exception: VARIANT=main will use the './Dockerfile' Dockerfile"
|
|
echo " Default: main"
|
|
echo " HTTP_PROXY The proxy to use for http requests."
|
|
echo " Example: http://proxy.domain.tld:3128"
|
|
echo " Default: empty"
|
|
echo " HTTPS_PROXY The proxy to use for https requests."
|
|
echo " Example: http://proxy.domain.tld:3128"
|
|
echo " Default: empty"
|
|
echo " FTP_PROXY The proxy to use for ftp requests."
|
|
echo " Example: http://proxy.domain.tld:3128"
|
|
echo " Default: empty"
|
|
echo " NO_PROXY Comma-separated list of domain extensions proxy should not be used for."
|
|
echo " Example: .domain1.tld,.domain2.tld"
|
|
echo " Default: empty"
|
|
|
|
if [ "${1}x" == "x" ]; then
|
|
exit 1
|
|
else
|
|
exit 0
|
|
fi
|
|
fi
|
|
|
|
# read the project version and trim it
|
|
# see https://stackoverflow.com/a/3232433/172132
|
|
NETBOX_DOCKER_PROJECT_VERSION="${NETBOX_DOCKER_PROJECT_VERSION-$(sed -e 's/^[[:space:]]*//' -e 's/[[:space:]]*$//' VERSION)}"
|
|
|
|
# variables for fetching the source
|
|
SRC_ORG="${SRC_ORG-digitalocean}"
|
|
SRC_REPO="${SRC_REPO-netbox}"
|
|
BRANCH="${1}"
|
|
URL="${URL-https://github.com/${SRC_ORG}/${SRC_REPO}/archive/$BRANCH.tar.gz}"
|
|
|
|
# Checking which VARIANT to build
|
|
VARIANT="${VARIANT-main}"
|
|
if [ "$VARIANT" == "main" ]; then
|
|
DOCKERFILE="Dockerfile"
|
|
else
|
|
DOCKERFILE="Dockerfile.${VARIANT}"
|
|
fi
|
|
|
|
# Fail fast
|
|
if [ ! -f "${DOCKERFILE}" ]; then
|
|
echo "🚨 The Dockerfile ${DOCKERFILE} for variant '${VARIANT}' doesn't exist."
|
|
|
|
if [ -z "$DEBUG" ]; then
|
|
exit 1
|
|
else
|
|
echo "⚠️ Would exit here with code '1', but DEBUG is enabled."
|
|
fi
|
|
fi
|
|
|
|
# variables for tagging the docker image
|
|
DOCKER_ORG="${DOCKER_ORG-netboxcommunity}"
|
|
DOCKER_REPO="${DOCKER_REPO-netbox}"
|
|
case "${BRANCH}" in
|
|
master)
|
|
TAG="${TAG-latest}";;
|
|
develop)
|
|
TAG="${TAG-snapshot}";;
|
|
*)
|
|
TAG="${TAG-$BRANCH}";;
|
|
esac
|
|
|
|
DOCKER_TAG="${DOCKER_TAG-${DOCKER_ORG}/${DOCKER_REPO}:${TAG}}"
|
|
if [ "$VARIANT" != "main" ]; then
|
|
DOCKER_TAG="${DOCKER_TAG}-${VARIANT}"
|
|
fi
|
|
|
|
if [[ "${TAG}" =~ ^v([0-9]+)\.([0-9]+)\.[0-9]+$ ]]; then
|
|
MAJOR=${BASH_REMATCH[1]}
|
|
MINOR=${BASH_REMATCH[2]}
|
|
|
|
DOCKER_SHORT_TAG="${DOCKER_SHORT_TAG-${DOCKER_ORG}/${DOCKER_REPO}:v${MAJOR}.${MINOR}}"
|
|
|
|
if [ "$VARIANT" != "main" ]; then
|
|
DOCKER_SHORT_TAG="${DOCKER_SHORT_TAG}-${VARIANT}"
|
|
fi
|
|
fi
|
|
|
|
DOCKER_OPTS=("${DOCKER_OPTS[@]}")
|
|
|
|
# caching is only ok for version tags
|
|
case "${TAG}" in
|
|
v*) ;;
|
|
*) DOCKER_OPTS+=( "--no-cache" ) ;;
|
|
esac
|
|
|
|
DOCKER_OPTS+=( "--pull" )
|
|
|
|
# Build args
|
|
DOCKER_BUILD_ARGS=(
|
|
--build-arg "NETBOX_DOCKER_PROJECT_VERSION=${NETBOX_DOCKER_PROJECT_VERSION}"
|
|
--build-arg "FROM_TAG=${TAG}"
|
|
--build-arg "BRANCH=${BRANCH}"
|
|
--build-arg "URL=${URL}"
|
|
--build-arg "DOCKER_ORG=${DOCKER_ORG}"
|
|
--build-arg "DOCKER_REPO=${DOCKER_REPO}"
|
|
)
|
|
if [ -n "$HTTP_PROXY" ]; then
|
|
DOCKER_BUILD_ARGS+=( --build-arg "http_proxy=${HTTP_PROXY}" )
|
|
fi
|
|
if [ -n "$HTTPS_PROXY" ]; then
|
|
DOCKER_BUILD_ARGS+=( --build-arg "https_proxy=${HTTPS_PROXY}" )
|
|
fi
|
|
if [ -n "$FTP_PROXY" ]; then
|
|
DOCKER_BUILD_ARGS+=( --build-arg "ftp_proxy=${FTP_PROXY}" )
|
|
fi
|
|
if [ -n "$NO_PROXY" ]; then
|
|
DOCKER_BUILD_ARGS+=( --build-arg "no_proxy=${NO_PROXY}" )
|
|
fi
|
|
|
|
if [ -z "$DRY_RUN" ]; then
|
|
DOCKER_CMD="docker"
|
|
else
|
|
echo "⚠️ DRY_RUN MODE ON ⚠️"
|
|
DOCKER_CMD="echo docker"
|
|
fi
|
|
|
|
if [ "${2}" != "--push-only" ] ; then
|
|
echo "🐳 Building the Docker image '${DOCKER_TAG}' from the url '${URL}'."
|
|
$DOCKER_CMD build -t "${DOCKER_TAG}" "${DOCKER_BUILD_ARGS[@]}" "${DOCKER_OPTS[@]}" -f "${DOCKERFILE}" .
|
|
echo "✅ Finished building the Docker images '${DOCKER_TAG}'"
|
|
|
|
if [ -n "$DOCKER_SHORT_TAG" ]; then
|
|
echo "🐳 Tagging image '${DOCKER_SHORT_TAG}'."
|
|
$DOCKER_CMD tag "${DOCKER_TAG}" "${DOCKER_SHORT_TAG}"
|
|
echo "✅ Tagged image '${DOCKER_SHORT_TAG}'"
|
|
fi
|
|
fi
|
|
|
|
if [ "${2}" == "--push" ] || [ "${2}" == "--push-only" ] ; then
|
|
echo "⏫ Pushing '${DOCKER_TAG}"
|
|
$DOCKER_CMD push "${DOCKER_TAG}"
|
|
echo "✅ Finished pushing the Docker image '${DOCKER_TAG}'."
|
|
|
|
if [ -n "$DOCKER_SHORT_TAG" ]; then
|
|
echo "⏫ Pushing '${DOCKER_SHORT_TAG}'"
|
|
$DOCKER_CMD push "${DOCKER_SHORT_TAG}"
|
|
echo "✅ Finished pushing the Docker image '${DOCKER_SHORT_TAG}'."
|
|
fi
|
|
fi
|