Socket
Socket
Sign inDemoInstall

kube-probe

Package Overview
Dependencies
3
Maintainers
7
Versions
14
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    kube-probe

connect.js middleware that sets up generic liveness and readiness probes for Openshift/Kubernetes


Version published
Maintainers
7
Install size
3.74 MB
Created

Changelog

Source

1.0.3 (2021-07-28)

Bug Fixes

  • upgrade eslint from 7.15.0 to 7.16.0 (#137) (3d328ff)
  • upgrade eslint from 7.16.0 to 7.17.0 (#141) (84ff6a6)
  • upgrade eslint from 7.17.0 to 7.19.0 (#144) (f22980d)
  • upgrade eslint from 7.19.0 to 7.20.0 (#145) (4a2a83f)
  • upgrade eslint-plugin-promise from 4.2.1 to 4.3.1 (#143) (bef0d8c)
  • upgrade standard-version from 9.0.0 to 9.1.0 (#140) (985b9cd)
  • upgrade standard-version from 9.1.0 to 9.1.1 (#146) (534efdc)
  • upgrade tape from 5.0.1 to 5.1.0 (#139) (011629c)
  • upgrade tape from 5.1.0 to 5.1.1 (#142) (25c1a98)
  • upgrade tape from 5.1.1 to 5.2.0 (#147) (f934b39)

Readme

Source

This module is deprecated.

Build Status Coverage Status Greenkeeper badge Connect middleware that sets up generic liveness and readiness probes for OpenShift/Kubernetes

Example Usage:

const express = require('express');
const app = express();

const probe = require('kube-probe');

probe(app);

This will add 2 GET endpoints /api/health/liveness and /api/health/readiness that will return a 200 OK response. This module uses overload-protection to identify when a process may be overloaded, and will return HTTP 503 Service Unavailable if the service becomes too heavily loaded. Configuration of the protection-config module may be passed as options.protectionConfig.

See: https://github.com/davidmarkclements/overload-protection/

Parameters
  • app - an instance of a connect-based framework (e.g. express.js) - required

  • options - optional

  • options.readinessURL - string - url where the readiness probe is located

  • options.livenessURL - string - url where the livenessURL probe is located

  • options.readinessCallback - function - function to call when the readiness probe is triggered

  • options.livenessCallback - function - function to call when the liveness probe is triggered

  • options.bypassProtection - boolean - kube-probe will bypass protection (defaults to false)

  • options.protectionConfig - object - options passed direction to overload-protection

Environment Variables
  • KUBE_PROBE_BYPASS_PROTECTION - boolean - kube-probe will bypass protection

Keywords

FAQs

Last updated on 28 Jul 2021

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc