WebGrip Organisation Public Platform¶

Welcome to the complete documentation for the WebGrip Organisation Public Platform - the foundational infrastructure repository that powers our Kubernetes-based development and operations platform.

What is This Repository?¶

This repository serves as the single source of truth for:

🏗️ Infrastructure Configuration: Kubernetes cluster setup via Helm charts
📋 Service Catalog: Backstage entity definitions for domains, systems, and components
⚙️ CI/CD Automation: GitHub Actions workflows for platform operations
🔐 Secret Management: SOPS-encrypted configuration via Age
📊 Observability: Grafana dashboards and monitoring configuration
📚 Architecture Decisions: ADRs documenting platform choices

🏗️ Cluster Architecture
Core infrastructure, networking, security model, and resource management

🔧 Platform Components
Ingress, certificates, monitoring, CI/CD infrastructure, and secrets

📋 Service Catalog
Backstage integration, domains, systems, and component registry

📖 Operations Runbooks
Deployment procedures, monitoring, incident response, and maintenance

👨‍💻 Developer Workflows
Onboarding guide, application templates, CI/CD patterns, and local development

⚖️ Governance & Standards
Architecture decisions, security policies, and operational standards

Platform Overview¶

Key Technologies¶

Technology	Purpose	Configuration
Kubernetes	Container orchestration	System definition
Helm	Package management	Charts directory
Traefik	Ingress controller	Traefik charts
cert-manager	Certificate automation	cert-manager chart
Prometheus	Monitoring & metrics	Monitoring stack
Grafana	Observability dashboards	Dashboard configs
GitHub Actions	CI/CD automation	Workflow definitions
Backstage	Service catalog	Entity definitions
SOPS	Secret encryption	Secret management

Repository Structure¶

organisation-public/
├── catalog/                    # Backstage entity definitions
│   ├── domains/               # Business domains
│   ├── systems/               # Technical systems  
│   ├── components/            # Service components
│   ├── groups/                # Team definitions
│   └── resources/             # Infrastructure resources
├── ops/                       # Operations configuration
│   ├── helm/                  # Kubernetes Helm charts
│   └── secrets/               # Encrypted secrets (SOPS)
├── docs/                      # Documentation
│   ├── techdocs/              # This documentation site
│   └── adrs/                  # Architecture Decision Records
├── .github/workflows/         # CI/CD automation
└── grafana-dashboards/        # Monitoring dashboards

Getting Started¶

New to the platform? Start here:

📋 Prerequisites - Required tools and access
🔧 Platform Setup - Connect to the cluster
🚀 First Deployment - Deploy your first application
📊 Monitoring - Access dashboards and metrics

Quick Commands¶

Essential commands for platform operations:

# Connect to cluster
aws eks update-kubeconfig --name staging-eks-cluster --region eu-west-1

# View platform status
kubectl get pods -A

# Access Grafana dashboards
make view-grafana

# View Traefik dashboard  
make view-traefik

# Decrypt secrets for development
make decrypt-secrets SECRETS_DIR=./ops/secrets/[component-name]

💡 Pro Tip: All Makefile targets are documented in the Maintenance Tasks section.

Support & Contributing¶

🐛 Issues: Report bugs or request features
💬 Questions: Contact the infrastructure team
📖 ADRs: Review Architecture Decisions before major changes
🔄 Updates: Follow the deployment procedures

Architecture Decisions¶

Recent architectural decisions that shape this platform:

View all Architecture Decision Records (ADRs)
Understand our Security Model
Review Operational Standards

📚 Documentation Maintenance: This documentation is automatically generated and maintained. To update, see TechDocs maintenance guide.