Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/greguz/fastify-kubernetes
Fastify Kubernetes client plugin.
https://github.com/greguz/fastify-kubernetes
fastify k8s kubernetes
Last synced: 3 months ago
JSON representation
Fastify Kubernetes client plugin.
- Host: GitHub
- URL: https://github.com/greguz/fastify-kubernetes
- Owner: greguz
- License: mit
- Created: 2019-04-04T08:45:07.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-01-02T10:45:40.000Z (about 1 year ago)
- Last Synced: 2024-10-03T18:36:25.798Z (3 months ago)
- Topics: fastify, k8s, kubernetes
- Language: JavaScript
- Homepage:
- Size: 245 KB
- Stars: 9
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# fastify-kubernetes
[](https://badge.fury.io/js/fastify-kubernetes)
[](https://david-dm.org/greguz/fastify-kubernetes.svg)
[](https://standardjs.com)
Fastify Kubernetes client plugin.
This plugin uses the [official Node.js Kubernetes client](https://www.npmjs.com/package/@kubernetes/client-node) under the hood.
## Compatibility
The installed version of `@kubernetes/client-node` is the `v0.20.x`.
The targeted Kubernetes version is from the `v1.26` to `v1.28`.
For more info about supported Kubernetes version see [here](https://github.com/kubernetes-client/javascript#compatibility).
> Generally speaking newer clients will work with older Kubernetes, but compatability isn't 100% guaranteed.
## Install
```
npm install --save fastify-kubernetes
```
## Usage
Add it to your project with `register` and you are done!
```javascript
const fastify = require('fastify')()
fastify.register(require('fastify-kubernetes'), {
// Optional, defaults to OS default Kubeconfig file location
file: '/home/app/.kube/config',
// Context to use
context: 'production'
})
fastify.get('/pods', async function (req, reply) {
const client = this.kubernetes.api.CoreV1Api
const result = await client.listNamespacedPod(this.kubernetes.namespace)
reply.send(result.body.items)
})
fastify.listen(3000, err => {
if (err) throw err
})
```
## Options
All properties are optional.
- `kubeconfig`: Kubernetes config file loading mode. Default is `"auto"`.
- `"auto"`: Choose the first available mode in this order: Choose the first available config mode in this order: `"file"`, `"yaml"`, `"in-cluster"`, and `"default"`.
- `"default"`: Load config file the default OS location.
- `"file"`: Load config file from `file` option.
- `"in-cluster"`: Load in-cluster kubeconfig file.
- `"yaml"`: Load config from `yaml` option.
- `KubeConfig`: Load custom `KubeConfig` instance.
- `file`: Config file path.
- `yaml`: Config file content (string or buffer).
- `context`: Wanted context. If the context does not exist, an error will be thrown.
- `cluster`: Wanted cluster. If the cluster does not exist, an error will be thrown.
- `user`: Wanted user. If the user does not exist, an error will be thrown.
- `namespace`: Wanted namespace.
> A `name` option can be used in order to connect to multiple kubernetes clusters.
```javascript
const fastify = require('fastify')()
fastify
.register(require('fastify-kubernetes'), {
context: 'eu-cluster-0',
name: 'eu'
})
.register(require('fastify-kubernetes'), {
context: 'us-cluster-0',
name: 'us'
})
fastify.get('/', async function (req, reply) {
const euClient = this.kubernetes.eu.api.CoreV1Api
const usClient = this.kubernetes.us.api.CoreV1Api
// ------------
// do your stuff here
// ------------
reply.send(yourResult)
})
```
## Reference
The plugin will inject six properties under `kubernetes` decorator.
- `config` is the `KubeConfig` instance
- `context` is the current context name
- `cluster` is the context's cluster
- `user` is the context's user
- `namespace` is the context's namespace, defaults to `"default"`
- `api` is an object containing all possible client types
### API
You can retrieve a client by its original name from the kubernetes lib.
```javascript
const client0 = this.kubernetes.api.CoreV1Api
const client1 = this.kubernetes.api.BatchV1Api
const client2 = this.kubernetes.api.BatchV1beta1Api
```