A Functions-as-a-Service PoC UI for the OpenShift Web Console. Developers create, edit, and deploy serverless functions without CLI knowledge.
Built as an OpenShift Console dynamic plugin using Go, React, TypeScript, and PatternFly 6.
- Support each other and find time for each other
- Deliver high quality output
- Communicate often and speak freely without hesitation
- Care about bringing value to the customer
| Guide | Description |
|---|---|
| Agile Workflow | Issue tracking, branching, pull requests |
| Architecture | Layered architecture, dependency rules, and React patterns |
| Style Guide | Code style, naming conventions, commit conventions, CSS rules, and OCP plugin constraints |
| Testing | TDD approach, test layers, mock strategy, and file conventions |
| Template | Description |
|---|---|
| PR Template | Pull request description format |
| Jira Epic | Template for creating Jira epics |
| Jira Story | Template for creating Jira stories |
| Jira Bug | Template for filing Jira bugs |
| Command | Description |
|---|---|
/begin | Start a session, orient, and pick work |
/commit | Create a git commit |
/create-pr | Run pre-checks, review, and create a PR |
/e2e | Scaffold and debug Playwright e2e tests |
/scrutinise | Critically review your own output |
PRs merge via Prow when they have both approved and lgtm labels.
| Command | What it does |
|---|---|
/lgtm | Approve for merge (or use GitHub review approval) |
/approve | OWNERS approval |
/hold | Block merge |
/retest | Re-run failed CI jobs |
/test e2e-aws | Run e2e CI job |
All available commands for this repo.
- oc CLI
- An OpenShift 4.22+ cluster
- Github Personal Access Token with administration, content, secret and workflow write permissions in all repositories
Installs OpenShift Serverless, Knative Serving, and the Functions operator (which deploys the console plugin). The operator catalog always contains the latest console plugin build, kept current automatically by Konflux.
# 1. Install the operators
oc apply -f https://raw.githubusercontent.com/openshift/faas-console-plugin/master/install.yaml
# 2. Install Knative Serving (requires the Serverless operator CRDs)
oc apply -f - <<EOFapiVersion: operator.knative.dev/v1beta1kind: KnativeServingmetadata: name: knative-serving namespace: knative-servingspec: {}EOF# 3. Enable the console plugin - can also be done through the UI
oc patch consoles.operator.openshift.io cluster --type=json \
--patch='[{"op":"add","path":"/spec/plugins/-","value":"console-functions-plugin"}]'- Node.js (v24+)
- Yarn (v4)
- Go (v1.26+)
- Helm
- oc CLI
- Podman (v3.2.0+)
- An OpenShift cluster
- Github Personal Access Token with administration, content and workflow write permissions in all repositories
- gh CLI (optional, enables your agent to create/update PRs)
- fswatch (optional, enables Go backend auto-recompile on file changes)
- Superpowers (optional, enables your coding agents to brainstorm, write plans, use tdd, etc.)
- Jira CLI (optional, enables your coding agent to read Jira tickets)
oc login ...
make setup-serverless # install Serverless operator + Knative Serving (optional)make dev # build + start webpack + console container
make dev-stop # stop dev environment
make dev-randomize-ports # start with random ports (when defaults are in use)Navigate to http://localhost:9000 to see the running plugin.
make unit # frontend + backend unit tests
make test-e2e # Playwright e2e (requires make dev running)
make test-e2e ARGS="--headed"# visible browser
make test-e2e ARGS="--ui"# interactive UI modeSee docs/TESTING.md for full conventions, helpers, and environment variables.
To deploy a production-like image to the cluster instead of running locally:
make deploy-dev # build image, push to internal registry, deployThe plugin uses react-i18next for translations, with
i18next-cli for string extraction and
TypeScript type generation. The i18n namespace must match the name of the
ConsolePlugin resource with the plugin__ prefix to avoid naming conflicts.
This plugin uses the plugin__console-functions-plugin namespace.
You can use the useTranslation hook with this namespace as follows:
constHeader: React.FC=()=>{const{ t }=useTranslation('plugin__console-functions-plugin');return<h1>{t('Hello, World!')}</h1>;};For labels in console-extensions.json, you can use the format
%plugin__console-functions-plugin~My Label%. Console will replace the value with
the message for the current language from the plugin__console-functions-plugin
namespace. For example:
{
"type": "console.navigation/section",
"properties": {
"id": "functions-section",
"perspective": "admin",
"name": "%plugin__console-functions-plugin~Serverless Functions%"
}
}Running make verify checks i18n freshness and extracts translatable strings
into the JSON files in the locales folder. The extraction configuration is in
i18next.config.ts.
This project adds prettier, eslint, stylelint, and golangci-lint. Linting can
be run with make lint.
The stylelint config disallows defining colors since these cause problems with dark mode. Use PatternFly semantic tokens for colors instead.
The stylelint config also disallows naked element selectors like table and
.pf- or .co- prefixed classes. This prevents plugins from accidentally
overwriting default console styles, breaking the layout of existing pages. The
best practice is to prefix your CSS class names with your plugin name to avoid
conflicts. Please don't disable these rules without understanding how they can
break console styles!