{"id":24569362,"url":"https://github.com/jvzeller/kube_probex","last_synced_at":"2025-03-17T05:45:34.675Z","repository":{"id":271801185,"uuid":"914440070","full_name":"JVZELLER/kube_probex","owner":"JVZELLER","description":"A lightweight Elixir library for defining Kubernetes HTTP probes in Phoenix applications.","archived":false,"fork":false,"pushed_at":"2025-01-25T14:25:43.000Z","size":48,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-11T17:52:15.226Z","etag":null,"topics":["elixir","kubenetes","plug"],"latest_commit_sha":null,"homepage":"https://hexdocs.pm/kube_probex","language":"Elixir","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/JVZELLER.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2025-01-09T15:48:25.000Z","updated_at":"2025-02-16T19:41:06.000Z","dependencies_parsed_at":"2025-01-10T01:17:51.029Z","dependency_job_id":"a6943b2a-bdb9-4976-b067-219ffeeca677","html_url":"https://github.com/JVZELLER/kube_probex","commit_stats":null,"previous_names":["jvzeller/k8s_livenex"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JVZELLER%2Fkube_probex","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JVZELLER%2Fkube_probex/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JVZELLER%2Fkube_probex/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JVZELLER%2Fkube_probex/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/JVZELLER","download_url":"https://codeload.github.com/JVZELLER/kube_probex/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243982139,"owners_count":20378606,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["elixir","kubenetes","plug"],"created_at":"2025-01-23T15:22:54.058Z","updated_at":"2025-03-17T05:45:34.662Z","avatar_url":"https://github.com/JVZELLER.png","language":"Elixir","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Kube Probex\n\n\n[![Build Status](https://github.com/jvzeller/kube_probex/actions/workflows/ci.yml/badge.svg)](https://github.com/jvzeller/kube_probex/actions) [![Hex.pm](https://img.shields.io/hexpm/v/kube_probex.svg)](https://hex.pm/packages/kube_probex) [![Documentation](https://img.shields.io/badge/documentation-gray)](https://hexdocs.pm/kube_probex/)\n\n`kube_probex` is a lightweight and flexible Elixir library designed to help define HTTP probes in Kubernetes for applications built using the Phoenix framework. It leverages Phoenix Plug to integrate seamlessly into your web application, making it easy to ensure that your services remain healthy and responsive in Kubernetes environments.\n\n## Features\n\n- **Simple Integration**: Add liveness, readiness, and startup probes to your Phoenix app with minimal configuration.\n- **Customizable Checks**: Define your own liveness, readiness, and startup probes logic to suit your application's needs.\n- **Kubernetes-Ready**: Built with Kubernetes probe endpoints in mind.\n- **Lightweight**: Minimal dependencies and easy to use.\n\n## Installation\n\nAdd `kube_probex` to your dependencies in `mix.exs`:\n\n```elixir\ndef deps do\n  [\n    {:kube_probex, \"~\u003e 0.1.0\"}\n  ]\nend\n```\n\nThen, fetch the dependencies:\n\n```bash\nmix deps.get\n```\n\n## Getting started\n\nTo use `kube_probex`, add it to your Phoenix endpoint or router as a plug:\n\n```elixir\n# lib/my_app_web/endpoint.ex\n\ndefmodule MyAppWeb.Endpoint do\n  use Phoenix.Endpoint, otp_app: :my_app_web\n\n  plug KubeProbex.Plug.Liveness, path: ~w(/_health /_healthz)\n  plug KubeProbex.Plug.Readiness, path: ~w(/_ready /_readyz), otp_apps: [:my_app]\nend\n```\n\nThis will expose:\n- A liveness probe endpoint at `/_health` and `/_healthz` paths.\n- A readiness probe endpoint at `/_ready` and `/_readyz` paths.\n\n## Contributing\n\nContributions are welcome! Feel free to open an issue or submit a pull request with improvements or bug fixes.\n\n### Running Tests\n\nTo run tests locally:\n\n```bash\nmix test\n```\n\n## License\n\n`kube_probex` is released under the MIT License.\n\n---\n\nStart defining your Kubernetes liveness probes easily and effectively with `kube_probex`!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjvzeller%2Fkube_probex","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjvzeller%2Fkube_probex","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjvzeller%2Fkube_probex/lists"}