Gateway API Learning Documentation
Welcome to the Gateway API learning path! This documentation is designed to help you understand Gateway API by comparing it to Nginx Ingress Controllers, which you may already be familiar with.
Learning Path
Follow these documents in order for a progressive learning experience. Start with the basics and work your way up to advanced topics.
📚 Start Here (Basics)
- Introduction - Learn what Gateway API is and why it exists
- Core Concepts - Understand GatewayClass, Gateway, and HTTPRoute
- Basic Routing - Learn hostname and path matching
🚀 Intermediate Topics
- Advanced Routing - Header, query parameter, and method matching
- Traffic Splitting - Weighted routing and canary deployments
- TLS/SSL - Certificate management and TLS configuration
⚙️ Advanced Topics
- Request/Response Modifications - URL rewriting and header modifications
- Policies - Policy attachments and advanced features
📖 Practical Guides
- Migration Guide - Step-by-step migration from Nginx Ingress
- Best Practices - Recommendations and best practices
How to Use This Documentation
- Each document includes side-by-side comparisons with Nginx Ingress Controllers
- Code examples are included inline in each document
- Working examples are available in the Examples section
- Each example folder corresponds to the documentation topics
Prerequisites
- Basic understanding of Kubernetes
- Familiarity with Nginx Ingress Controllers (helpful but not required)
- Access to a Kubernetes cluster with Gateway API support
Quick Reference
Key Resources
- GatewayClass: Defines the type of Gateway (like IngressClass)
- Gateway: Defines network endpoints (like Ingress Controller setup)
- HTTPRoute: Defines routing rules (like Ingress resource)
Common Patterns
- Basic routing → See Basic Routing documentation
- Traffic splitting → See Traffic Splitting documentation
- TLS configuration → See TLS/SSL documentation
- URL rewriting → See Request/Response Modifications documentation
Examples
All working examples are located in the Examples section, organized by topic. Each example includes:
- Working YAML configuration
- Comments explaining key fields
- References to the corresponding documentation section
- Nginx Ingress equivalents where applicable