Welcome to the ITlusions Kubernetes (ITL.K8s) documentation repository. This repository serves as the central hub for all Kubernetes-related documentation, best practices, configurations, and operational guides.

• Quick Start
• Documentation Structure
• Storage Classes
• Authentication
• Getting Started
• Contributing
• Support

1. 📖 Read the Documentation Index - Start here for a complete overview
2. 🔐 Set up GitHub Authentication - Configure cluster access
3. 💾 Understand Storage Classes - Choose the right storage for your workloads
4. � Review Emergency Access - Understand break glass procedures
5. �🛠️ Follow our Best Practices - Ensure production-ready deployments

ITL.K8s/
├── README.md                          # This file - main entry point
├── docs/
│   ├── index.md                       # Complete documentation index
│   ├── authentication/
│   │   ├── GITHUB_AUTHENTICATION.md  # GitHub OAuth for Kubernetes
│   │   └── EMERGENCY_ACCESS.md        # Break glass emergency procedures
│   └── storageClasses/
│       ├── README.md                  # Storage classes overview
│       ├── ha-dbs-lh.yaml            # High availability database storage
│       ├── longhorn.yaml             # Default distributed storage
│       ├── longhorn-static.yaml      # Simplified Longhorn storage
│       ├── minio-data.yaml           # MinIO object storage
│       ├── nfs-csi.yaml              # Network file system storage
│       ├── openebs-hostpath.yaml     # Local high-performance storage
│       └── local-storage.yaml        # Manual provisioned storage
└── [Additional directories as needed]

Our Kubernetes cluster provides multiple storage classes optimized for different workloads:

👉 Complete Storage Classes Guide

# For databases (PostgreSQL, MySQL, MongoDB)
kubectl apply -f - <<EOF
apiVersion: v1
kind: PersistentVolumeClaim
metadata:
  name: database-storage
spec:
  accessModes: [ReadWriteOnce]
  storageClassName: ha-dbs-lh
  resources:
    requests:
      storage: 10Gi
EOF

# For applications
kubectl apply -f - <<EOF
apiVersion: v1
kind: PersistentVolumeClaim
metadata:
  name: app-storage
spec:
  accessModes: [ReadWriteOnce]
  storageClassName: longhorn
  resources:
    requests:
      storage: 5Gi
EOF

We use GitHub OAuth for Kubernetes cluster authentication through Keycloak:

• ✅ Single Sign-On: Use your GitHub credentials
• ✅ Team-based Access: GitHub teams → Kubernetes RBAC
• ✅ Centralized Management: All access through Keycloak
• ✅ Audit Trail: Complete authentication logging

👉 Setup GitHub Authentication

When normal authentication fails, we provide tiered emergency access:

1. Emergency Keycloak Accounts: Local admin accounts in Keycloak (fastest)
2. Node-stored Configuration: Emergency kubeconfig on control plane nodes
3. Vault Backup: Final fallback through HashiCorp Vault

👉 Emergency Access Procedures

# Check your current authentication
kubectl auth whoami

# Login with GitHub (via Keycloak)
kubectl oidc-login

# Verify your permissions
kubectl auth can-i get pods --namespace=default

1. Setup Access: Follow the GitHub Authentication Guide
2. Choose Storage: Use the Storage Classes Guide
3. Deploy Applications: Follow our deployment best practices
4. Monitor: Use our monitoring dashboards

1. Read Full Documentation: Start with docs/index.md
2. Understand Architecture: Review infrastructure patterns
3. Configure Security: Implement RBAC and network policies
4. Setup Monitoring: Deploy observability stack

1. CI/CD Integration: Setup GitHub Actions with OIDC
2. GitOps Workflows: Configure ArgoCD deployments
3. Security Policies: Implement Pod Security Standards
4. Disaster Recovery: Setup backup and recovery procedures

• Use ha-dbs-lh storage class for production databases
• Implement network policies for pod-to-pod communication
• Regular security audits and compliance checks
• Principle of least privilege for RBAC

• Choose appropriate storage classes for workload requirements
• Monitor resource usage and set appropriate limits
• Use horizontal pod autoscaling where applicable
• Optimize container images for faster startup

• Right-size storage volumes and compute resources
• Use spot instances where appropriate
• Regular cleanup of unused resources
• Monitor and optimize cluster utilization

• Follow GitOps practices for all deployments
• Implement comprehensive monitoring and alerting
• Document all customizations and configurations
• Regular backup and disaster recovery testing

• Platform Team: Overall cluster management and infrastructure
• Security Team: Security policies and compliance
• DevOps Team: CI/CD and deployment automation

• Cluster Dashboard: https://dashboard.dev.itlusions.com
• Grafana Monitoring: https://grafana.dev.itlusions.com
• ArgoCD GitOps: https://argocd.dev.itlusions.com
• Keycloak Auth: https://sts.itlusions.com

This documentation is maintained by the ITlusions Platform Team.

Last Updated: September 14, 2025 | Version: 1.0 | Status: 🟢 Active

💡 Tip: Bookmark this README and the Documentation Index for quick access to all Kubernetes resources!

Happy Kubernetes-ing! 🚢