Skip to content

Operator: Documentation #31

@fmallmann

Description

@fmallmann

Parent Issue

Part of #27

Description

Document the operator for users and contributors.

Scope

Operator README (operator/README.md)

  • Purpose and architecture overview
  • Development setup: prerequisites, build, test, run locally
  • Project structure explanation

Experiment CRD reference

  • All spec fields documented with types, defaults, and examples
  • Inline scenarios mode vs. external dataset mode explained
  • Status subresource fields documented
  • Validation rules and constraints

User guide

  • How to create an Experiment CR with step-by-step instructions
  • Configure triggers for automatic evaluation on agent changes
  • Monitor experiment status via kubectl
  • Complete example YAMLs for both inline and dataset modes

Update existing documentation

  • Update root CLAUDE.md: add operator section covering architecture, commands, and cross-references
  • Update root README.md: reference the operator and link to its documentation

Acceptance Criteria

  • operator/README.md with development and architecture docs
  • CRD reference with all fields, types, and examples
  • User guide with complete example YAMLs
  • Root CLAUDE.md updated with operator section
  • Root README.md updated with operator reference

References

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    Status

    Backlog

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions