Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ducktors/arecibo
Fastify ping responder for Kubernetes Liveness and Readiness Probes
https://github.com/ducktors/arecibo
fastify fastify-plugin kubernetes kubernetes-monitoring pinger readiness-probes
Last synced: 11 days ago
JSON representation
Fastify ping responder for Kubernetes Liveness and Readiness Probes
- Host: GitHub
- URL: https://github.com/ducktors/arecibo
- Owner: ducktors
- License: mit
- Created: 2018-08-30T09:04:25.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-12-15T10:17:56.000Z (11 months ago)
- Last Synced: 2024-03-15T12:53:07.241Z (8 months ago)
- Topics: fastify, fastify-plugin, kubernetes, kubernetes-monitoring, pinger, readiness-probes
- Language: TypeScript
- Homepage:
- Size: 367 KB
- Stars: 29
- Watchers: 3
- Forks: 7
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
---
---
[](https://www.npmjs.com/package/arecibo)
[](https://www.npmjs.com/package/arecibo)
[](https://github.com/prettier/prettier)
[](https://snyk.io/test/github/ducktors/arecibo?targetFile=package.json)
## Installation
__Note: Arecibo version 1 supports version 2 of Fastify. Arecibo version 2 supports version 3 of Fastify.__
| Arecibo version | Fastify version | Branch |
| -- | -- | -- |
| [v2](https://github.com/ducktors/arecibo/releases/tag/v2.2.0) | Fastify 3 & 4 | [master](https://github.com/ducktors/arecibo/tree/master) |
| [v1.1.0](https://github.com/ducktors/arecibo/releases/tag/v1.1.0) | Fastify 2 | deprecated |
```bash
npm i arecibo
```
## Usage in Node.js
```javascript
const arecibo = require('arecibo')
// or import arecibo from 'arecibo'
// or import * as arecibo from 'arecibo'
fastify.register(arecibo, {
message: 'Put here your custom message', // optional, default to original arecibo message
readinessURL: '/put/here/your/custom/url', // optional, deafult to /arecibo/readiness
livenessURL: '/put/here/your/custom/url', // optional, deafult to /arecibo/liveness
readinessCallback: (req, reply) => reply.type('text/html').send('Put here your custom message'), // optional
livenessCallback: (req, reply) => reply.type('text/html').send('Put here your custom message'), // optional
logLevel: 'error', // optional, defaults to 'info'; can be trace, debug, info, warn, error, and fatal
})
```
### Note for typescript users
If you set `"esModuleInterop": true` you must import this module using `import arecibo from 'arecibo'`.
## On Kubernetes add deployment manifest
```yaml
...
livenessProbe:
httpGet:
path: /arecibo/liveness
port: 80
httpHeaders:
- name: X-Custom-Header
value: Awesome
initialDelaySeconds: 15
timeoutSeconds: 1
periodSeconds: 15
readinessProbe:
httpGet:
path: /arecibo/readiness
port: 80
httpHeaders:
- name: X-Custom-Header
value: Awesome
initialDelaySeconds: 5
timeoutSeconds: 1
periodSeconds: 15
...
```
## How to commit
This repo uses [Semantic Release](https://github.com/semantic-release/semantic-release) with Conventional Commits.
Releases are automatically created based on the type of commit message: feat for minor and fix for patch.
```
feat: new feature ---> 1.x.0
fix: fix a bug ---> 1.0.x
```
## Reference
* Fastify
* Configure Liveness and Readiness Probes
* Kubernetes Health Checks with Readiness and Liveness Probes (Kubernetes Best Practices)
## Fun fact: where does the name come from?
The name is inspired by the Arecibo message, a 1974 interstellar radio message carrying basic information about humanity and Earth sent to globular star cluster M13 in the hope that extraterrestrial intelligence might receive and decipher it. The message was broadcast into space a single time via frequency modulated radio waves at a ceremony to mark the remodelling of the Arecibo radio telescope in Puerto Rico on 16 November 1974.