How istio/api works
Main Components
a. API Groups (Primary Components):
• Networking APIs (v1, v1beta1, v1alpha3)
• Security APIs (v1, v1beta1, v1alpha1)
• Telemetry APIs (v1, v1alpha1)
• Mesh Configuration (v1alpha1)
• Extensions (v1alpha1)
• Authentication (v1alpha1)
b. Supporting Components:
• Common Protos (Google API definitions)
• Type Definitions (v1beta1)
• Meta Components (v1alpha1)
• Envoy Filter Configurations
┌─────────────────────────────────────────────────────────────┐
• Client Interfaces │
• ┤
• Core API Definitions │
• ┌─────────────┐ ┌─────────────┐ ┌─────────────┐ │
• Networking │ │ Security │ │ Telemetry │ │
• ┘ └─────────────┘ └─────────────┘ │
• ┌─────────────┐ ┌─────────────┐ ┌─────────────┐ │
• Mesh │ │ Extensions │ │ Auth │ │
• ┘ └─────────────┘ └─────────────┘ │
• ┤
• Common Infrastructure │
• ┌─────────────┐ ┌─────────────┐ ┌─────────────┐ │
• Types │ │ Meta │ │ Common │ │
• ┘ └─────────────┘ └─────────────┘ │
• ┘
Key Elements to Highlight
• Deprecated APIs with distinct marking
• CRD generation flow
• Protobuf compilation pipeline
Specific Implementation Details
a. Version Relationships:
• Green: Stable APIs (v1)
• Yellow: Beta APIs (v1beta1)
• Orange: Alpha APIs (v1alpha1)
• Blue: Common Infrastructure
• Gray: Supporting Components
Additional Elements
• Annotations for important configuration files (buf.yaml, Makefile)
• Validation flow for API changes
• Test coverage and validation points
Implementation Notes
• Maintain consistent spacing and alignment
• Clear labels for all components
• Version numbers where applicable
• Integration points with other Istio components