API Reference
IDP Builder provides 7 Custom Resource Definitions (CRDs) that allow you to declaratively manage your internal developer platform on Kubernetes.
📖 About This Documentation
This API reference is automatically generated from the CRD definitions. It provides detailed information about all fields, types, and validation rules for each Custom Resource.
API Versions
IDP Builder provides two API versions:
v1alpha1
Status: Deprecated (transitioning to v1alpha2)
The original API version with monolithic resources. Includes 3 resource(s):
CustomPackage- CustomPackageSpec controls the installation of the customGitRepository- |-Localbuild- |-
v1alpha2
Status: Current (recommended)
The new modular architecture with pluggable providers. Includes 4 resource(s):
ArgoCDProvider- ArgoCDProviderStatus defines the observed state of ArgoCDProviderGiteaProvider- GiteaProviderStatus defines the observed state of GiteaProviderNginxGateway- NginxGatewayStatus defines the observed state of NginxGatewayPlatform- PlatformStatus defines the observed state of Platform
Custom Resources
The following Custom Resources are available:
ArgoCDProvider
ArgoCDProviderStatus defines the observed state of ArgoCDProvider
CustomPackage
CustomPackageSpec controls the installation of the custom
GiteaProvider
GiteaProviderStatus defines the observed state of GiteaProvider
NginxGateway
NginxGatewayStatus defines the observed state of NginxGateway
Using the API
You can create these resources in two ways:
1. Using the CLI (Development Mode)
The CLI automatically creates appropriate resources based on your requirements:
idpbuilder create2. Declaratively via kubectl (Production Mode)
Create resources directly in your Kubernetes cluster:
kubectl apply -f platform.yamlExamples
For example YAML configurations, see the Examples section:
Complete Reference
For complete field-level documentation, see the Full CRD Reference Documentation.