Skip to main content

Quick Reference Cheat Sheet

Quick reference guide for essential ORISO Platform management commands, ports, and file locations.

Essential Commands

Helm Operations

# Check Helm release
helm list -n caritas

# Check release status
helm status oriso-platform -n caritas

# Upgrade deployment
cd ~/online-beratung/caritas-workspace/ORISO-Kubernetes/helm
helm upgrade oriso-platform ./oriso-platform --namespace caritas -f values.yaml

# View release values
helm get values oriso-platform -n caritas

# Rollback deployment
helm rollback oriso-platform -n caritas

Pod Management

# Check all pods
kubectl get pods -n caritas

# Check pod logs
kubectl logs deployment/oriso-platform-<service> -n caritas

# Follow logs in real-time
kubectl logs deployment/oriso-platform-<service> -n caritas -f

# Restart deployment
kubectl rollout restart deployment/oriso-platform-<service> -n caritas

# Check rollout status
kubectl rollout status deployment/oriso-platform-<service> -n caritas

# Scale deployment
kubectl scale deployment/oriso-platform-<service> --replicas=2 -n caritas

Service Management

# Check all services
kubectl get svc -n caritas

# Check service endpoints
kubectl get endpoints -n caritas <service-name>

# Port forward for local access
kubectl port-forward -n caritas svc/<service> <local-port>:<service-port>

Debugging

# Execute command in pod
kubectl exec -it deployment/<name> -n caritas -- /bin/bash

# Check pod events
kubectl describe pod <pod-name> -n caritas

# Check all events (sorted by time)
kubectl get events -n caritas --sort-by='.lastTimestamp'

# Check resource usage
kubectl top pod <pod-name> -n caritas
kubectl top nodes

Health Checks

# Check service health
curl http://127.0.0.1:<port>/actuator/health

# Check detailed health
curl http://127.0.0.1:<port>/actuator/health/db | jq .
curl http://127.0.0.1:<port>/actuator/health/redis | jq .

Service URLs

External Access (via Ingress)

ServiceURLDescription
Frontendhttps://app.oriso-dev.siteUser portal
Adminhttps://admin.oriso-dev.siteAdmin panel
APIhttps://api.oriso-dev.siteBackend API
Authhttps://auth.oriso-dev.siteKeycloak
Matrixhttps://matrix.oriso-dev.siteMatrix Synapse

Internal Service Names (Kubernetes DNS)

ServiceInternal URLPort
TenantServiceoriso-platform-tenantservice.caritas.svc.cluster.local8081
UserServiceoriso-platform-userservice.caritas.svc.cluster.local8082
ConsultingTypeServiceoriso-platform-consultingtypeservice.caritas.svc.cluster.local8083
AgencyServiceoriso-platform-agencyservice.caritas.svc.cluster.local8084
MariaDBoriso-platform-mariadb.caritas.svc.cluster.local3306
MongoDBoriso-platform-mongodb.caritas.svc.cluster.local27017
Keycloakoriso-platform-keycloak.caritas.svc.cluster.local8080
Matrix Synapseoriso-platform-matrix-synapse.caritas.svc.cluster.local8008

Health Check Endpoints

ServiceHealth Endpoint
TenantService/actuator/health
UserService/actuator/health
ConsultingTypeService/actuator/health
AgencyService/actuator/health

Common Operations

Restart Service

kubectl rollout restart deployment/oriso-platform-<service> -n caritas

View Logs

kubectl logs deployment/oriso-platform-<service> -n caritas --tail=100
kubectl logs deployment/oriso-platform-<service> -n caritas -f  # Follow

Upgrade Deployment

cd ~/online-beratung/caritas-workspace/ORISO-Kubernetes/helm
helm upgrade oriso-platform ./oriso-platform --namespace caritas -f values.yaml

Uninstall

helm uninstall oriso-platform --namespace caritas

Service Names Reference

Common service names for use with kubectl commands:
Service NameDeployment NameService Name
Tenant Serviceoriso-platform-tenantserviceoriso-platform-tenantservice
User Serviceuserservice
Consulting Type Serviceconsultingtypeservice
Agency Serviceagencyservice
Upload Serviceuploadservice
Video Servicevideoservice
Frontendfrontend
Adminadmin
Keycloakkeycloak
Matrix Synapsematrix-synapse
Elementelement
Nginx Proxycob-proxy
MariaDBmariadb
MongoDBmongodb
Redisredis
RabbitMQrabbitmq

Important Files

Configuration Files

# Kubernetes configs
~/online-beratung/caritas-workspace/ORISO-Kubernetes/

# Database schemas
~/online-beratung/caritas-workspace/ORISO-Database/

# Keycloak realm
~/online-beratung/caritas-workspace/ORISO-Keycloak/realm.json

# Kubeconfig
~/.kube/config

# k3s config
/etc/rancher/k3s/k3s.yaml

Configuration Access

# View Nginx config
kubectl get configmap oriso-nginx-config -n caritas -o yaml

# View deployment configuration
kubectl get deployment <name> -n caritas -o yaml

# View service configuration
kubectl get svc <name> -n caritas -o yaml

Quick Health Check Script

Run this script to quickly check all services:
#!/bin/bash
echo "Checking ORISO Platform Services..."

# Backend Services
for port in 8081 8082 8083 8084; do
  echo -n "Port $port: "
  curl -s http://127.0.0.1:$port/actuator/health | jq -r '.status' || echo "FAILED"
done

# Frontend
echo -n "Frontend (9001): "
curl -s -o /dev/null -w "%{http_code}" http://127.0.0.1:9001

# Admin
echo -n "Admin (9002): "
curl -s -o /dev/null -w "%{http_code}" http://127.0.0.1:9002

# Keycloak
echo -n "Keycloak (8089): "
curl -s -o /dev/null -w "%{http_code}" http://127.0.0.1:8089/auth

echo "Health check complete!"

Common Troubleshooting Commands

# Check all pods status
kubectl get pods -n caritas

# Check failing pods
kubectl get pods -n caritas | grep -v Running | grep -v Completed

# Check pod logs with errors
kubectl logs deployment/<name> -n caritas --tail=100 | grep -i error

# Check resource limits
kubectl describe nodes

# Check persistent volumes
kubectl get pvc -n caritas

# Check events for errors
kubectl get events -n caritas --field-selector type=Warning

Quick Access URLs

Get your server IP and access URLs:
SERVER_IP=$(hostname -I | awk '{print $1}')

echo "Main Entry Point: http://$SERVER_IP:8089"
echo "Frontend: http://$SERVER_IP:9001"
echo "Admin: http://$SERVER_IP:9002"
echo "Keycloak: http://$SERVER_IP:8089/auth/admin/"
echo "Element.io: http://$SERVER_IP:8087"