@hypertegrity/node-red-contrib-k8s-helper/README.md

Node-RED tools for use in a containerized environment.

<br />
<p align="center">
    <h3 align="center">HYPERTEGRITY's Node-RED Kubernetes Helper</h3>
    <p align="center">
        Node-RED tools for use in containerized environments.
        <br />
        <br />
        <a href="https://github.com/HYPERTEGRITY-AG/node-red-contrib-k8s-helper/issues/new?assignees=&labels=type%3ABug%2Cstatus%3AUnconfirmed&template=BUG_REPORT.md&title=">Report Bug</a>
        ·
        <a href="https://github.com/HYPERTEGRITY-AG/node-red-contrib-k8s-helper/issues/new?assignees=&labels=type%3AEnhancement&template=FEATURE_REQUEST.md&title=">Request Feature</a>
        ·
        <a href="https://www.npmjs.com/package/@hypertegrity/node-red-contrib-k8s-helper">View on npm</a>
        ·
        <a href="https://flows.nodered.org/node/@hypertegrity/node-red-contrib-k8s-helper">View on Node-RED's Flow Library</a>
    </p>
</p>


## Supported custom nodes

-   [health checks](https://github.com/HYPERTEGRITY-AG/node-red-contrib-k8s-helper/blob/main/docs/custom_nodes/health-checks.md)
-   [watchdog](https://github.com/HYPERTEGRITY-AG/node-red-contrib-k8s-helper/blob/main/docs/custom_nodes/watchdog.md)

## Prerequisites

- npm

```sh
sudo npm install npm@latest -g
```

- node-red

```sh
sudo npm install -g --unsafe-perm node-red
```

## Installation

Run the following command on a command-line interface.

```sh
npm install @hypertegrity/node-red-contrib-k8s-helper
```

## Source code

-   [https://github.com/HYPERTEGRITY-AG/node-red-contrib-k8s-helper](https://github.com/HYPERTEGRITY-AG/node-red-contrib-k8s-helper)

## Roadmap

See the [open issues](https://github.com/HYPERTEGRITY-AG/node-red-contrib-k8s-helper/issues) for a list of proposed features (and known issues).

## Related links

- Documentation on Kubernetes Health Checks: [https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes)


## Copyright and License

Copyright (c) 2022 Will Freitag<br>
Licensed under the [MIT License](./LICENSE).