Operations
Quick Reference
Essential commands, critical ports, and important files for managing ORISO Platform
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 caritasPod 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 caritasService 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 nodesHealth 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)
| Service | URL | Description |
|---|---|---|
| Frontend | https://app.oriso.org | User portal |
| Admin | https://admin.oriso.org | Admin panel |
| API | https://api.oriso.org | Backend API |
| Auth | https://auth.oriso.org | Keycloak |
| Matrix | https://matrix.oriso.org | Matrix Synapse |
Internal Service Names (Kubernetes DNS)
| Service | Internal URL | Port |
|---|---|---|
| TenantService | oriso-platform-tenantservice.caritas.svc.cluster.local | 8081 |
| UserService | oriso-platform-userservice.caritas.svc.cluster.local | 8082 |
| ConsultingTypeService | oriso-platform-consultingtypeservice.caritas.svc.cluster.local | 8083 |
| AgencyService | oriso-platform-agencyservice.caritas.svc.cluster.local | 8084 |
| MariaDB | oriso-platform-mariadb.caritas.svc.cluster.local | 3306 |
| MongoDB | oriso-platform-mongodb.caritas.svc.cluster.local | 27017 |
| Keycloak | oriso-platform-keycloak.caritas.svc.cluster.local | 8080 |
| Matrix Synapse | oriso-platform-matrix-synapse.caritas.svc.cluster.local | 8008 |
Health Check Endpoints
| Service | Health 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 caritasView Logs
kubectl logs deployment/oriso-platform-<service> -n caritas --tail=100
kubectl logs deployment/oriso-platform-<service> -n caritas -f # FollowUpgrade Deployment
cd ~/online-beratung/caritas-workspace/ORISO-Kubernetes/helm
helm upgrade oriso-platform ./oriso-platform --namespace caritas -f values.yamlUninstall
helm uninstall oriso-platform --namespace caritasService Names Reference
Common service names for use with kubectl commands:
| Service Name | Deployment Name | Service Name |
|---|---|---|
| Tenant Service | oriso-platform-tenantservice | oriso-platform-tenantservice |
| User Service | userservice | |
| Consulting Type Service | consultingtypeservice | |
| Agency Service | agencyservice | |
| Upload Service | uploadservice | |
| Video Service | videoservice | |
| Frontend | frontend | |
| Admin | admin | |
| Keycloak | keycloak | |
| Matrix Synapse | matrix-synapse | |
| Element | element | |
| Nginx Proxy | cob-proxy | |
| MariaDB | mariadb | |
| MongoDB | mongodb | |
| Redis | redis | |
| RabbitMQ | rabbitmq |
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.yamlConfiguration 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 yamlQuick 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=WarningQuick 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"Related Documentation
- Troubleshooting Guide - Comprehensive troubleshooting
- Post-Deployment Configuration - Verify deployment
- Verification & Testing - Test platform functionality