IDP Builder Examples

This page contains example configurations and manifests to help you get started with IDP Builder. These examples demonstrate various deployment scenarios and configurations.

📋 About These Examples

These examples are organized into two main categories:

  • Platform Examples: Basic Platform and GiteaProvider CRs for the Phase 1.1 controller-based architecture
  • V1Alpha2 Examples: Modular provider-based configurations including Platform, GiteaProvider, and NginxGateway CRs

Platform CR Examples

Simple Platform

A basic Platform CR that references a GiteaProvider. This is the minimal configuration needed to get started.

Use this when: You want a simple setup with just Git provider support.

Complexity: Beginner

View Example → Download YAML

Complete Platform

A complete example with both Platform and GiteaProvider CRs in a single file. This shows the full configuration with all components together.

Use this when: You want to deploy everything in one go with a complete configuration.

Complexity: Intermediate

View Example → Download YAML

GiteaProvider Examples

Simple GiteaProvider

A basic GiteaProvider CR with auto-generated credentials and organizations. This is the easiest way to get a Git server running.

Use this when: You want a quick Git provider setup with default configurations.

Complexity: Beginner

View Example → Download YAML

V1Alpha2 Examples

The v1alpha2 architecture introduces a modular, provider-based system where platform components are managed through separate Custom Resources.

Platform with Gateway

A complete v1alpha2 configuration including Platform, GiteaProvider, and NginxGateway CRs. This demonstrates the new modular architecture.

Complexity: Intermediate

Features:

  • Modular provider-based architecture
  • Separate CRs for each component
  • Duck-typed status fields for better integration
  • Support for alternative providers
View Example → Download YAML

Individual Provider Examples

Individual provider configurations that can be mixed and matched:

GiteaProvider: Git server provider configuration

View GiteaProvider → Download YAML

NginxGateway: Nginx Ingress Controller configuration

View NginxGateway → Download YAML

Usage Instructions

Prerequisites

Before using these examples, ensure you have:

  • A Kubernetes cluster running (e.g., kind create cluster)
  • kubectl configured to access your cluster
  • IDP Builder CRDs installed in your cluster

Applying Examples

To apply an example configuration:

# Download the example YAML file
curl -O https://raw.githubusercontent.com/cnoe-io/idpbuilder/main/examples/platform-complete.yaml

# Apply to your cluster
kubectl apply -f platform-complete.yaml

# Check the status
kubectl get platform
kubectl describe platform my-platform

Cleaning Up

To remove the deployed resources:

kubectl delete -f platform-complete.yaml

Additional Resources