https://github.com/christoph-jerolimov/openshift-console-plugin-template

An alternative OpenShift Console plugin template
https://github.com/christoph-jerolimov/openshift-console-plugin-template

Last synced: 28 days ago
JSON representation

An alternative OpenShift Console plugin template

• Host: GitHub
• URL: https://github.com/christoph-jerolimov/openshift-console-plugin-template
• Owner: christoph-jerolimov
• Created: 2024-01-15T12:40:37.000Z (11 months ago)
• Default Branch: main
• Last Pushed: 2024-01-15T13:11:30.000Z (11 months ago)
• Last Synced: 2024-11-25T12:16:29.821Z (28 days ago)
• Language: JavaScript
• Homepage:
• Size: 73.2 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# An alternative OpenShift Console plugin template

## Why?

* To learn

* To have a playground to build mono-repo projects with more then one frontend or with an backend

* To use less dependencies in the origin template (that's a difficult goal and is more a tradeoff when supprting less features)

## Development / How to use it locally?

You need to have at least two terminals open:

```

cd frontend

npm install

npm start     # runs a local webpack dev server that serves just the plugin frontend

```

Start your OpenShift Console

```

cd console    # clone from https://github.com/openshift/console

./build.sh

source ./contrib/oc-environment.sh

./bin/bridge.sh -plugins console-plugin-template=http://localhost:9001

```

## Frontend

Features:

* [x] TypeScript (similar to the official template, this template contains some stricter rules)

* [x] Reuse the official `dynamic-plugin-sdk` and `dynamic-plugin-sdk-webpack` dependencies

* [x] PatternFly components (for the demo, you can remove or replace this if needed)

* [x] i18n support (script to extract localization from TSX into JSON files)

* [ ] Linter (ESLint)

* [ ] Auto formatter (Prettier)

* [ ] Unit tests

## Backend

TODO

## Backlog

* [ ] `Dockerfile` that builds frontend or frontend and backend

* [ ] CI that uploads a demo image to Docker/Quay

* [ ] e2e tests

* [ ] Deployment via `kubectl`?

* [ ] Deployment via `helm`?

## More information about Dynamic Plugins

* Introduction about [Dynamic Plugins for OpenShift Console](https://github.com/openshift/enhancements/blob/master/enhancements/console/dynamic-plugins.md)

* [OpenShift Console repository](https://github.com/openshift/console)

* [OpenShift Console Dynamic Plugin SDK](https://github.com/openshift/console/tree/master/frontend/packages/console-dynamic-plugin-sdk)

* Official [OpenShift Console Plugin template](https://github.com/openshift/console-plugin-template)