openshift-servicemesh-plugin: Instructions file for Codex

AI Agent Development Guide for OSSMC

This guide provides coding standards, development workflows, and common commands for AI agents and developers contributing to the OpenShift Service Mesh Console Plugin (OSSMC).

Table of Contents

• Supported Branches
• Quick Reference
• Repository Structure
• Code Quality Standards
• Building and Testing
• Development Workflows
• File Protection Rules
• Common Patterns and Best Practices
• Writing New E2E Tests
• Troubleshooting
• Quick Command Reference
• Creating Pull Requests
• Important Reminders
• Skills
• Additional Resources

---

Supported Branches

The currently supported OSSMC release branches (which receive backports and security fixes) are:

OSSM	Branch	OSSMC Version
3.4	v2.27	2.27
3.3	v2.22	2.22
3.2	v2.17	2.17
3.1	v2.11	2.11
3.0	v2.4	2.4

In addition, main is the active development branch for the next release.

---

Quick Reference

Essential Commands

# Prepare dev environment (oc login required only when using KIALI_URL=route)
make prepare-dev-env -e KIALI_URL=route

# Run locally (two terminals) - make start / make start-console wrap the yarn commands below
cd plugin && yarn start           # Plugin dev server on http://localhost:9001
cd plugin && yarn start-console   # Console on http://localhost:9000 (requires oc login)

# Run with mock server (three terminals; no Kiali backend in cluster needed, but oc login is still required for the console bridge)
cd plugin && yarn mock-server     # Mock API on http://localhost:3001
cd plugin && yarn start           # Plugin dev server
cd plugin && KIALI_URL=http://localhost:3001 yarn start-console   # Console

# Build plugin
cd plugin && yarn install && yarn build

# Build container image
make build-plugin-image

# Deploy to cluster (uses quay.io latest image)
oc login
make deploy-plugin enable-plugin

# Lint and format
cd plugin && yarn lint            # ESLint (excludes kiali server synced code)
cd plugin && yarn prettier        # Prettier

# Type check and unit test (or: make typecheck / make test)
cd plugin && yarn tsc --noEmit
cd plugin && yarn test

# Run Cypress E2E tests
cd plugin && yarn cypress         # Interactive (GUI)
cd plugin && yarn cypress:run     # Headless (core-1 and core-2)