mccallister/healthz

Add health checks to your Craft website, useful when running inside of Docker

Maintainers

Details

github.com/jasonmccallister/craft-healthz

Source

Issues

Documentation

Installs: 5 687

Dependents: 0

Suggesters: 0

Security: 0

Stars: 4

Watchers: 2

Forks: 6

Open Issues: 0

Type:craft-plugin

v1.0.3 2019-11-19 17:55 UTC

Requires

MIT 68b91fee8712aa9dfd396adca6b59a1014f5f841

cmshealthload balancerdockerCraftkubernetescraftcmshealth checkcraft-plugin

This package is auto-updated.

Last update: 2024-10-29 05:11:12 UTC

README

Add Kubernetes style health checks to your Craft site.

Healthz Logo

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