Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move healthcheck into Dockerfile #348

Merged
merged 4 commits into from
Oct 17, 2024

Conversation

voruti
Copy link
Contributor

@voruti voruti commented Sep 28, 2024

... thus the health check is also available when using a simple docker run ....

Or does something speak against it @wolveix @dieser-niko @ashfire908 ?

@ashfire908
Copy link
Contributor

ashfire908 commented Sep 28, 2024

My concern is (and has been) if this will cause any deployments to automatically restart if they don't successfully start up in 2 minutes (ie still downloading from steam due to slow internet). I tested docker-compose, and I assume docker run is the exact same. I looked into Kubernetes, as there is some k8s resources under cluster/. Kubernetes explicitly ignores the HEALTHCHECK declaration in dockerfiles in favor of liveness and readiness probes, which is good because Kubernetes would 100% run into the issue I was worrying about if HEALTHCHECK mapped to liveness. So this looks good to me.

Long term, it might make sense to use a combination of liveness, readiness, and startup probes to cover the expected lifecycle of a Satisfactory pod. But that's an issue that can be tackled in the future. I might make a stab at this at some point, although I currently just run Satisfactory on a stack of Docker/Compose/Portainer, so I don't have a personal use myself (I use Kubernetes heavily in my day job, though).

tl;dr I think this is good and won't cause any restart issues within the environments of Docker, Docker Compose, or the provided Kubernetes resources.

@dieser-niko
Copy link
Contributor

dieser-niko commented Sep 28, 2024

I kind of like the idea of having the health check built into the Dockerfile, I just didn't know it existed.
As for the parameters, you didn't specify interval and retries. Even though the values are the same as the defaults, I think they could still be included if someone wants to play around with these values. What do the others think about that?

@schildbach
Copy link
Contributor

I generally do this with my own Docker projects and think it is a good idea.

One possible pitfall is that if people run this behind a reverse proxy like traefik, those proxies usually only forward traffic until the container is "healthy", which depending on the healthcheck parameters may take a minute or two.

@wolveix wolveix merged commit b426a61 into wolveix:main Oct 17, 2024
2 checks passed
@wolveix
Copy link
Owner

wolveix commented Oct 17, 2024

Thanks :)

@voruti voruti deleted the healthcheck-in-dockerfile branch October 17, 2024 12:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants