https://github.com/kubesphere/ksbuilder
A CLI tool helps you to manage the development of kubesphere extensions
https://github.com/kubesphere/ksbuilder
Last synced: 2 months ago
JSON representation
A CLI tool helps you to manage the development of kubesphere extensions
- Host: GitHub
- URL: https://github.com/kubesphere/ksbuilder
- Owner: kubesphere
- License: mit
- Created: 2022-07-25T02:20:33.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2024-04-12T16:27:08.000Z (about 1 year ago)
- Last Synced: 2024-04-13T21:23:21.606Z (about 1 year ago)
- Language: Go
- Homepage:
- Size: 272 KB
- Stars: 9
- Watchers: 7
- Forks: 19
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Introduction
ksbuilder is a CLI tool to create, publish, and manage KubeSphere extensions.
## Install
Download the [latest ksbuilder release](https://github.com/kubesphere/ksbuilder/releases) and then install it to `/usr/local/bin`:
```shell
tar xvzf ksbuilder__.tar.gz -C /usr/local/bin/
```
## Create your first KubeSphere extension
You can use `ksbuilder create` to create a KubeSphere extension interactively.
```
$ cd
$ ksbuilder create
Please input extension name: test
✔ ai-machine-learning
Please input extension author: ia
Please input Email (optional):
Please input author's URL (optional):
Directory: /path/test
The extension charts has been created.
```
The extension directory created looks like below:
```
.
├── README.md
├── README_zh.md
├── applicationclass.yaml
├── charts
│ ├── backend
│ │ ├── Chart.yaml
│ │ ├── templates
│ │ │ ├── NOTES.txt
│ │ │ ├── deployment.yaml
│ │ │ ├── extensions.yaml
│ │ │ ├── helps.tpl
│ │ │ ├── service.yaml
│ │ │ └── tests
│ │ │ └── test-connection.yaml
│ │ └── values.yaml
│ └── frontend
│ ├── Chart.yaml
│ ├── templates
│ │ ├── NOTES.txt
│ │ ├── deployment.yaml
│ │ ├── extensions.yaml
│ │ ├── helps.tpl
│ │ ├── service.yaml
│ │ └── tests
│ │ └── test-connection.yaml
│ └── values.yaml
├── extension.yaml
├── permissions.yaml
├── static
│ ├── favicon.svg
│ └── screenshots
│ └── screenshot.png
└── values.yaml
```
Then you can customize your extension like below:
- Specify the default backend and frontend images
```
frontend:
enabled: true
image:
repository: /
tag: latest
backend:
enabled: true
image:
repository: /
tag: latest
```
- Add `APIService` definition to the backend `extensions.yaml`
```yaml
apiVersion: extensions.kubesphere.io/v1alpha1
kind: APIService
metadata:
name: v1alpha1..kubesphere.io
spec:
group: .kubesphere.io
version: v1alpha1
url: http://-backend.default.svc:8080
status:
state: Available
```
- Add `JSBundle` definition to the frontend `extensions.yaml`
```yaml
apiVersion: extensions.kubesphere.io/v1alpha1
kind: JSBundle
metadata:
name: v1alpha1..kubesphere.io
spec:
rawFrom:
url: http://-frontend.default.svc/dist/-frontend/index.js
status:
state: Available
link: /dist/-frontend/index.js
```
## Publish/Unpublish your KubeSphere extension
You can publish/unpublish KubeSphere extension to KubeSphere cluster once it's ready:
```shell
ksbuilder publish/unpublish
```
## Push and submit your extension to KubeSphere Cloud
### Create API access token
1. Register an account on [KubeSphere Cloud](https://kubesphere.cloud).
2. Open [KubeSphere Marketplace](https://kubesphere.co/marketplace/), click on "Become a service provider," sign the agreement, and become an extension service provider (i.e., developer).
3. Open [https://kubesphere.cloud/user/setting/](https://kubesphere.cloud/user/setting/), click on "Security," then click "Create Token," check "Extension Component," and click "Generate." The generated token is the cloud API key, formatted like `kck-xxx`. Please keep it safe.
### Login to KubeSphere Cloud
Use the `ksbuilder login` subcommand to login to KubeSphere Cloud:
```
$ ksbuilder login
✔ Enter API token: ***
Login Succeeded
```
or:
```
$ ksbuilder login -t xxx
Login Succeeded
```
### Push and submit the extension
Use the `ksbuilder push` subcommand to submit the extension to KubeSphere Cloud. The `push` subcommand is similar to `publish` and the target can be either a directory or a packaged `.tgz` file:
```
$ ksbuilder push tower
$ ksbuilder push tower-1.0.0.tgz
```
> NOTE: We will upload static files such as icons and screenshots in the extension to the KubeSphere Cloud separately
and delete the static file directory in the original package to reduce the size of the entire chart.
### Check the extension status
After submitting the extension, it needs to be approved by an administrator before it can be listed on KubeSphere Marketplace. You can use the `ksbuilder get` or `ksbuilder list` subcommands to check the status of the extension:
```
$ ksbuilder list
ID NAME STATUS LATEST VERSION
469804312491467933 devops ready 1.0.0
482307830796264605 kubeblocks ready 0.6.3
```
```
$ ksbuilder get tower
Name: tower
ID: 515518094316151974
Status: draft
SNAPSHOT ID VERSION STATUS UPDATE TIME
515518094316217510 1.0.0 submitted 2024-05-27 09:37:05
```
### Unpush a snapshot
Use the `ksbuilder unpush` subcommand to cancel the submission of a snapshot in KubeSphere Cloud.
When we submit an extension, its snapshot status is marked as `submitted`. If we want to make some new changes to the extension at this point, we can use this command to undo the submission. After undoing, the status of the extension will revert to `draft`, allowing it to be pushed again.
To undo the submission, we first need to use the `get` subcommand to obtain the corresponding snapshot ID:
```
$ ksbuilder get tower
Name: tower
ID: 515518094316151974
Status: draft
SNAPSHOT ID VERSION STATUS UPDATE TIME
515518094316217510 1.0.0 submitted 2024-05-27 17:37:05 CST
$ ksbuilder unpush 515518094316217510
unpush snapshot 515518094316217510
Snapshot 515518094316217510 has been unsubmitted and reverted to draft state
```
Please refer to [KubeSphere extension development guide](https://dev-guide.kubesphere.io/extension-dev-guide/en/packaging-and-release/) for more details on extension packaging and releasing.