Skip to content

AGENTS.md

Latest commit

 

History

History
94 lines (70 loc) · 3.67 KB

AGENTS.md

File metadata and controls

94 lines (70 loc) · 3.67 KB

OpenShift Console Operator - AI Context Hub

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

  • 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

OWNERS

Component: Management Console

  • @spadgett
  • @jhadvig
  • @TheRealJon