Reference

Reference documentation is information-oriented. It provides technical descriptions of components, APIs, configurations, and specifications.

What You'll Find Here

Reference content in Fawkes is designed to:

REST API specifications for platform services.

API	Description	Status
Backstage Plugins API	Internal Backstage plugins (Che Launcher, DevLake Dashboard)	✅ Available
Jenkins Webhook API	Trigger Jenkins pipelines via webhooks	✅ Available

Field-level specifications for Kubernetes custom resources and Devfiles.

CRD	Description	Status
Golden Path Devfile	Eclipse Che workspace configuration specification	✅ Available

Helm values and configuration tables for platform components.

Component	Description	Status
Jenkins Helm Values	Complete Jenkins Helm chart configuration	✅ Available
Prometheus Helm Values	Complete Prometheus monitoring configuration	✅ Available
See Configuration Guide	General platform configuration	✅ Available

Complete listings of active policies and their enforcement modes.

Policy Type	Description	Status
Kyverno Policy List	All active Kyverno policies (security, mutation, generation)	✅ Available

Service types and capabilities available in the platform.

Catalog	Description	Status
Service Types	Supported services and deployment patterns	✅ Available

Resource	Description
Glossary	Fawkes-specific terms, concepts, and acronyms

CLI documentation is under development. The following will be available: