ocm-components: Instructions file for Claude Code

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

Repository Overview

This is a monorepo for packaging cloud-native applications as OCM (Open Component Model) components. Each folder in the repository represents a single cloud-native application packaged with:

• The operator (if available)
• Corresponding Helm charts
• All required container images
• Extensive configuration options for controlling operator behavior

Component Architecture

Components can reference each other to fulfill dependencies rather than duplicating resources. For example:

• The Keycloak component references the CloudNativePG component for database requirements
• This enables composable, reusable infrastructure definitions

Repository Structure

The monorepo follows a flat structure where each top-level directory represents a separate cloud-native application/component. Component layouts are not yet uniform — two patterns currently coexist:

• Raw-manifest layout (keycloak/): component-constructor.yaml, operator/ (CRDs + operator manifests), configs/{minimal,production}/, docs/. No RGD/bootstrap yet.
• RGD layout (cloudnative-pg/, artifact-conduit/): component-constructor.yaml, rgd-template.yaml, bootstrap.yaml, and flat values/cluster files at the component root (e.g. minimal-values.yaml, cluster-production.yaml). No configs/ or tests/ subdirectory.

When reading or creating files, do not assume one canonical structure — check the component directory first.

All components use the OCM name prefix opendefense.cloud/<component> (see existing component-constructor.yaml files). New components should follow the same prefix.

Development Environment

This repo uses devenv (entered automatically via direnv / .envrc). The shell provides: ocm, kubectl, helm, kind, jq, yq-go, gnumake. There is no top-level Makefile — components are built individually with the ocm CLI.