Documentation / Examples / Simple Platform

Simple Platform

📋 About This Example

Use case: A basic Platform CR that references a GiteaProvider. This is the minimal configuration needed to get started with IDP Builder.

Complexity: Beginner

Components: Platform CR, GiteaProvider reference

⬇ Download YAML

Overview

This example demonstrates the simplest possible Platform configuration. It creates a Platform CR that references an existing GiteaProvider.

This configuration is perfect for:

  • Getting started with IDP Builder
  • Understanding the basic structure of Platform CRs
  • Testing Platform controller functionality
  • Building a foundation for more complex setups

YAML Configuration

apiVersion: idpbuilder.cnoe.io/v1alpha2
kind: Platform
metadata:
  name: my-platform
  namespace: default
spec:
  # Base domain for the platform
  domain: cnoe.localtest.me
  
  # Platform components
  components:
    # Git providers - list of Git provider CRs
    gitProviders:
      - name: my-gitea
        kind: GiteaProvider
        namespace: gitea
    
    # Gateways (future use)
    # gateways:
    #   - name: my-nginx
    #     kind: NginxGateway
    #     namespace: nginx
    
    # GitOps providers (future use)
    # gitOpsProviders:
    #   - name: my-argocd
    #     kind: ArgoProvider
    #     namespace: argocd

Prerequisites

Before applying this configuration, ensure you have:

  • A Kubernetes cluster (e.g., created with kind create cluster)
  • IDP Builder CRDs installed in your cluster
  • A GiteaProvider CR named my-gitea in the gitea namespace

Usage

1. Apply the manifest

kubectl apply -f platform-simple.yaml

2. Check the status

# View resources
kubectl get platform

# Get detailed information
kubectl describe platform

Next Steps

After deploying this example, you can: