[Deployment][Documentation] OpenGIN Deployment using OpenChoreo

[vibhatha]

• Work on the developer setting deployment
• Work on documentation to do the OpenChoreo Deployment
• Making it available for any user who wants to set up OpenGIN and making OpenChoreo an option
• CI/CD Inclusion (if possible)

[vibhatha]

OpenChoreo Debugging Cheatsheet

This guide organizes kubectl commands by the specific "Plane" (responsibility area) within the OpenChoreo architecture.

---

1. Control Plane

Focus: Management API, Gateway configuration, Global state.
Namespace: openchoreo-control-plane

# Check if core services (Thunder, Gate) are running
kubectl get pods -n openchoreo-control-plane

# View logs for a specific management service
kubectl logs -n openchoreo-control-plane -l app=<app_name>

# Verify ingress rules (URL mappings)
kubectl get ingress -n openchoreo-control-plane

---

2. Data Plane

Focus: Application traffic, Ingress (Envoy/Traefik), Cluster connectivity.
Namespace: openchoreo-data-plane

# Verify the Data Plane CRD configuration
kubectl get dataplane -n default

# Check if the Cluster Agent and Gateway are running
kubectl get pods -n openchoreo-data-plane

# DEBUG CONNECTION: Check if the cluster is talking to the Control Plane
kubectl logs -n openchoreo-data-plane -l app=cluster-agent

# Find exposed ports for applications (usually 19080/19443)
kubectl get svc -n openchoreo-data-plane

---

3. Build Plane

Focus: Infrastructure for building apps (Internal Registry).
Namespace: openchoreo-build-plane

# Verify the Build Plane CRD configuration
kubectl get buildplane -n default

# Check if the Internal Registry is running
kubectl get pods -n openchoreo-build-plane

# Debug connection for build infrastructure
kubectl logs -n openchoreo-build-plane -l app=cluster-agent

---

4. CI Plane

Focus: Execution of build jobs and pipelines.
Namespace: openchoreo-ci-default

# List all build jobs/workflows
kubectl get wf -n openchoreo-ci-default

# List the temporary pods running the build steps
kubectl get pods -n openchoreo-ci-default

# Watch logs for a specific build (all steps: clone, build, push)
kubectl logs -f <pod-name> -n openchoreo-ci-default --all-containers

# Debug a specific step (e.g., if clone worked but build failed)
kubectl logs <pod-name> -n openchoreo-ci-default -c step-build

---

5. Application Resources

Focus: Custom Resources definitions (CRDs) for your apps.
Namespace: All (-A)

# High-level view of all OpenChoreo apps
kubectl get component,workload,releasebinding -A

# View app definition (Git URL, build config)
kubectl describe component <name>

# CRITICAL: Debug why an app isn't running after a build
kubectl describe releasebinding <name>

---

🚑 Quick Troubleshooting Workflows

Scenario A: The Build Failed

1. Find the failing pod: kubectl get pods -n openchoreo-ci-default
2. specific step logs: kubectl logs -n openchoreo-ci-default <pod-name> -c step-build

Scenario B: Build Passed, but App isn't Running

1. Check the binding events: kubectl describe releasebinding <app-name>-development

Scenario C: Platform Disconnected from UI

1. Check Data Plane agent: kubectl logs -n openchoreo-data-plane -l app=cluster-agent
2. Check Build Plane agent: kubectl logs -n openchoreo-build-plane -l app=cluster-agent

[vibhatha]

Moving this task to the next sprint, as I will not be working on this one.