ingress2gateway

Contents:

  • Getting Started
    • Prerequisites
    • Installation
      • Using pip (recommended)
      • Using uv (for development)
      • From source
    • Quick Start
      • CLI
      • Web UI
      • Python API
    • Verify Installation
      • CLI
      • Web Server
    • Next Steps
  • Usage Guide
    • Web Interface
      • Getting Started
      • Web UI Features
      • Example Workflow
    • CLI Usage
      • Basic Conversion
      • Multi-Document YAML
      • Migration Reports
      • Reverse Conversion
      • Validation
    • REST API
      • Convert Endpoint
      • Reverse Endpoint
      • Validate Endpoint
      • Download Endpoints
      • Report Endpoint
      • Providers Endpoint
      • Health Check
      • OpenAPI Documentation
    • Python API
      • Basic Usage
      • With Provider Defaults
      • With Validation
      • With Annotations
      • Generate Migration Report
  • CLI Reference
    • Command Names
    • Installation
    • Commands
      • convert
      • reverse
      • validate
      • providers
      • serve
    • Exit Codes
    • Environment Variables
    • Piping and Scripting
  • API Reference
    • Python API
      • Converter Module
        • parse_ingress(ingress_yaml: str) -> dict
        • convert_ingress_to_gateway(ingress: dict) -> dict
        • resources_to_yaml(resources: dict) -> str
      • Annotations Module
        • parse_annotations(annotations: dict) -> dict
        • get_annotation_warnings(parsed: dict) -> list[str]
      • Providers Module
        • list_providers() -> list[dict]
        • get_provider(provider_id: str) -> dict
        • apply_provider_defaults(gateway: dict, provider_id: str) -> dict
      • Validation Module
        • validate_ingress(ingress: dict) -> ValidationResult
        • validate_gateway(gateway: dict) -> ValidationResult
        • validate_httproute(route: dict) -> ValidationResult
        • ValidationResult
      • Reverse Module
        • convert_gateway_to_ingress(gateway: dict, httproutes: list) -> dict
        • gateway_resources_to_ingress_yaml(gateway: dict, httproutes: list) -> str
        • parse_gateway_resources(yaml_content: str) -> tuple[dict, list]
      • gRPC Module
        • is_grpc_backend(ingress: dict, service_name: str) -> bool
        • create_grpc_route(httproute: dict) -> dict
      • Report Module
        • generate_migration_report(...) -> str
        • generate_diff_summary(ingress: dict, gateway: dict) -> dict
    • REST API
      • POST /api/convert
      • POST /api/reverse
      • POST /api/validate
      • GET /api/providers
      • POST /api/download/single
      • POST /api/download/separate
      • POST /api/download/kustomize
      • POST /api/report
      • GET /health
    • Error Responses
  • Provider Presets
    • Available Providers
    • Provider Details
      • Istio
      • Envoy Gateway
      • Contour
      • Kong
      • NGINX Gateway Fabric
      • Traefik
      • GKE Gateway Controller
    • Using Providers in Code
    • Custom Gateway Class
  • Conversion Mapping
    • Overview
    • Field Mapping
      • Ingress to Gateway
      • Ingress to HTTPRoute
      • Path Type Mapping
    • Annotation Mapping
      • Nginx Ingress Annotations
      • Traefik Annotations
      • Istio Annotations
    • gRPC Detection
    • Examples
      • Basic Ingress
      • Ingress with TLS
      • Ingress with Rewrite Annotation
    • Reverse Mapping (Gateway API to Ingress)
    • Supported Features
    • Limitations
  • GitHub Action
    • Basic Usage
    • Inputs
    • Outputs
    • Examples
      • With Provider Preset
      • With Migration Report
      • With gRPC Detection
      • Complete Workflow with Commit
      • Pull Request Workflow
      • Matrix Strategy for Multiple Files
    • Artifacts
    • Troubleshooting
      • Action fails with “No Ingress resources found”
      • Provider not recognized
      • Permission denied when committing
  • kubectl Plugin
    • Installation
      • Download from Release
      • Install from Source
    • Commands
      • convert
      • list
      • apply
      • diff
    • Options
    • Examples
      • Basic Workflow
      • Migration Script
      • CI/CD Integration
    • Troubleshooting
      • Plugin Not Found
      • Permission Denied
      • Missing Dependencies
  • Helm Chart
    • Prerequisites
    • Installation
      • Add Helm Repository
      • Install Chart
      • Install from Source
    • Configuration
      • Basic Values
      • Ingress Configuration
      • Gateway API Configuration
      • Resources
      • Application Configuration
    • Examples
      • With Ingress
      • With Gateway API
      • With Autoscaling
      • Production Configuration
    • Upgrading
    • Uninstalling
    • Building the Docker Image
    • Troubleshooting
      • Pod Not Starting
      • Service Not Accessible
      • Health Check Failing
ingress2gateway
  • Search

© Copyright 2024, pmady.

Built with Sphinx using a theme provided by Read the Docs.