paketo-buildpacks / health-checker

A Cloud Native Buildpack that provides a health check binary compatible with Docker health checks
Apache License 2.0
6 stars 0 forks source link

Remove process type #137

Closed dmikusa closed 3 months ago

dmikusa commented 3 months ago

Summary

This PR removes the process type contributed by the health checker buildpack. This was problematic in that it would trigger the exec.d helpers to run every time the health check was run, which caused issues.

Instead, we install the health check binary, print the path at which it's installed and one can invoke it directly. Then we attempt to create a symlink to the health check binary under /workspace/health-check. This is then the shortcut that one can use to easily invoke the health check binary.

This is flagged as a major change as it removes the process type, which could break health checks for users if they are invoking the process type.

Use Cases

Resolves #134

Checklist

rdfedor commented 2 months ago

I imagine this will be a breaking change for many people like myself who recently introduced this into their projects. it changed how the health-check command is being executed because previously it was a global command so in the container health check you could just use "health-check" and it'd execute the check but since this change it has broken how it works and now requires a change to "./health-check" otherwise the service won't stay up.

dmikusa commented 2 months ago

@rdfedor Yes, 100%. If you pin to https://github.com/paketo-buildpacks/health-checker/releases/tag/v1.17.0 then you can control when you update and make this change.

You can use docker.io/paketobuildpacks/health-checker:1 for the buildpack to pin to the 1.x branch. i.e. pack build -b docker.io/paketobuildpacks/health-checker:1 ....

We released it in https://github.com/paketo-buildpacks/health-checker/releases/tag/v2.0.0, so the 2.x branch will require you to update.