When to Use
- •RHDH portal management
- •Catalog entity registration
- •Template management
- •Plugin configuration
Prerequisites
- •kubectl access to RHDH namespace
- •RHDH admin access
- •Git repository access for entities
Commands
Portal Health
bash
# Check RHDH pods kubectl get pods -n rhdh -l app.kubernetes.io/name=backstage # Check portal logs kubectl logs -n rhdh -l app.kubernetes.io/name=backstage --tail=100 # Port forward for local access kubectl port-forward -n rhdh svc/rhdh 7007:7007
Catalog Operations
bash
# Register entity
curl -X POST "http://localhost:7007/api/catalog/locations" \
-H "Content-Type: application/json" \
-d '{"type":"url","target":"https://github.com/org/repo/blob/main/catalog-info.yaml"}'
# List entities
curl -s "http://localhost:7007/api/catalog/entities" | jq '.[].metadata.name'
# Refresh entity
curl -X POST "http://localhost:7007/api/catalog/refresh"
Template Operations
bash
# List templates curl -s "http://localhost:7007/api/catalog/entities?filter=kind=Template" | jq '.[].metadata.name' # Get template details curl -s "http://localhost:7007/api/catalog/entities/by-name/template/default/<template-name>"
Best Practices
- •Use catalog-info.yaml for entity definition
- •Configure OAuth for authentication
- •Use groups for access control
- •Enable TechDocs for documentation
- •Configure proper CORS settings
Output Format
- •Command executed
- •Portal status
- •Entity count and status
- •Recommendations
Integration with Agents
Used by: @rhdh-portal, @golden-paths