API Reference¶

Welcome to the Git Change Operator API reference documentation. This section provides detailed information about the Custom Resource Definitions (CRDs), configuration options, and API specifications.

Available Resources¶

GitCommit¶

The GitCommit custom resource allows you to create git commits automatically based on Kubernetes cluster resources.

Key Features: - Automatic file creation from cluster resources - Resource reference strategies (dump, fields, single-field) - Configurable write modes (overwrite, append) - Authentication via Kubernetes secrets

View GitCommit API Reference

PullRequest¶

The PullRequest custom resource creates GitHub pull requests automatically with files generated from cluster resources.

Key Features: - Automatic branch creation and management - GitHub API integration - File generation from resource references - Pull request metadata configuration

View PullRequest API Reference

Configuration Reference¶

Topic	Description
API Reference & CRD Specification	Complete API documentation and schema for GitCommit and PullRequest resources
Resource Reference Strategies	How to extract data from Kubernetes resources
Write Modes	File writing behavior (overwrite vs append)
Error Handling	Common errors and troubleshooting

Quick Links¶

Getting Started - Installation and basic setup
Examples - Practical usage examples

API Versions¶

The Git Change Operator uses the API group gco.galos.one with version v1.

apiVersion: gco.galos.one/v1
kind: GitCommit
# or
kind: PullRequest

All resources in this API group follow the same versioning scheme and are designed to be backward compatible within the major version.