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

standardize container health checks into scripts for all docker containers #491

Open
mmguero opened this issue Nov 7, 2024 · 1 comment
Labels
cloud Relating to deployment of Malcolm in the cloud and/or with Kubernetes docker Relating to docker and docker-compose as used by Malcolm enhancement New feature or request
Milestone

Comments

@mmguero
Copy link
Collaborator

mmguero commented Nov 7, 2024

The docker-compose.yml and Kubernetes health checks do various things to gauge container health, but I would like to standardize how this is done.

I'd like every container to have a container_health.sh script installed to /usr/local/bin. This script should exit with an exit code of 0 if things are healthy/up/ready and non-zero if they are not.

In addition to creating the scripts, replacing the health checks in the compose file and Kubernetes manifests to call the scripts should be done.

The zeek container already has one of these you could use as reference. Also, the ready function in the API would be a good example of things to check.

@mmguero mmguero added cloud Relating to deployment of Malcolm in the cloud and/or with Kubernetes docker Relating to docker and docker-compose as used by Malcolm enhancement New feature or request labels Nov 7, 2024
@mmguero mmguero added this to the z.staging milestone Nov 7, 2024
@mmguero mmguero added this to Malcolm Nov 7, 2024
@mmguero mmguero moved this to Todo (develop) in Malcolm Nov 7, 2024
@mmguero mmguero modified the milestones: z.staging, v24.12.0 Nov 14, 2024
@mmguero
Copy link
Collaborator Author

mmguero commented Nov 18, 2024

To clarify, this is already done for the logstash and zeek/zeek-live containers.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cloud Relating to deployment of Malcolm in the cloud and/or with Kubernetes docker Relating to docker and docker-compose as used by Malcolm enhancement New feature or request
Projects
Status: Todo (develop)
Development

No branches or pull requests

1 participant