Welcome to the AKS Workload Identity Sample documentation! This index provides a comprehensive guide to all available documentation in this repository.
| Document | Description | Audience |
|---|---|---|
| README.md | Main project documentation - Start here for complete setup guide | All users |
| File | Purpose | Audience |
| ------ | --------- | ---------- |
| QUICKSTART.md | 5-minute deployment guide | End users |
| start.sh | Interactive navigation script | All users |
| Document | Description | Use Case |
|---|---|---|
| Azure AD Admin Groups | Configure Azure AD groups for AKS cluster admin access | Required setup |
| Azure Federated Token File | Deep dive into workload identity token mechanism | Understanding & troubleshooting |
| Document | Description | Audience |
|---|---|---|
| NAMING.md | Azure resource naming conventions | Developers & operators |
| Network Workflow | Detailed network flow analysis - Pod to private storage traffic | Network engineers & troubleshooting |
| Private Storage Architecture | Private endpoint design and security | Infrastructure engineers |
| Terraform Modules | Infrastructure module documentation | Infrastructure engineers |
| Document | Description | Purpose |
|---|---|---|
| Examples Guide | Sample applications and test cases | Testing & validation |
| Test Storage Access | Workload identity connectivity test | Verification |
| Token Inspector | Token analysis and debugging | Troubleshooting |
| Document | Description | Audience |
|---|---|---|
| Copilot Prompts | GitHub Copilot generation prompts | Developers |
| Quick Start Guide | Rapid deployment instructions | DevOps engineers |
| Security Configuration | Security setup automation | Security engineers |
| Validation Guide | Testing and validation procedures | QA & operations |
| Templates | Reusable configuration templates | Developers |
Perfect for first-time users and quick deployments:
- README.md - Complete project overview
- Azure AD Admin Groups - Required access configuration
- Quick Start Guide - Rapid deployment path
For understanding the underlying mechanisms:
- Azure Federated Token File - Token authentication deep dive
- NAMING.md - Resource naming strategy
- Terraform Modules - Infrastructure architecture
For day-2 operations and issue resolution:
- Validation Guide - Testing procedures
- Examples Guide - Test cases and samples
- Azure Federated Token File - Troubleshooting section
For extending and modifying the solution:
- Copilot Prompts - AI-assisted development
- Templates - Reusable patterns
- Security Configuration - Security best practices
- Azure Workload Identity Documentation
- OAuth 2.0 Token Exchange RFC
- Kubernetes Service Account Token Volume Projection
📁 Repository Root
├── 📄 README.md (main documentation)
├── 📄 QUICKSTART.md (5-minute deployment guide)
├── 📄 NAMING.md (naming conventions)
├── 📁 docs/ (detailed technical documentation)
├── 📁 .copilot/ (development & automation guides)
├── 📁 examples/ (sample applications & tests)
└── 📁 infra/ (infrastructure documentation)
- Headers: Use descriptive headings with emoji for visual navigation
- Links: Always use relative paths for internal documentation
- Code Blocks: Include language tags for syntax highlighting
- Examples: Provide practical, runnable examples
- Cross-References: Link to related documentation sections
| Document | Status | Last Updated | Maintainer |
|---|---|---|---|
| README.md | ✅ Current | 2025-07-21 | @ckellywilson |
| azure-ad-admin-groups.md | ✅ Current | 2025-07-21 | @ckellywilson |
| azure-federated-token-file.md | ✅ Current | 2025-07-21 | Auto-generated |
| NAMING.md | ✅ Current | 2025-07-21 | @ckellywilson |
| examples/README.md | - | Needs content | |
| infra/tf/modules/README.md | ❌ Missing | - | Needs creation |
- Deploy for the first time → README.md → Azure AD Admin Groups
- Understand workload identity → Azure Federated Token File
- Test the deployment → Examples Guide → Validation Guide
- Troubleshoot issues → Azure Federated Token File
- Customize the solution → Copilot Prompts → Templates
- Understand naming → NAMING.md
- Create your documentation file in the appropriate directory
- Update this index with a link and description
- Add cross-references from related documents
- Update the status table above
- Technical accuracy review
- Link validation
- Example testing
- User experience review
💡 Tip: Use the browser's search function (Ctrl+F) to quickly find specific topics across all documentation files.
📧 Questions? Check the troubleshooting sections or create an issue in the repository.