Imported from openshift/console-operator (AGENTS.md). Install upstream with npx skills add openshift/console-operator. Copyright stays with the author.

OpenShift Console Operator - AI Context Hub

Name: console-operator
Author: openshift

This file serves as the central AI documentation hub for the OpenShift Console Operator project. AI assistants (Claude, Cursor, Copilot, CodeRabbit, etc.) use this and the linked documents to understand project context.

Go Version and Dependencies

Go version: 1.24.0 (toolchain: go1.24.4)
Dependency management: Uses go.mod with vendoring
Build flags: Use GOFLAGS="-mod=vendor" for builds and tests to ensure vendored dependencies are used
Key dependencies: openshift/api, openshift/library-go, k8s.io client libraries
Go version: 1.24.0 (toolchain: go1.24.4)
Dependency management: Uses go.mod with vendoring
Build flags: Use GOFLAGS="-mod=vendor" for builds and tests to ensure vendored dependencies are used
Key dependencies: openshift/api, openshift/library-go, k8s.io client libraries

Quick Reference

This Repository

Document	Purpose
ARCHITECTURE.md	System architecture, components, repository structure
CONVENTIONS.md	Go coding standards, patterns, import organization
TESTING.md	Testing patterns, commands, debugging
README.md	Project README with setup instructions

Console Repository (openshift/console)

For frontend-related guidelines, see the openshift/console repository:

Document	Purpose
STYLEGUIDE.md	Frontend code style guidelines
INTERNATIONALIZATION.md	i18n patterns and translation guidelines
CONTRIBUTING.md	Contribution guidelines for the console project

Project Summary

The console-operator is an OpenShift operator that installs and maintains the OpenShift web console on a cluster. It manages:

Console deployment and configuration
OAuth client configuration for console authentication
CLI downloads (oc, kubectl) deployment
Routes, services, and secrets
Console plugins and quickstarts
Pod disruption budgets
Health checks and monitoring

Essential Commands

# Build
make                           # Build the operator binary
make build                     # Same as above

# Test
make test-unit                 # Run unit tests
make test-e2e                  # Run e2e tests (requires cluster)
make check                     # Run verify + test-unit

# Code Quality
gofmt -w ./pkg ./cmd           # Format code
go vet ./pkg/... ./cmd/...     # Run vet checks
make verify                    # Run all verification

Key Namespaces

Namespace	Purpose
`openshift-console`	Console deployment and resources
`openshift-console-operator`	Operator deployment
`openshift-config`	Cluster configuration
`openshift-config-managed`	Managed configuration
`openshift-ingress-operator`	Ingress controller (default ingress)

Branch Naming

Feature work: CONSOLE-#### (Jira story number)
Bug fixes: OCPBUGS-#### (Jira bug number)

Related Repositories

openshift/console - Web console frontend and backend (see STYLEGUIDE.md, INTERNATIONALIZATION.md, CONTRIBUTING.md)
openshift/api - OpenShift API definitions
openshift/library-go - Shared operator libraries

OWNERS

Component: Management Console

@spadgett
@jhadvig
@TheRealJon

{ "ocm": "1", "id": "openshift-console-operator-console-operator", "kind": "skill", "name": "console-operator", "description": "This file serves as the central AI documentation hub for the OpenShift Console Operator project. AI assistants (Claude, Cursor, Copilot, CodeRabbit, etc.) use this and the linked documents to understand project context. ## Go Version and Dependencies ## Go Version and Dependencies", "publisher": "openshift", "version": "1.0.0", "capabilities": { "domains": [ "coding" ], "tags": [ "skill-md", "github-agents" ], "languages": [ "en" ] }, "quality_prior": 0.6, "examples": [ "This file serves as the central AI documentation hub for the OpenShift Console Operator project. AI assistants (Claude, Cursor, Copilot, CodeRabbit, etc.) use this and the linked documents to understand project context. ## Go Version and Dependencies ## Go Version and Dependencies" ], "primary": false, "metadata": { "source": { "provider": "github-agents", "repository": "https://github.com/openshift/console-operator", "path": "AGENTS.md", "ref": "7fa0a807acb45ccb18f3ce8b8f32d588ccdc469e", "url": "https://github.com/openshift/console-operator/blob/7fa0a807acb45ccb18f3ce8b8f32d588ccdc469e/AGENTS.md", "key": "openshift/console-operator/AGENTS.md" } }, "instructions": "# OpenShift Console Operator - AI Context Hub\n\nThis file serves as the central AI documentation hub for the OpenShift Console Operator project. AI assistants (Claude, Cursor, Copilot, CodeRabbit, etc.) use this and the linked documents to understand project context.\n## Go Version and Dependencies\n## Go Version and Dependencies\n\n- **Go version**: 1.24.0 (toolchain: go1.24.4)\n- **Dependency management**: Uses `go.mod` with vendoring\n- **Build flags**: Use `GOFLAGS=\"-mod=vendor\"` for builds and tests to ensure vendored dependencies are used\n- **Key dependencies**: openshift/api, openshift/library", "cost": { "context_tokens": 939 } }

console-operator

About

OpenShift Console Operator - AI Context Hub

Go Version and Dependencies

Go Version and Dependencies

Quick Reference

This Repository

Console Repository (openshift/console)

Project Summary

Essential Commands

Key Namespaces

Branch Naming

Related Repositories

OWNERS

Use it

Manifest

Reviews