Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
452c87b
Add generic prompt and supporting files
Mar 4, 2026
10ca818
Add missing CRD model definitions for ResourceInspect
Mar 6, 2026
ad95869
update: prompt
Mar 6, 2026
8b9600c
Merge pull request #1 from sarthakpurohit/add-generic-prompt-and-supp…
sarthakpurohit Mar 9, 2026
8d6f914
fix: buil push deploy workflow
sarthakpurohit Mar 10, 2026
1c03de4
Merge pull request #2 from sarthakpurohit/build-push-deploy
sarthakpurohit Mar 10, 2026
f0be21c
Enabling rbac for tekton pipelines
sarthakpurohit Mar 10, 2026
4543b32
docs: update operator onboarding guide
Mar 10, 2026
edbf9f8
Merge pull request #4 from sarthakpurohit/update-promt-for-dashboard-UI
anandkuma77 Mar 11, 2026
34035c9
complex relations and fixed namespace feature
sarthakpurohit Mar 11, 2026
027cf19
fix: loading error issue
sarthakpurohit Mar 11, 2026
90670c7
Merge pull request #5 from sarthakpurohit/one-to-many-relations
sarthakpurohit Mar 12, 2026
01f0bc2
docs: move promts to promts/ and update README with operator dashboar…
Mar 25, 2026
ab5d513
docs: add oc login prerequisite note to operator dashboard section
Mar 25, 2026
dfb97e6
Merge pull request #6 from sarthakpurohit/update-readme
anandkuma77 Mar 25, 2026
23ed3bc
docs: update operator onboarding prompt for test workflow
Mar 25, 2026
472a888
Merge pull request #7 from sarthakpurohit/update-promt-to-add-testcas…
sarthakpurohit Mar 30, 2026
410dad4
docs: add design-integrated operator onboarding prompt
Apr 9, 2026
f7fb42d
Merge pull request #8 from sarthakpurohit/add-figma-code-ability
sarthakpurohit Apr 9, 2026
65196b2
Merge remote-tracking branch 'upstream/main' into sync-upstream-changes
May 15, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 64 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
# OpenShift Console Plugin - Makefile

# Configuration
PLUGIN_NAME ?= console-plugin-template
QUAY_USER ?= <your-username>
IMAGE ?= quay.io/$(QUAY_USER)/$(PLUGIN_NAME):latest
NAMESPACE ?= $(PLUGIN_NAME)

# Validate QUAY_USER is set for targets that need it
.PHONY: check-quay-user
check-quay-user:
@if [ "$(QUAY_USER)" = "<your-username>" ]; then \
echo "Error: QUAY_USER is not set."; \
echo "Run: export QUAY_USER=your-quay-username"; \
exit 1; \
fi

.PHONY: help
help:
@echo "Available targets:"
@echo " make build - Build container image"
@echo " make push - Push image to quay.io"
@echo " make deploy - Deploy to OpenShift"
@echo " make status - Check deployment status"
@echo " make logs - View pod logs"
@echo " make undeploy - Remove from OpenShift"
@echo ""
@echo "Required: export QUAY_USER=your-username"
@echo "Image: quay.io/$(QUAY_USER)/$(PLUGIN_NAME):latest"

.PHONY: build
build: check-quay-user
podman build -t $(IMAGE) .

.PHONY: push
push: check-quay-user
podman push $(IMAGE)

.PHONY: deploy
deploy: check-quay-user
helm upgrade -i $(PLUGIN_NAME) charts/openshift-console-plugin \
-n $(NAMESPACE) --create-namespace \
--set plugin.image=$(IMAGE)

.PHONY: status
status:
@echo "=== Pods ==="
@oc get pods -n $(NAMESPACE)
@echo ""
@echo "=== ConsolePlugin ==="
@oc get consoleplugin $(PLUGIN_NAME)
@echo ""
@echo "=== Enabled Plugins ==="
@oc get consoles.operator.openshift.io cluster -o jsonpath='{.spec.plugins}'
@echo ""

.PHONY: logs
logs:
oc logs -n $(NAMESPACE) deployment/$(PLUGIN_NAME) -f

.PHONY: undeploy
undeploy:
helm uninstall $(PLUGIN_NAME) -n $(NAMESPACE)
oc delete namespace $(NAMESPACE)
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,21 @@ This will run the OpenShift console in a container connected to the cluster
you've logged into. The plugin HTTP server runs on port 9001 with CORS enabled.
Navigate to <http://localhost:9000/example> to see the running plugin.

#### Adding an operator dashboard

This plugin supports generating a full operator dashboard — including resource tables, an inspect detail page, sidebar navigation, and RBAC — for any operator installed on your cluster using an AI coding assistant (e.g. Cursor, Copilot, or similar).

The full specification lives in [`promts/operator-onboarding.md`](promts/operator-onboarding.md). Copy the prompt template below, replace `[OPERATOR_NAME]` with the exact display name of your operator (e.g. `"Red Hat OpenShift Pipelines"`, `"Node Feature Discovery Operator"`), fill in the remaining fields, and send it to your AI assistant. It will implement all the required files automatically.

> **Prerequisites:** Before running the prompt, make sure you are logged into your OpenShift cluster via `oc login`. The AI assistant runs `oc api-resources` against your live cluster to discover the correct API groups and resource scopes for the operator. Without an active login, this step will fail and the generated code may use incorrect API groups, causing the dashboard to show "Operator not installed" at runtime.

```text
Operator name: [OPERATOR_NAME]

Follow the implementation specification in promts/operator-onboarding.md exactly.
Start implementation immediately. Do not ask for confirmation.
```

#### Running start-console with Apple silicon and podman

If you are using podman on a Mac with Apple silicon, `yarn run start-console`
Expand Down
3 changes: 3 additions & 0 deletions charts/openshift-console-plugin/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -53,3 +53,6 @@ plugin:
requests:
cpu: 10m
memory: 50Mi
rbac:
enabled: true

Loading