Skip to content

sdavids/sdavids-docker-healthcheck

BranchesTags

Repository files navigation

sdavids-docker-healthcheck

Table of Contents

Available Docker health checks:

Go http

a Go-based Docker health check for an HTTP URL

Go https

a Go-based Docker health check for an HTTP(S) URL

Java http

a Java-based Docker health check for an HTTP URL

JavaScript Node.js

a Node.js-based Docker health check for an HTTP(S) URL

Rust http

a Rust-based Docker health check for an HTTP URL

Rust https

a Rust-based Docker health check for an HTTP(S) URL

shell nc

a nc-based Docker health check for a daemon port

1. Size Comparison

Program Size Notes

shell nc

4.0K

only check the daemon’s port

JavaScript Node.js

4.0K

the node binary would add 41.6M

Rust http

208.0K

Rust https

548.0K

Java http

3.4M

Go http

5.6M

Go https

5.6M

wget alpine

9.5M

wget debian

11.0M

curl alpine

10.7M

curl debian

22.0M

1.1. Go

1.1.1. http

$ cd go/http
$ scripts/docker_build.sh -p linux/amd64 -t go-http
$ docker run --platform=linux/amd64 --rm de.sdavids/sdavids-docker-healthcheck:go-http sh -c 'du -kh /usr/local/bin/healthcheck'
5.6M    /usr/local/bin/healthcheck

1.1.2. https

$ cd go/https
$ scripts/docker_build.sh -p linux/amd64 -t go-https
$ docker run --platform=linux/amd64 --rm de.sdavids/sdavids-docker-healthcheck:go-https sh -c 'du -kh /usr/local/bin/healthcheck'
5.6M    /usr/local/bin/healthcheck

1.2. Java

1.2.1. http

ℹ️

You need to authenticate with the ghcr.io Container registry to build the image.

 
$ cd java/http
$ scripts/docker_build.sh -p linux/amd64 -t java-http
$ docker run --platform=linux/amd64 --rm de.sdavids/sdavids-docker-healthcheck:java-http sh -c 'du -kh /usr/local/bin/healthcheck'
3.4M    /usr/local/bin/healthcheck

1.3. JavaScript

1.3.1. Node.js

ℹ️

This health check is only useful in a Node.js Docker image, i.e., an image where the node binary already exists—​the node binary would add 41.6M.

 
$ cd js/nodejs
$ scripts/docker_build.sh -p linux/amd64 -t js-nodejs
$ docker run --platform=linux/amd64 --rm de.sdavids/sdavids-docker-healthcheck:js-nodejs sh -c 'du -kh /node/healthcheck.mjs'
4.0K    /node/healthcheck.mjs
$ docker run --platform=linux/amd64 --rm de.sdavids/sdavids-docker-healthcheck:js-nodejs sh -c 'du -kh /usr/bin/node'
41.6M   /usr/bin/node

1.4. Rust

1.4.1. http

$ cd rust/http
$ scripts/docker_build.sh -p linux/amd64 -t rust-http
$ docker run --platform=linux/amd64 --rm de.sdavids/sdavids-docker-healthcheck:rust-http sh -c 'du -kh /usr/local/bin/healthcheck'
208.0K  /usr/local/bin/healthcheck

1.4.2. https

ℹ️

You need to create a certificate authority and its root certificate:

$ cd rust/https
$ scripts/create_ca.sh
$ scripts/copy_ca_root_cert.sh

Or copy an existing root certificate:

$ cd rust/https
$ scripts/copy_ca_root_cert.sh
 
$ cd rust/https
$ scripts/docker_build.sh -p linux/amd64 -t rust-https
$ docker run --platform=linux/amd64 --rm de.sdavids/sdavids-docker-healthcheck:rust-https sh -c 'du -kh /usr/local/bin/healthcheck'
548.0K  /usr/local/bin/healthcheck

1.5. shell

1.5.1. nc

ℹ️

This health check will only check if the daemon’s port is reachable, i.e., it will not check the HTTP body or status code of the response.

 
$ cd shell/nc
$ scripts/docker_build.sh -p linux/amd64 -t shell-nc
$ docker run --platform=linux/amd64 --rm de.sdavids/sdavids-docker-healthcheck:shell-nc sh -c 'du -kh /usr/local/bin/healthcheck'
4.0K    /usr/local/bin/healthcheck

1.6. curl

1.6.1. alpine

$ docker run --platform=linux/amd64 --rm alpine:3.23.2 sh -c "apk --no-cache --quiet --no-progress add curl=8.17.0-r1 && ldd /usr/bin/curl | awk '{ print $ 3}' | xargs du -ckshL /usr/bin/curl"
256.0K  /usr/bin/curl
724.0K  /usr/lib/libcurl.so.4
104.0K  /usr/lib/libz.so.1
652.0K  /lib/ld-musl-x86_64.so.1
236.0K  /usr/lib/libcares.so.2
144.0K  /usr/lib/libnghttp3.so.9
132.0K  /usr/lib/libnghttp2.so.14
196.0K  /usr/lib/libidn2.so.0
76.0K   /usr/lib/libpsl.so.5
820.0K  /usr/lib/libssl.so.3
4.8M    /usr/lib/libcrypto.so.3
696.0K  /usr/lib/libzstd.so.1
56.0K   /usr/lib/libbrotlidec.so.1
1.8M    /usr/lib/libunistring.so.5
140.0K  /usr/lib/libbrotlicommon.so.1
10.7M   total

1.6.2. debian

$ docker run --platform=linux/amd64 --rm debian:13.2-slim sh -c "apt-get -qq update && apt-get -qq install -y curl=8.14.1-2+deb13u2 >/dev/null 2>&1 && ldd /usr/bin/curl | awk '{ print $ 3}' | xargs du -ckshL /usr/bin/curl"
316K   /usr/bin/curl
964K   /lib/x86_64-linux-gnu/libcurl.so.4
124K   /lib/x86_64-linux-gnu/libz.so.1
2.0M   /lib/x86_64-linux-gnu/libc.so.6
172K   /lib/x86_64-linux-gnu/libnghttp3.so.9
196K   /lib/x86_64-linux-gnu/libnghttp2.so.14
200K   /lib/x86_64-linux-gnu/libidn2.so.0
120K   /lib/x86_64-linux-gnu/librtmp.so.1
288K   /lib/x86_64-linux-gnu/libssh2.so.1
76K    /lib/x86_64-linux-gnu/libpsl.so.5
1.1M   /lib/x86_64-linux-gnu/libssl.so.3
6.3M   /lib/x86_64-linux-gnu/libcrypto.so.3
340K   /lib/x86_64-linux-gnu/libgssapi_krb5.so.2
392K   /lib/x86_64-linux-gnu/libldap.so.2
64K    /lib/x86_64-linux-gnu/liblber.so.2
808K   /lib/x86_64-linux-gnu/libzstd.so.1
52K    /lib/x86_64-linux-gnu/libbrotlidec.so.1
2.0M   /lib/x86_64-linux-gnu/libunistring.so.5
2.2M   /lib/x86_64-linux-gnu/libgnutls.so.30
300K   /lib/x86_64-linux-gnu/libhogweed.so.6
340K   /lib/x86_64-linux-gnu/libnettle.so.8
556K   /lib/x86_64-linux-gnu/libgmp.so.10
864K   /lib/x86_64-linux-gnu/libkrb5.so.3
184K   /lib/x86_64-linux-gnu/libk5crypto.so.3
20K    /lib/x86_64-linux-gnu/libcom_err.so.2
52K    /lib/x86_64-linux-gnu/libkrb5support.so.0
108K   /lib/x86_64-linux-gnu/libsasl2.so.2
140K   /lib/x86_64-linux-gnu/libbrotlicommon.so.1
88K    /lib/x86_64-linux-gnu/libtasn1.so.6
24K    /lib/x86_64-linux-gnu/libkeyutils.so.1
64K    /lib/x86_64-linux-gnu/libresolv.so.2
48K    /lib/x86_64-linux-gnu/libffi.so.8
22M    total

1.7. wget

1.7.1. alpine

$ docker run --platform=linux/amd64 --rm alpine:3.23.2 sh -c "apk --no-cache --quiet --no-progress add wget=1.25.0-r2 && ldd /usr/bin/wget | awk '{ print $ 3}' | xargs du -ckshL /usr/bin/wget"
404.0K  /usr/bin/wget
764.0K  /usr/lib/libpcre2-8.so.0
196.0K  /usr/lib/libidn2.so.0
820.0K  /usr/lib/libssl.so.3
4.8M    /usr/lib/libcrypto.so.3
104.0K  /usr/lib/libz.so.1
652.0K  /lib/ld-musl-x86_64.so.1
1.8M    /usr/lib/libunistring.so.5
9.5M    total

1.7.2. debian

$ docker run --platform=linux/amd64 --rm debian:13.2-slim sh -c "apt-get -qq update && apt-get -qq install -y wget=1.25.0-2 >/dev/null 2>&1 && ldd /usr/bin/wget | awk '{ print $ 3}' | xargs du -ckshL /usr/bin/wget"
472K   /usr/bin/wget
696K   /lib/x86_64-linux-gnu/libpcre2-8.so.0
40K    /lib/x86_64-linux-gnu/libuuid.so.1
200K   /lib/x86_64-linux-gnu/libidn2.so.0
340K   /lib/x86_64-linux-gnu/libnettle.so.8
2.2M   /lib/x86_64-linux-gnu/libgnutls.so.30
124K   /lib/x86_64-linux-gnu/libz.so.1
76K    /lib/x86_64-linux-gnu/libpsl.so.5
2.0M   /lib/x86_64-linux-gnu/libc.so.6
2.0M   /lib/x86_64-linux-gnu/libunistring.so.5
1.7M   /lib/x86_64-linux-gnu/libp11-kit.so.0
88K    /lib/x86_64-linux-gnu/libtasn1.so.6
300K   /lib/x86_64-linux-gnu/libhogweed.so.6
556K   /lib/x86_64-linux-gnu/libgmp.so.10
48K    /lib/x86_64-linux-gnu/libffi.so.8
11M    total

2. Development

2.1. Format Source Code

$ scripts/format.sh

2.2. Lint Source Code

$ scripts/lint.sh

3. Development Environment Setup

❗

After cloning this repository, you need to install the Git hooks and configure the ignore-revs-file:

$ git config set core.hooksPath .githooks
$ git config set blame.ignoreRevsFile .git-blame-ignore-revs

3.1. Installation

3.1.2. easyrsa

❗

Ensure that you install version 3.1.7 and not 3.2.x!
Linux

Install easyrsa.

Mac
⚠️

Unfortunately, homebrew provides easy-rsa version 3.2.x .

 
$ curl -L https://github.com/OpenVPN/easy-rsa/releases/download/v3.1.7/EasyRSA-3.1.7.tgz -o ~/Downloads/easy-rsa.tgz
$ tar -xzf ~/Downloads/easy-rsa.tgz -C ~/.local/share
$ mv  ~/.local/share/EasyRSA-3.1.7 ~/.local/share/easyrsa
$ ln -s ~/.local/share/easyrsa/easyrsa ~/.local/bin/easyrsa
$ rm ~/Downloads/easy-rsa.tgz

3.1.3. Go

Install Go.

3.1.5. hadolint

Linux

Install hadolint.

Mac
$ brew install hadolint

3.1.6. JDK

There are several different JDKs and multiple options for installing them.

$ sdk install java

3.1.7. Node Version Manager

Install fnm or NVM.

fnm
~/.zprofile
if command -v fnm > /dev/null 2>&1; then
  eval "$(fnm env --use-on-cd)"
fi
nvm
~/.zshrc
export NVM_DIR="${HOME}/.nvm"

[ -s "${NVM_DIR}/nvm.sh" ] && . "${NVM_DIR}/nvm.sh"
[ -s "${NVM_DIR}/bash_completion" ] && . "${NVM_DIR}/bash_completion"

if command -v nvm > /dev/null 2>&1; then
  autoload -U add-zsh-hook
  load-nvmrc() {
    local nvmrc_path="$(nvm_find_nvmrc)"
    if [ -n "${nvmrc_path}" ]; then
      local nvmrc_node_version=$(nvm version "$(cat "${nvmrc_path}")")
      if [ "${nvmrc_node_version}" = "N/A" ]; then
        nvm install
      elif [ "${nvmrc_node_version}" != "$(nvm version)" ]; then
        nvm use
      fi
    elif [ -n "$(PWD=$OLDPWD nvm_find_nvmrc)" ] && [ "$(nvm version)" != "$(nvm version default)" ]; then
      echo "Reverting to nvm default version"
      nvm use default
    fi
  }

  add-zsh-hook chpwd load-nvmrc
  load-nvmrc
fi

3.1.8. Rust

Install Rust.

$ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y --default-toolchain stable --component rust-analyzer

3.1.9. shellcheck

Linux
$ sudo apt-get install shellcheck
Mac
$ brew install shellcheck

3.1.10. shfmt

Linux
$ sudo apt-get install shfmt
Mac
$ brew install shfmt

3.1.11. yamllint

Linux
$ sudo apt-get install yamllint
Mac
$ brew install yamllint

About

Docker health checks

Topics

nodejs docker rust golang

Resources

Readme
Activity

Stars

0 stars

Watchers

1 watching

Forks

0 forks
Report repository

Languages