feat(install): Adds support for podman(compose), while maintaining compatibility with docker

Daniel Bunte · Daniel Bunte · commit d87c155ca32d · 2025-04-22T14:33:40.000+02:00
diff --git a/install.sh b/install.sh
@@ -11,6 +11,7 @@ source install/_lib.sh
 
 # Pre-flight. No impact yet.
 source install/parse-cli.sh
+source install/detect-container-technology.sh
 source install/detect-platform.sh
 source install/dc-detect-version.sh
 source install/error-handling.sh
diff --git a/install/_min-requirements.sh b/install/_min-requirements.sh
@@ -2,6 +2,9 @@
 MIN_DOCKER_VERSION='19.03.6'
 MIN_COMPOSE_VERSION='2.32.2'
 
+MIN_PODMAN_VERSION='4.9.4'
+MIN_PODMAN_COMPOSE_VERSION='1.3.0'
+
 # 16 GB minimum host RAM, but there'll be some overhead outside of what
 # can be allotted to docker
 if [[ "$COMPOSE_PROFILES" == "errors-only" ]]; then
diff --git a/install/check-minimum-requirements.sh b/install/check-minimum-requirements.sh
@@ -2,31 +2,41 @@ echo "${_group}Checking minimum requirements ..."
 
 source install/_min-requirements.sh
 
-DOCKER_VERSION=$(docker version --format '{{.Server.Version}}' || echo '')
+DOCKER_VERSION=$($CONTAINER_TECHNOLOGY version --format '{{.Server.Version}}' || echo '')
 if [[ -z "$DOCKER_VERSION" ]]; then
-  echo "FAIL: Unable to get docker version, is the docker daemon running?"
+  echo "FAIL: Unable to get $CONTAINER_TECHNOLOGY version, is the $CONTAINER_TECHNOLOGY daemon running?"
   exit 1
 fi
 
-if ! vergte ${DOCKER_VERSION//v/} $MIN_DOCKER_VERSION; then
-  echo "FAIL: Expected minimum docker version to be $MIN_DOCKER_VERSION but found $DOCKER_VERSION"
-  exit 1
-fi
-echo "Found Docker version $DOCKER_VERSION"
-
-if ! vergte ${COMPOSE_VERSION//v/} $MIN_COMPOSE_VERSION; then
-  echo "FAIL: Expected minimum $dc_base version to be $MIN_COMPOSE_VERSION but found $COMPOSE_VERSION"
-  exit 1
+if [[ "$CONTAINER_TECHNOLOGY" == "docker" ]]; then
+  if ! vergte ${DOCKER_VERSION//v/} $MIN_DOCKER_VERSION; then
+    echo "FAIL: Expected minimum docker version to be $MIN_DOCKER_VERSION but found $DOCKER_VERSION"
+    exit 1
+  fi
+  if ! vergte ${COMPOSE_VERSION//v/} $MIN_COMPOSE_VERSION; then
+    echo "FAIL: Expected minimum $dc_base version to be $MIN_COMPOSE_VERSION but found $COMPOSE_VERSION"
+    exit 1
+  fi
+elif [[ "$CONTAINER_TECHNOLOGY" == "podman" ]]; then
+  if ! vergte ${DOCKER_VERSION//v/} $MIN_PODMAN_VERSION; then
+    echo "FAIL: Expected minimum podman version to be $MIN_PODMAN_VERSION but found $DOCKER_VERSION"
+    exit 1
+  fi
+  if ! vergte ${COMPOSE_VERSION//v/} $MIN_PODMAN_COMPOSE_VERSION; then
+    echo "FAIL: Expected minimum $dc_base version to be $MIN_PODMAN_COMPOSE_VERSION but found $COMPOSE_VERSION"
+    exit 1
+  fi
 fi
-echo "Found Docker Compose version $COMPOSE_VERSION"
+echo "Found $CONTAINER_TECHNOLOGY version $DOCKER_VERSION"
+echo "Found $CONTAINER_TECHNOLOGY Compose version $COMPOSE_VERSION"
 
-CPU_AVAILABLE_IN_DOCKER=$(docker run --rm busybox nproc --all)
+CPU_AVAILABLE_IN_DOCKER=$($CONTAINER_TECHNOLOGY run --rm busybox nproc --all)
 if [[ "$CPU_AVAILABLE_IN_DOCKER" -lt "$MIN_CPU_HARD" ]]; then
   echo "FAIL: Required minimum CPU cores available to Docker is $MIN_CPU_HARD, found $CPU_AVAILABLE_IN_DOCKER"
   exit 1
 fi
 
-RAM_AVAILABLE_IN_DOCKER=$(docker run --rm busybox free -m 2>/dev/null | awk '/Mem/ {print $2}')
+RAM_AVAILABLE_IN_DOCKER=$($CONTAINER_TECHNOLOGY run --rm busybox free -m 2>/dev/null | awk '/Mem/ {print $2}')
 if [[ "$RAM_AVAILABLE_IN_DOCKER" -lt "$MIN_RAM_HARD" ]]; then
   echo "FAIL: Required minimum RAM available to Docker is $MIN_RAM_HARD MB, found $RAM_AVAILABLE_IN_DOCKER MB"
   exit 1
@@ -35,9 +45,9 @@ fi
 #SSE4.2 required by Clickhouse (https://clickhouse.yandex/docs/en/operations/requirements/)
 # On KVM, cpuinfo could falsely not report SSE 4.2 support, so skip the check. https://github.com/ClickHouse/ClickHouse/issues/20#issuecomment-226849297
 # This may also happen on other virtualization software such as on VMWare ESXi hosts.
-IS_KVM=$(docker run --rm busybox grep -c 'Common KVM processor' /proc/cpuinfo || :)
+IS_KVM=$($CONTAINER_TECHNOLOGY run --rm busybox grep -c 'Common KVM processor' /proc/cpuinfo || :)
 if [[ ! "$SKIP_SSE42_REQUIREMENTS" -eq 1 && "$IS_KVM" -eq 0 && "$DOCKER_ARCH" = "x86_64" ]]; then
-  SUPPORTS_SSE42=$(docker run --rm busybox grep -c sse4_2 /proc/cpuinfo || :)
+  SUPPORTS_SSE42=$($CONTAINER_TECHNOLOGY run --rm busybox grep -c sse4_2 /proc/cpuinfo || :)
   if [[ "$SUPPORTS_SSE42" -eq 0 ]]; then
     echo "FAIL: The CPU your machine is running on does not support the SSE 4.2 instruction set, which is required for one of the services Sentry uses (Clickhouse). See https://github.com/getsentry/self-hosted/issues/340 for more info."
     exit 1
diff --git a/install/create-docker-volumes.sh b/install/create-docker-volumes.sh
@@ -1,10 +1,10 @@
 echo "${_group}Creating volumes for persistent storage ..."
 
-echo "Created $(docker volume create --name=sentry-clickhouse)."
-echo "Created $(docker volume create --name=sentry-data)."
-echo "Created $(docker volume create --name=sentry-kafka)."
-echo "Created $(docker volume create --name=sentry-postgres)."
-echo "Created $(docker volume create --name=sentry-redis)."
-echo "Created $(docker volume create --name=sentry-symbolicator)."
+echo "Created $($CONTAINER_TECHNOLOGY volume create --name=sentry-clickhouse)."
+echo "Created $($CONTAINER_TECHNOLOGY volume create --name=sentry-data)."
+echo "Created $($CONTAINER_TECHNOLOGY volume create --name=sentry-kafka)."
+echo "Created $($CONTAINER_TECHNOLOGY volume create --name=sentry-postgres)."
+echo "Created $($CONTAINER_TECHNOLOGY volume create --name=sentry-redis)."
+echo "Created $($CONTAINER_TECHNOLOGY volume create --name=sentry-symbolicator)."
 
 echo "${_endgroup}"
diff --git a/install/dc-detect-version.sh b/install/dc-detect-version.sh
@@ -6,17 +6,17 @@ else
   _endgroup=""
 fi
 
-echo "${_group}Initializing Docker Compose ..."
+echo "${_group}Initializing Docker|Podman Compose ..."
 
 # To support users that are symlinking to docker-compose
-dc_base="$(docker compose version --short &>/dev/null && echo 'docker compose' || echo '')"
-dc_base_standalone="$(docker-compose version --short &>/dev/null && echo 'docker-compose' || echo '')"
+dc_base="$(${CONTAINER_TECHNOLOGY} compose version --short &>/dev/null && echo "$CONTAINER_TECHNOLOGY compose" || echo '')"
+dc_base_standalone="$(${CONTAINER_TECHNOLOGY}-compose version --short &>/dev/null && echo "$CONTAINER_TECHNOLOGY-compose" || echo '')"
 
 COMPOSE_VERSION=$([ -n "$dc_base" ] && $dc_base version --short || echo '')
 STANDALONE_COMPOSE_VERSION=$([ -n "$dc_base_standalone" ] && $dc_base_standalone version --short || echo '')
 
 if [[ -z "$COMPOSE_VERSION" && -z "$STANDALONE_COMPOSE_VERSION" ]]; then
-  echo "FAIL: Docker Compose is required to run self-hosted"
+  echo "FAIL: Docker|Podman Compose is required to run self-hosted"
   exit 1
 fi
 
@@ -25,14 +25,25 @@ if [[ -z "$COMPOSE_VERSION" ]] || [[ -n "$STANDALONE_COMPOSE_VERSION" ]] && ! ve
   dc_base="$dc_base_standalone"
 fi
 
+if [[ "$CONTAINER_TECHNOLOGY" == "docker" ]]; then
+  NO_ANSI="--ansi never"
+elif [[ "$CONTAINER_TECHNOLOGY" == "podman" ]]; then
+  NO_ANSI="--no-ansi"
+fi
+
 if [[ "$(basename $0)" = "install.sh" ]]; then
-  dc="$dc_base --ansi never --env-file ${_ENV}"
+  dc="$dc_base $NO_ANSI --env-file ${_ENV}"
 else
-  dc="$dc_base --ansi never"
+  dc="$dc_base $NO_ANSI"
+fi
+
+if [[ "$CONTAINER_TECHNOLOGY" == "docker" ]]; then
+  proxy_args="--build-arg http_proxy=${http_proxy:-} --build-arg https_proxy=${https_proxy:-} --build-arg no_proxy=${no_proxy:-}"
+elif [[ "$CONTAINER_TECHNOLOGY" == "podman" ]]; then
+  proxy_args="--podman-build-args http_proxy=${http_proxy:-},https_proxy=${https_proxy:-},no_proxy=${no_proxy:-}"
 fi
-proxy_args="--build-arg http_proxy=${http_proxy:-} --build-arg https_proxy=${https_proxy:-} --build-arg no_proxy=${no_proxy:-}"
 dcr="$dc run --pull=never --rm"
 dcb="$dc build $proxy_args"
-dbuild="docker build $proxy_args"
+dbuild="$CONTAINER_TECHNOLOGY build $proxy_args"
 
 echo "${_endgroup}"
diff --git a/install/detect-container-technology.sh b/install/detect-container-technology.sh
@@ -0,0 +1,14 @@
+echo "${_group}Detecting container technology ..."
+
+export CONTAINER_TECHNOLOGY=""
+
+if command -v podman &> /dev/null; then
+    CONTAINER_TECHNOLOGY="podman"
+elif command -v docker &> /dev/null; then
+    CONTAINER_TECHNOLOGY="docker"
+else
+    echo "FAIL: Neither podman nor docker is installed on the system."
+    exit 1
+fi
+echo "Detected container technology: $CONTAINER_TECHNOLOGY"
+echo "${_endgroup}"
diff --git a/install/detect-platform.sh b/install/detect-platform.sh
@@ -12,12 +12,14 @@ echo "${_group}Detecting Docker platform"
 # linux/amd64 by default due to virtualization.
 # See https://github.com/docker/cli/issues/3286 for the Docker bug.
 
-if ! command -v docker &>/dev/null; then
-  echo "FAIL: Could not find a \`docker\` binary on this system. Are you sure it's installed?"
-  exit 1
+FORMAT=""
+if [[ $CONTAINER_TECHNOLOGY == "podman" ]]; then
+  FORMAT="{{.Host.Arch}}"
+elif [[ $CONTAINER_TECHNOLOGY == "docker" ]]; then
+  FORMAT="{{.Architecture}}"
 fi
 
-export DOCKER_ARCH=$(docker info --format '{{.Architecture}}')
+export DOCKER_ARCH=$($CONTAINER_TECHNOLOGY info --format "$FORMAT")
 if [[ "$DOCKER_ARCH" = "x86_64" ]]; then
   export DOCKER_PLATFORM="linux/amd64"
 elif [[ "$DOCKER_ARCH" = "aarch64" ]]; then
diff --git a/install/error-handling.sh b/install/error-handling.sh
@@ -6,8 +6,8 @@ fi
 
 $dbuild -t sentry-self-hosted-jq-local --platform="$DOCKER_PLATFORM" jq
 
-jq="docker run --rm -i sentry-self-hosted-jq-local"
-sentry_cli="docker run --rm -v /tmp:/work -e SENTRY_DSN=$SENTRY_DSN getsentry/sentry-cli"
+jq="$CONTAINER_TECHNOLOGY run --rm -i sentry-self-hosted-jq-local"
+sentry_cli="$CONTAINER_TECHNOLOGY run --rm -v /tmp:/work -e SENTRY_DSN=$SENTRY_DSN getsentry/sentry-cli"
 
 send_envelope() {
   # Send envelope
diff --git a/install/geoip.sh b/install/geoip.sh
@@ -21,7 +21,7 @@ install_geoip() {
   else
     echo "IP address geolocation is configured for updates."
     echo "Updating IP address geolocation database ... "
-    if ! docker run --rm -v "./geoip:/sentry" --entrypoint '/usr/bin/geoipupdate' "ghcr.io/maxmind/geoipupdate:v6.1.0" "-d" "/sentry" "-f" "/sentry/GeoIP.conf"; then
+    if ! $CONTAINER_TECHNOLOGY run --rm -v "./geoip:/sentry" --entrypoint '/usr/bin/geoipupdate' "ghcr.io/maxmind/geoipupdate:v6.1.0" "-d" "/sentry" "-f" "/sentry/GeoIP.conf"; then
       result='Error'
     fi
     echo "$result updating IP address geolocation database."
diff --git a/install/parse-cli.sh b/install/parse-cli.sh
@@ -4,7 +4,7 @@ show_help() {
   cat <<EOF
 Usage: $0 [options]
 
-Install Sentry with \`docker compose\`.
+Install Sentry with \`docker|podman compose\`.
 
 Options:
  -h, --help             Show this message and exit.
diff --git a/install/update-docker-images.sh b/install/update-docker-images.sh
@@ -1,14 +1,14 @@
-echo "${_group}Fetching and updating Docker images ..."
+echo "${_group}Fetching and updating $CONTAINER_TECHNOLOGY images ..."
 
 # We tag locally built images with a '-self-hosted-local' suffix. `docker
 # compose pull` tries to pull these too and shows a 404 error on the console
 # which is confusing and unnecessary. To overcome this, we add the
 # stderr>stdout redirection below and pass it through grep, ignoring all lines
 # having this '-onpremise-local' suffix.
 
-$dc pull -q --ignore-pull-failures 2>&1 | grep -v -- -self-hosted-local || true
+$dc pull --ignore-pull-failures 2>&1 | grep -v -- -self-hosted-local || true
 
 # We may not have the set image on the repo (local images) so allow fails
-docker pull ${SENTRY_IMAGE} || true
+$CONTAINER_TECHNOLOGY pull ${SENTRY_IMAGE} || true
 
 echo "${_endgroup}"
diff --git a/install/upgrade-postgres.sh b/install/upgrade-postgres.sh
@@ -1,23 +1,23 @@
 echo "${_group}Ensuring proper PostgreSQL version ..."
 
-if [[ -n "$(docker volume ls -q --filter name=sentry-postgres)" && "$(docker run --rm -v sentry-postgres:/db busybox cat /db/PG_VERSION 2>/dev/null)" == "9.6" ]]; then
-  docker volume rm sentry-postgres-new || true
+if [[ -n "$($CONTAINER_TECHNOLOGY volume ls -q --filter name=sentry-postgres)" && "$($CONTAINER_TECHNOLOGY run --rm -v sentry-postgres:/db busybox cat /db/PG_VERSION 2>/dev/null)" == "9.6" ]]; then
+  $CONTAINER_TECHNOLOGY volume rm sentry-postgres-new || true
   # If this is Postgres 9.6 data, start upgrading it to 14.0 in a new volume
-  docker run --rm \
+  $CONTAINER_TECHNOLOGY run --rm \
     -v sentry-postgres:/var/lib/postgresql/9.6/data \
     -v sentry-postgres-new:/var/lib/postgresql/14/data \
     tianon/postgres-upgrade:9.6-to-14
 
   # Get rid of the old volume as we'll rename the new one to that
-  docker volume rm sentry-postgres
-  docker volume create --name sentry-postgres
+  $CONTAINER_TECHNOLOGY volume rm sentry-postgres
+  $CONTAINER_TECHNOLOGY volume create --name sentry-postgres
   # There's no rename volume in Docker so copy the contents from old to new name
   # Also append the `host all all all trust` line as `tianon/postgres-upgrade:9.6-to-14`
   # doesn't do that automatically.
-  docker run --rm -v sentry-postgres-new:/from -v sentry-postgres:/to alpine ash -c \
+  $CONTAINER_TECHNOLOGY run --rm -v sentry-postgres-new:/from -v sentry-postgres:/to alpine ash -c \
     "cd /from ; cp -av . /to ; echo 'host all all all trust' >> /to/pg_hba.conf"
   # Finally, remove the new old volume as we are all in sentry-postgres now.
-  docker volume rm sentry-postgres-new
+  $CONTAINER_TECHNOLOGY volume rm sentry-postgres-new
   echo "Re-indexing due to glibc change, this may take a while..."
   echo "Starting up new PostgreSQL version"
   $dc up --wait postgres
diff --git a/install/wrap-up.sh b/install/wrap-up.sh
@@ -6,7 +6,7 @@ if [[ "$MINIMIZE_DOWNTIME" ]]; then
   $dc restart relay
   $dc exec -T nginx nginx -s reload
 
-  docker run --rm --network="${COMPOSE_PROJECT_NAME}_default" alpine ash \
+  $CONTAINER_TECHNOLOGY run --rm --network="${COMPOSE_PROJECT_NAME}_default" alpine ash \
     -c 'while [[ "$(wget -T 1 -q -O- http://web:9000/_health/)" != "ok" ]]; do sleep 0.5; done'
 
   # Make sure everything is up. This should only touch relay and nginx
