feat(install): Adds support for podman(compose) #3673

DuncanConroy · 2025-04-22T12:42:03Z

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

Introduces a new script to detect podman vs. docker. Distinguishes between docker and podman minimum versions and substitutes uses of docker with a variable instead.

Closes #369

Legal Boilerplate

Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.

…mpatibility with docker

BYK

Quite surprised (positively!) that the changes needed are so few! Added a few comments and on top of those, we definitely should have a test using podman now to make sure this actually works and does not break in the future (can help with this if you need me).

Thanks so much for taking the effort!

install.sh

install/detect-container-technology.sh

BYK

Oops, sorry meant the require changes 😅

BYK · 2025-04-22T20:04:27Z

FYI tests failed with the following error:

Detecting Docker platform
FAIL: Unsupported docker architecture amd64.

DuncanConroy · 2025-04-23T10:18:23Z

Quite surprised (positively!) that the changes needed are so few! Added a few comments and on top of those, we definitely should have a test using podman now to make sure this actually works and does not break in the future (can help with this if you need me).

Thanks so much for taking the effort!

I agree that having a test would be great. In the best case, we can run the whole suite for both docker and podman. I'm just unsure about the environment this is run on and would welcome your input and ideas very much!

…pose build; Substitutes occurences of

DuncanConroy · 2025-04-23T13:04:03Z

Have converted back to draft, as there are some tweaks to make, still.

aldy505 · 2025-04-23T13:07:35Z

@DuncanConroy Let us know if you need help in terms of anything, we'd be happy to help you. Having this PR really made us happy :)

…mpose

BYK

Tests are run on GitHub Actions. I'm happy to add a new job that installs and runs with podman once the PR is stable in terms of API

install/detect-container-engine.sh

BYK · 2025-04-23T21:27:03Z

install/parse-cli.sh

@@ -29,6 +29,8 @@ Options:
 --no-report-self-hosted-issues
                        Do not report error and performance data about your
                          self-hosted instance upstream to Sentry.
+ --container-engine-podman


Same as above: how about this just being --container-engine with a default value of docker?

Not sure I understand your intent. This was thought as a switch to activate podman over docker. We can surely remove the autodetection and completely rely on this switch. I'd still keep it --container-engine-podman, because just using --container-engine would possibly be misleading?

@DuncanConroy sorry for not being clearer. What I had in mind was making --container-engine a flag to pass in a custom value as in --container-engine <engine> where we default to docker (so when the flag is not passed, we will assume docker).

Although we would only support podman and docker at start, this should keep the API unchanged if we ever add new engines like runc or similar.

Not sure how to do this with bash, tbh. :D

I'll see what I can do about this 😅

It is quite simple... unless you want to validate argument :)
Something like

case "$1" in <...> --container-engine) CONTAINER_ENGINE="$2"; shift ;;

Modifies docker-compose.yml with pull_policy: never, which also works for podman-compose.

…ait_ready function

aminvakil

Thank you for this!

sentry-admin.sh file needs to be fixed as well, I guess adding source install/detect-container-engine.sh suffices.

BYK · 2025-05-07T21:25:36Z

Okay, now we need to make the tests aware of Podman

doc-sheet · 2025-05-08T09:46:32Z

If podman-comose compatible enough podman-docker package could help.
It creates system-wide alias docker -> podman

aldy505 · 2025-06-11T15:11:09Z

Okay, now we need to make the tests aware of Podman

@BYK do you still remember what you mean by this?

BYK · 2025-06-11T19:35:56Z

@aldy505 the tests written in Python assume everything with Docker and Docker Compose. They now need to be aware of what technology we're using. See the fail here: https://github.com/getsentry/self-hosted/actions/runs/14893466765/job/41831036774?pr=3673#step:4:2280

aldy505 · 2025-06-13T15:01:49Z

@DuncanConroy FYI, I'll revisit this after 25.6.0 release, since it has too much big changes already 😆

doc-sheet · 2025-06-22T06:48:53Z

UPD. Nevermind it's incomplete yet

Hi!
Here is rough workaround for tests https://github.com/doc-sheet/self-hosted/compare/podman-tests-base...doc-sheet:self-hosted:podman-tests?expand=1#files

Since podman works without root privileges

it requires nofile ulimits for current user higher then limits declared for containers
chown don't work

Additional notes for future me:

separate caches
conflicting ports

aldy505 · 2025-06-25T13:25:56Z

@doc-sheet do you wanna work on the tests? We can merge this PR first, then when it's on master you can submit your PR for podman tests.

aldy505 · 2025-06-25T13:37:40Z

Why is this broken..

Ensuring correct permissions on profiles directory ...

Executing external compose provider "podman-compose". Please refer to the documentation for details. <<<<

WARNING:podman_compose:missing services [vroom]
Error: executing podman-compose --no-ansi --env-file .env --in-pod=false run --rm --no-deps --entrypoint /bin/bash --user root vroom -c chown -R vroom:vroom /var/vroom/sentry-profiles && chmod -R o+rwx /var/vroom/sentry-profiles: exit status 1
Error in install/ensure-correct-permissions-profiles-dir.sh:6.
'$dcr --no-deps --entrypoint /bin/bash --user root vroom -c 'chown -R vroom:vroom /var/vroom/sentry-profiles && chmod -R o+rwx /var/vroom/sentry-profiles'' exited with status 1
yes: standard output: Broken pipe
yes: standard output: Broken pipe
-> ./install.sh:main:41
--> install/ensure-correct-permissions-profiles-dir.sh:source:6

doc-sheet · 2025-06-25T14:00:58Z

Why is this broken..

because podman is rootless, :U is a workaround which works with docker-compose too I suppose

do you wanna work on the tests? We can merge this PR first, then when it's on master you can submit your PR for podman tests.

well I'm trying to make tests pass, but don't have much time this days to research.
I'm stuck with nofile restriction and can't figure it out how to increase limit in github action runner.

I don't think it is ready to be merged because of new changes like chown.
But if install works and it is ok to skip podman tests until complete fix I'm totally fine with it.

aldy505 · 2025-06-25T14:05:35Z

Interesting, it didn't try to pull vroom at all

>>>> Executing external compose provider "podman-compose". Please refer to the documentation for details. <<<<
  Resolving "nginx" using unqualified-search registries (/etc/containers/registries.conf)
  Trying to pull docker.io/library/nginx:1.25.4-alpine...
  Trying to pull registry.gitlab.com/egos-tech/smtp:latest...
  Resolving "memcached" using unqualified-search registries (/etc/containers/registries.conf)
  Trying to pull docker.io/library/memcached:1.6.26-alpine...
  Resolving "getsentry/symbolicator" using unqualified-search registries (/etc/containers/registries.conf)
  Trying to pull docker.io/getsentry/symbolicator:nightly...
  Resolving "getsentry/snuba" using unqualified-search registries (/etc/containers/registries.conf)
  Trying to pull docker.io/getsentry/snuba:nightly...
  Resolving "confluentinc/cp-kafka" using unqualified-search registries (/etc/containers/registries.conf)
  Trying to pull docker.io/confluentinc/cp-kafka:7.6.1...
  Resolving "getsentry/taskbroker" using unqualified-search registries (/etc/containers/registries.conf)
  Trying to pull docker.io/getsentry/taskbroker:nightly...
  Resolving "postgres" using unqualified-search registries (/etc/containers/registries.conf)
  Trying to pull docker.io/library/postgres:14.11...
  Trying to pull docker.io/getsentry/relay:nightly...
  Resolving "redis" using unqualified-search registries (/etc/containers/registries.conf)
  Trying to pull docker.io/library/redis:6.2.14-alpine...
  ...truncated...
  Resolving "getsentry/sentry" using unqualified-search registries (/etc/containers/registries.conf)
  Trying to pull docker.io/getsentry/sentry:nightly...
  ...truncated...

aldy505 · 2025-06-25T14:08:10Z

do you wanna work on the tests? We can merge this PR first, then when it's on master you can submit your PR for podman tests.

well I'm trying to make tests pass, but don't have much time this days to research. I'm stuck with nofile restriction and can't figure it out how to increase limit in github action runner.

what is "nofile restriction"?

I don't think it is ready to be merged because of new changes like chown. But if install works and it is ok to skip podman tests until complete fix I'm totally fine with it.

okay 👍

aldy505 · 2025-06-25T14:16:00Z

do you wanna work on the tests? We can merge this PR first, then when it's on master you can submit your PR for podman tests.

well I'm trying to make tests pass, but don't have much time this days to research. I'm stuck with nofile restriction and can't figure it out how to increase limit in github action runner.

what is "nofile restriction"?

ah you mean nofile limits on linux..

aldy505 · 2025-06-25T14:19:27Z

Ah I see the problem now. vroom is behind feature-complete profiles, yet podman only supports passing in the --profile arg. Setting the environment variables does nothing basically. Refer to this PR containers/podman-compose#592

…t won't work

doc-sheet · 2025-06-26T09:36:32Z

Another bug in podman-compose containers/podman-compose#1118 I stepped on.

aldy505 · 2025-06-26T13:17:30Z

ughh I wanna skip the test

feat(install): Adds support for podman(compose), while maintaining co…

d87c155

…mpatibility with docker

github-project-automation bot added this to Self-hosted Sentry Apr 22, 2025

BYK approved these changes Apr 22, 2025

View reviewed changes

install.sh Outdated Show resolved Hide resolved

install/detect-container-technology.sh Outdated Show resolved Hide resolved

BYK requested changes Apr 22, 2025

View reviewed changes

Daniel Bunte added 2 commits April 23, 2025 09:36

Renames container-technology -> container-engine

cd24311

Adds feature flag to enable podman; fixes test runner

64c9741

Daniel Bunte added 2 commits April 23, 2025 12:26

fix(install): platform detection for amd64

8034a6e

fix(install): Adds separate prox-args for podman build vs. podman-com…

0fca38e

…pose build; Substitutes occurences of

DuncanConroy force-pushed the master branch from f9649f7 to 0fca38e Compare April 23, 2025 11:48

DuncanConroy marked this pull request as draft April 23, 2025 13:03

Daniel Bunte added 3 commits April 23, 2025 15:17

fix(install): Substitues docker compose --rmi for podman

d98e2fb

fix(install): handling of ps command for docker compose vs. podman-co…

27e524d

…mpose

fix(install): Susbstitutes docker compose --wait for podman

d711b5b

BYK reviewed Apr 23, 2025

View reviewed changes

Daniel Bunte added 10 commits April 24, 2025 09:21

fix(install): Substitues occurence of docker run with run

0e5e24e

fix(install): docker substitutions

f89f0c2

fix(install): substitues docker volume create with correct syntax

7c886c9

fix(install): remove dangling images under podman on compose down

8039e03

fix(install): Replaces how images are pulled

00f4c81

Modifies docker-compose.yml with pull_policy: never, which also works for podman-compose.

fix(install): Substitues up <service> --wait with start_service_and_w…

b467a55

…ait_ready function

fix(install): run podman-compose up with --force-recreate

b9bff98

fix(install): start_service_and_Wait_ready uses daemonized start

8185732

fix(install): multiple merge instrtuctions in docker-compose.yml

3bd844c

fix(install): Substitute --force-rm for podman

fc3d976

aminvakil reviewed Apr 25, 2025

View reviewed changes

chore(install): simplify container-engine selection

059f0c7

BYK added 4 commits May 7, 2025 20:54

try no quotes at all

fe231a4

well, it should be --podman-build

ca40557

we don't need this as default is true

dbe912d

--force-rm is no longer anyway

a2792f7

aldy505 mentioned this pull request May 15, 2025

Ongoing Work & Feedback #3625

Open

11 tasks

doc-sheet mentioned this pull request May 24, 2025

add shellcheck action to lint bash scripts #3710

Merged

Merge branch 'master' into master

69d76b2

Merge branch 'master' into master

9f9add5

explicitly set compose profiles to feature complete

5ebfd90

add COMPOSE_PROFILES into CI env vars

fba8afc

should be COMPOSE_PROFILES

1aaaadc

aldy505 added 2 commits June 25, 2025 21:21

specify --profile argument instead of environment variable, since i…

82944e0

…t won't work

specify profile arg on dcr declaration

33d7596

Merge branch 'master' into master

091d949

provide --profile flag on wrap-up

149a822

Uh oh!

feat(install): Adds support for podman(compose) #3673

Are you sure you want to change the base?

feat(install): Adds support for podman(compose) #3673

Conversation

DuncanConroy commented Apr 22, 2025

Legal Boilerplate

Uh oh!

BYK left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

BYK left a comment

Choose a reason for hiding this comment

Uh oh!

BYK commented Apr 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

DuncanConroy commented Apr 23, 2025

Uh oh!

DuncanConroy commented Apr 23, 2025

Uh oh!

aldy505 commented Apr 23, 2025

Uh oh!

BYK left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

BYK Apr 23, 2025

Choose a reason for hiding this comment

Uh oh!

DuncanConroy Apr 25, 2025

Choose a reason for hiding this comment

Uh oh!

BYK Apr 28, 2025

Choose a reason for hiding this comment

Uh oh!

DuncanConroy Apr 28, 2025

Choose a reason for hiding this comment

Uh oh!

BYK Apr 28, 2025

Choose a reason for hiding this comment

Uh oh!

doc-sheet Apr 28, 2025

Choose a reason for hiding this comment

Uh oh!

aminvakil left a comment

Choose a reason for hiding this comment

Uh oh!

BYK commented May 7, 2025

Uh oh!

doc-sheet commented May 8, 2025

Uh oh!

aldy505 commented Jun 11, 2025

Uh oh!

BYK commented Jun 11, 2025

Uh oh!

aldy505 commented Jun 13, 2025

Uh oh!

doc-sheet commented Jun 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

aldy505 commented Jun 25, 2025

Uh oh!

aldy505 commented Jun 25, 2025

Uh oh!

doc-sheet commented Jun 25, 2025

Uh oh!

aldy505 commented Jun 25, 2025

Uh oh!

aldy505 commented Jun 25, 2025

Uh oh!

aldy505 commented Jun 25, 2025

Uh oh!

aldy505 commented Jun 25, 2025

Uh oh!

doc-sheet commented Jun 26, 2025

Uh oh!

aldy505 commented Jun 26, 2025

BYK commented Apr 22, 2025 •

edited

Loading

doc-sheet commented Jun 22, 2025 •

edited

Loading