https://github.com/jasonmccallister/craft-healthz

Add health checks to your Craft site, useful when running Docker or Kubernetes
https://github.com/jasonmccallister/craft-healthz

craftcms docker health-check healthz kubernetes

Last synced: about 1 month ago
JSON representation

Add health checks to your Craft site, useful when running Docker or Kubernetes

• Host: GitHub
• URL: https://github.com/jasonmccallister/craft-healthz
• Owner: jasonmccallister
• License: mit
• Created: 2019-06-18T07:14:12.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2022-11-30T04:06:33.000Z (almost 2 years ago)
• Last Synced: 2024-08-14T03:25:48.233Z (3 months ago)
• Topics: craftcms, docker, health-check, healthz, kubernetes
• Language: PHP
• Homepage:
• Size: 138 KB
• Stars: 4
• Watchers: 2
• Forks: 6
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Healthz

Add Kubernetes style health checks to your Craft site.

![Healthz Logo](resources/img/plugin-logo.png)

## Requirements

This plugin requires Craft CMS 3.0.0-beta.23 or later.

## Installation

To install the plugin, follow these instructions.

1.  Open your terminal and go to your Craft project:

        cd /path/to/project

2.  Then tell Composer to load the plugin:

        composer require mccallister/healthz

3.  In the Control Panel, go to Settings → Plugins and click the “Install” button for Healthz.

## Health Check Overview

This plugin will provide an endpoint that allows health checks on Docker or Kubernetes workflows. Since Kubernetes is eating the world, it defaults to `healthz/liveness`, which is the default for Kubernetes.

## Using Health Check

Setup your Kubernetes and choose the default health check url (e.g. `healthz/liveness` or `healthz/readiness`).

Brought to you by [Jason McCallister](https://mccallister.io)