Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/Eileen-Yu/kb-js-plugin

A sample external plugin for kubebuilder in JavaScript.
https://github.com/Eileen-Yu/kb-js-plugin

Last synced: 3 months ago
JSON representation

A sample external plugin for kubebuilder in JavaScript.

Host: GitHub
URL: https://github.com/Eileen-Yu/kb-js-plugin
Owner: Eileen-Yu
Created: 2023-06-23T03:12:21.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2023-09-16T04:28:48.000Z (about 1 year ago)
Last Synced: 2024-06-11T00:13:12.936Z (5 months ago)
Language: JavaScript
Size: 76.2 KB
Stars: 1
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# An External Plugin for Kubebuilder

A sample external plugin written in Javascript.

## Quick Start

1. Build the js plugin into an executable
```shell
# Install Dependencies
npm ci

# Build an executable into dist/kb-js-plugin/v1/kb-js-plugin
npm run build
```

2. Load the plugin and run kb command

```shell
# 1. Display help info for `init` / `create api` / `create webhook` / `edit` subcommand
EXTERNAL_PLUGINS_PATH=/Users/eileen/programming/kb-js-plugin/dist/ \
kubebuilder init --plugins=kb-js-plugin/v1 --help

EXTERNAL_PLUGINS_PATH=/Users/eileen/programming/kb-js-plugin/dist/ \
kubebuilder create api --plugins=kb-js-plugin/v1 --help

EXTERNAL_PLUGINS_PATH=/Users/eileen/programming/kb-js-plugin/dist/ \
kubebuilder create webhook --plugins=kb-js-plugin/v1 --help

EXTERNAL_PLUGINS_PATH=/Users/eileen/programming/kb-js-plugin/dist/ \
kubebuilder edit --plugins=kb-js-plugin/v1 --help

# 2. scaffold the project by `init` subcommand with valid flag `--domain`
EXTERNAL_PLUGINS_PATH=/Users/eileen/programming/kb-js-plugin/dist/ \
kubebuilder init --plugins=kb-js-plugin/v1 --domain eileen.io

# 3. create an api for the project by `create api` subcommand with GVK
EXTERNAL_PLUGINS_PATH=/Users/eileen/programming/kb-js-plugin/dist/ \
kubebuilder create api --plugins=kb-js-plugin/v1 --group webapp --version v1 --kind Guestbook

# 4. create a webhook for the project by `create webhook` subcommand with GVK
EXTERNAL_PLUGINS_PATH=/Users/eileen/programming/kb-js-plugin/dist/ \
kubebuilder create webhook --plugins=kb-js-plugin/v1 --group webapp --version v1 --kind Guestbook

# 5. update the api for the project by `edit` subcommand
EXTERNAL_PLUGINS_PATH=/Users/eileen/programming/kb-js-plugin/dist/ \
kubebuilder edit --plugins=kb-js-plugin/v1

```

3. Check the output

The plugin triggered by `init` will generate the PROJECT file, and another file `initFile` with the domain you specified.

The plugin triggered by `create api` will generate a file `apiFile` with the GVK you specified.

The plugin triggered by `create webhook` will generate a file `webhookFile` with the GVK you specified.

The plugin triggered by `edit` will update the `apiFile`.

## Showcase

![output](https://github.com/kubernetes-sigs/kubebuilder/assets/48944635/1aac358e-6488-4166-bdef-0b73d916423a)

## More info

- [Tutorial for writing the external plugin with this JS sample](https://eileen.hungry-mg.site/post/how-to-extend-kubebuilder-by-writing-an-external-plugin/)
- [KB book](https://book.kubebuilder.io/plugins/external-plugins)