sdavids-docker-healthcheck

Table of Contents

1. Size Comparison
2. License
3. Contribution
4. Code of Conduct
5. Development
- 5.1. Format Source Code
- 5.2. Lint Source Code
6. Development Environment Setup
- 6.1. Installation
- 6.2. IDE

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
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: an nc-based Docker health check for a daemon port

1. Size Comparison

Program	Size	Notes
shell - nc	4.0K	only checks the daemon’s port
JavaScript - Node.js	4.0K	the `node` binary would add 40.3M
Rust - http	188.0K
Rust - https	480.0K
Go - http	5.0M
Go - https	5.0M
wget alpine	8.6M
wget alpaquita-linux-base	8.8M
wget debian	9.7M
curl alpine	9.8M
curl alpaquita-linux-base	10.3M
curl debian	19.0M

1.1. Go

1.1.1. Go - http

$ cd go/http
$ scripts/docker_build.sh -t go-http
$ docker run --rm de.sdavids/sdavids-docker-healthcheck:go-http sh -c 'du -kh /usr/local/bin/healthcheck'
5.0M    /usr/local/bin/healthcheck

Usage

Go - http

1.1.2. Go - https

$ cd go/https
$ scripts/docker_build.sh -t go-https
$ docker run --rm de.sdavids/sdavids-docker-healthcheck:go-https sh -c 'du -kh /usr/local/bin/healthcheck'
5.0M    /usr/local/bin/healthcheck

Usage

Go - https

1.2. JavaScript

1.2.1. Node.js

ℹ️	This healthcheck is only useful in a Node.js Docker image, i.e. an image where the `node` binary already exists—the `node` binary would add 40.3M.

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

Usage

js - nodejs

1.3. Rust - http

$ cd rust/http
$ scripts/docker_build.sh -t rust-http
$ docker run --rm de.sdavids/sdavids-docker-healthcheck:rust-http sh -c 'du -kh /usr/local/bin/healthcheck'
188.0K  /usr/local/bin/healthcheck

1.3.1. Usage

Rust - http

1.4. Rust - https

$ cd rust/https
$ scripts/docker_build.sh -t rust-https
$ docker run --rm de.sdavids/sdavids-docker-healthcheck:rust-https sh -c 'du -kh /usr/local/bin/healthcheck'
480.0K  /usr/local/bin/healthcheck

1.4.1. Usage

Rust - https

1.5. shell - nc

ℹ️	This healthcheck 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 -t shell-nc
$ docker run --rm de.sdavids/sdavids-docker-healthcheck:shell-nc sh -c 'du -kh /usr/local/bin/healthcheck'
4.0K    /usr/local/bin/healthcheck

1.5.1. Usage

shell - nc

1.6. curl

1.6.1. alpine

$ docker run --rm alpine:3.21.0 sh -c "apk --no-cache --quiet --no-progress add curl=8.11.0-r2 && ldd /usr/bin/curl | awk '{ print $ 3}' | xargs du -ckshL /usr/bin/curl"
260.0K  /usr/bin/curl
652.0K  /usr/lib/libcurl.so.4
132.0K  /usr/lib/libz.so.1
708.0K  /lib/ld-musl-aarch64.so.1
260.0K  /usr/lib/libcares.so.2
196.0K  /usr/lib/libnghttp2.so.14
196.0K  /usr/lib/libidn2.so.0
132.0K  /usr/lib/libpsl.so.5
848.0K  /usr/lib/libssl.so.3
3.9M    /usr/lib/libcrypto.so.3
644.0K  /usr/lib/libzstd.so.1
68.0K   /usr/lib/libbrotlidec.so.1
1.7M    /usr/lib/libunistring.so.5
196.0K  /usr/lib/libbrotlicommon.so.1
9.8M    total

1.6.2. alpaquita-linux-base

$ docker run --rm bellsoft/alpaquita-linux-base:stream-musl-240821 sh -c "apk --no-cache --quiet --no-progress add curl=8.9.1-r0 && ldd /usr/bin/curl | awk '{ print $ 3}' | xargs du -ckshL /usr/bin/curl"
236.0K  /usr/bin/curl
612.0K  /lib/libcurl.so.4
100.0K  /lib/libz.so.1
788.0K  /lib/ld-musl-x86_64.so.1
160.0K  /lib/libcares.so.2
140.0K  /lib/libnghttp2.so.14
196.0K  /lib/libidn2.so.0
76.0K   /lib/libpsl.so.5
780.0K  /lib/libssl.so.3
4.3M    /lib/libcrypto.so.3
1.1M    /lib/libzstd.so.1
56.0K   /lib/libbrotlidec.so.1
1.6M    /lib/libunistring.so.5
140.0K  /lib/libbrotlicommon.so.1
10.3M   total

1.6.3. debian

$ docker run --rm debian:12.8-slim sh -c "apt-get -qq update && apt-get -qq install -y curl=7.88.1-10+deb12u8 >/dev/null 2>&1 && ldd /usr/bin/curl | awk '{ print $ 3}' | xargs du -ckshL /usr/bin/curl"
324K    /usr/bin/curl
716K    /lib/aarch64-linux-gnu/libcurl.so.4
132K    /lib/aarch64-linux-gnu/libz.so.1
1.6M    /lib/aarch64-linux-gnu/libc.so.6
196K    /lib/aarch64-linux-gnu/libnghttp2.so.14
196K    /lib/aarch64-linux-gnu/libidn2.so.0
116K    /lib/aarch64-linux-gnu/librtmp.so.1
244K    /lib/aarch64-linux-gnu/libssh2.so.1
132K    /lib/aarch64-linux-gnu/libpsl.so.5
720K    /lib/aarch64-linux-gnu/libssl.so.3
4.3M    /lib/aarch64-linux-gnu/libcrypto.so.3
328K    /lib/aarch64-linux-gnu/libgssapi_krb5.so.2
388K    /lib/aarch64-linux-gnu/libldap-2.5.so.0
68K     /lib/aarch64-linux-gnu/liblber-2.5.so.0
644K    /lib/aarch64-linux-gnu/libzstd.so.1
68K     /lib/aarch64-linux-gnu/libbrotlidec.so.1
1.7M    /lib/aarch64-linux-gnu/libunistring.so.2
2.2M    /lib/aarch64-linux-gnu/libgnutls.so.30
324K    /lib/aarch64-linux-gnu/libhogweed.so.6
324K    /lib/aarch64-linux-gnu/libnettle.so.8
520K    /lib/aarch64-linux-gnu/libgmp.so.10
908K    /lib/aarch64-linux-gnu/libkrb5.so.3
196K    /lib/aarch64-linux-gnu/libk5crypto.so.3
68K     /lib/aarch64-linux-gnu/libcom_err.so.2
68K     /lib/aarch64-linux-gnu/libkrb5support.so.0
132K    /lib/aarch64-linux-gnu/libsasl2.so.2
132K    /lib/aarch64-linux-gnu/libbrotlicommon.so.1
1.3M    /lib/aarch64-linux-gnu/libp11-kit.so.0
132K    /lib/aarch64-linux-gnu/libtasn1.so.6
68K     /lib/aarch64-linux-gnu/libkeyutils.so.1
68K     /lib/aarch64-linux-gnu/libresolv.so.2
68K     /lib/aarch64-linux-gnu/libffi.so.8
19M     total

1.7. wget

1.7.1. alpine

$ docker run --rm alpine:3.21.0 sh -c "apk --no-cache --quiet --no-progress add wget=1.25.0-r0 && ldd /usr/bin/wget | awk '{ print $ 3}' | xargs du -ckshL /usr/bin/wget"
468.0K  /usr/bin/wget
644.0K  /usr/lib/libpcre2-8.so.0
196.0K  /usr/lib/libidn2.so.0
848.0K  /usr/lib/libssl.so.3
3.9M    /usr/lib/libcrypto.so.3
132.0K  /usr/lib/libz.so.1
708.0K  /lib/ld-musl-aarch64.so.1
1.7M    /usr/lib/libunistring.so.5
8.6M    total

1.7.2. alpaquita-linux-base

$ docker run --rm bellsoft/alpaquita-linux-base:stream-musl-240821 sh -c "apk --no-cache --quiet --no-progress add wget=1.24.5-r0 && ldd /usr/bin/wget | awk '{ print $ 3}' | xargs du -ckshL /usr/bin/wget"
404.0K  /usr/bin/wget
684.0K  /lib/libpcre2-8.so.0
196.0K  /lib/libidn2.so.0
780.0K  /lib/libssl.so.3
4.3M    /lib/libcrypto.so.3
100.0K  /lib/libz.so.1
788.0K  /lib/ld-musl-x86_64.so.1
1.6M    /lib/libunistring.so.5
8.8M    total

1.7.3. debian

$ docker run --rm debian:12.8-slim sh -c "apt-get -qq update && apt-get -qq install -y wget=1.21.3-1+b1 >/dev/null 2>&1 && ldd /usr/bin/wget | awk '{ print $ 3}' | xargs du -ckshL /usr/bin/wget"
520K    /usr/bin/wget
580K    /lib/aarch64-linux-gnu/libpcre2-8.so.0
68K     /lib/aarch64-linux-gnu/libuuid.so.1
196K    /lib/aarch64-linux-gnu/libidn2.so.0
324K    /lib/aarch64-linux-gnu/libnettle.so.8
2.2M    /lib/aarch64-linux-gnu/libgnutls.so.30
132K    /lib/aarch64-linux-gnu/libz.so.1
132K    /lib/aarch64-linux-gnu/libpsl.so.5
1.6M    /lib/aarch64-linux-gnu/libc.so.6
1.7M    /lib/aarch64-linux-gnu/libunistring.so.2
1.3M    /lib/aarch64-linux-gnu/libp11-kit.so.0
132K    /lib/aarch64-linux-gnu/libtasn1.so.6
324K    /lib/aarch64-linux-gnu/libhogweed.so.6
520K    /lib/aarch64-linux-gnu/libgmp.so.10
68K     /lib/aarch64-linux-gnu/libffi.so.8
9.7M    total

2. License

Apache License, Version 2.0 (Apache-2.0.txt or www.apache.org/licenses/LICENSE-2.0).

3. Contribution

See CONTRIBUTING.adoc.

4. Code of Conduct

We abide by the Contributor Covenant, Version 2.1 and ask that you do as well.

For more information, please see Code of Conduct.

5. Development

5.1. Format Source Code

$ scripts/format.sh

5.2. Lint Source Code

$ scripts/lint.sh

6. Development Environment Setup

❗	After initializing this repository you need to install the Git hooks via: $ git config core.hooksPath .githooks And configure the ignore-revs-file: git config blame.ignoreRevsFile .git-blame-ignore-revs

6.1. Installation

6.1.1. Docker

Install Docker.

6.1.2. easyrsa

❗	Ensure that you install version `3.1.7` and not `3.2.0`! Version `3.2.0` is an incompatible development snapshot release.

Linux

Install easyrsa.

Mac

⚠️	Unfortunately, homebrew provides `easy-rsa` version `3.2.0` at this point in time (August 2024).

$ 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

6.1.3. Go

Install Go.

6.1.4. golangci-lint

Install golangci-lint.

6.1.5. hadolint

Linux

Install hadolint.

Mac

$ brew install hadolint

6.1.6. 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

6.1.7. Rust

Install Rust.

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

6.1.8. shellcheck

Linux

$ sudo apt-get install shellcheck

Mac

$ brew install shellcheck

6.1.9. shfmt

Linux

$ sudo apt-get install shfmt

Mac

$ brew install shfmt

6.1.10. yamllint

Linux

$ sudo apt-get install yamllint

Mac

$ brew install yamllint

6.2. IDE

See IDE Configuration.

Files

README.adoc

Latest commit

History

README.adoc

File metadata and controls

sdavids-docker-healthcheck