envoyproxy/gateway-crds-helm

Envoy Gateway CRDs 镜像文档

概述

该镜像包含Envoy Gateway所需的Kubernetes自定义资源定义(CRDs)，是在Kubernetes集群中部署和管理Envoy Gateway的基础组件。通过这些CRDs，用户可采用声明式方式定义和配置Envoy Gateway的核心资源，实现网关、路由规则、服务暴露等功能的标准化管理。

核心功能与特性

• 资源定义标准化：提供统一的CRD规范，定义Envoy Gateway的核心资源类型，包括网关（Gateway）、网关类（GatewayClass）、HTTP路由（HTTPRoute）、GRPC路由（GRPCRoute）等。
• 声明式配置支持：支持通过Kubernetes YAML文件声明式定义资源，实现配置即代码（Configuration as Code），便于版本控制和自动化管理。
• 与Kubernetes原生集成：遵循Kubernetes API规范，可与kubectl、kube-apiserver等原生组件无缝协作，支持资源的创建、更新、删除和查询操作。
• 扩展性支持：预留扩展字段，支持未来Envoy Gateway功能扩展时的资源定义扩展。

使用场景

• 在Kubernetes集群中部署Envoy Gateway作为入口网关时，用于定义和管理网关实例。
• 配置HTTP/HTTPS路由规则，实现请求的转发、分流、重定向等流量管理功能。
• 定义服务暴露策略，将集群内服务通过Envoy Gateway安全暴露到集群外部。
• 在CI/CD流程中集成，通过自动化工具（如ArgoCD、Flux）实现Envoy Gateway配置的持续部署和更新。

使用方法

前提条件

• Kubernetes集群版本≥1.21（支持CRD v1版本）。
• 已安装kubectl工具并配置集群访问权限。

安装CRDs

通过以下命令从镜像中提取并安装CRDs：

bash
# 从镜像中导出CRD清单文件（需先确保镜像可访问，或通过容器运行时导出）
kubectl apply -f https://raw.githubusercontent.com/envoyproxy/gateway/v1.0.0/config/crd/bases/gateway.envoyproxy.io_gateways.yaml
kubectl apply -f https://raw.githubusercontent.com/envoyproxy/gateway/v1.0.0/config/crd/bases/gateway.envoyproxy.io_gatewayclasses.yaml
kubectl apply -f https://raw.githubusercontent.com/envoyproxy/gateway/v1.0.0/config/crd/bases/gateway.envoyproxy.io_httproutes.yaml
kubectl apply -f https://raw.githubusercontent.com/envoyproxy/gateway/v1.0.0/config/crd/bases/gateway.envoyproxy.io_grpcroutes.yaml
# 其他CRDs文件可根据Envoy Gateway版本从官方仓库获取

验证安装

安装完成后，可通过以下命令验证CRDs是否成功部署：

bash
kubectl get crds | grep gateway.envoyproxy.io

预期输出包含已安装的CRD资源，如：

gatewayclasses.gateway.envoyproxy.io   2024-01-01T00:00:00Z
gateways.gateway.envoyproxy.io         2024-01-01T00:00:00Z
httproutes.gateway.envoyproxy.io       2024-01-01T00:00:00Z
grpcroutes.gateway.envoyproxy.io       2024-01-01T00:00:00Z

示例：定义HTTPRoute资源

使用该CRDs定义HTTP路由规则示例：

yaml
apiVersion: gateway.envoyproxy.io/v1alpha1
kind: HTTPRoute
metadata:
  name: example-http-route
  namespace: default
spec:
  parentRefs:
  - name: example-gateway
    namespace: default
  hostnames:
  - "example.com"
  rules:
  - matches:
    - path:
        type: PathPrefix
        value: /api
    backendRefs:
    - name: api-service
      port: 8080

应用上述配置：

bash
kubectl apply -f example-http-route.yaml

注意事项

• CRDs版本需与Envoy Gateway版本匹配，使用前请确认兼容性。
• 修改CRDs定义可能影响现有资源，建议通过官方升级流程进行版本更新。
• 卸载CRDs前需确保集群中无依赖该CRDs的资源存在，避免资源残留。