|
| 1 | +--- |
| 2 | +title: APISIX Ingress Controller Resources |
| 3 | +keywords: |
| 4 | + - APISIX Ingress |
| 5 | + - Apache APISIX |
| 6 | + - Kubernetes Ingress |
| 7 | + - Gateway API |
| 8 | +description: APISIX Ingress Controller Resources, including Kubernetes resources, Gateway API, and APISIX Ingress Controller CRDs API. |
| 9 | +--- |
| 10 | +<!-- |
| 11 | +# |
| 12 | +# Licensed to the Apache Software Foundation (ASF) under one or more |
| 13 | +# contributor license agreements. See the NOTICE file distributed with |
| 14 | +# this work for additional information regarding copyright ownership. |
| 15 | +# The ASF licenses this file to You under the Apache License, Version 2.0 |
| 16 | +# (the "License"); you may not use this file except in compliance with |
| 17 | +# the License. You may obtain a copy of the License at |
| 18 | +# |
| 19 | +# http://www.apache.org/licenses/LICENSE-2.0 |
| 20 | +# |
| 21 | +# Unless required by applicable law or agreed to in writing, software |
| 22 | +# distributed under the License is distributed on an "AS IS" BASIS, |
| 23 | +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 24 | +# See the License for the specific language governing permissions and |
| 25 | +# limitations under the License. |
| 26 | +# |
| 27 | +--> |
| 28 | + |
| 29 | +## Kubernetes Resources |
| 30 | + |
| 31 | +### Service |
| 32 | + |
| 33 | +In Kubernetes, a Service is a method to expose network applications running on a set of Pods as network services. |
| 34 | + |
| 35 | +When proxying ingress traffic, APISIX Gateway by default directs traffic directly to the Pods instead of through kube-proxy. |
| 36 | + |
| 37 | +### EndpointSlices |
| 38 | + |
| 39 | +EndpointSlice objects represent subsets (slices) of backend network endpoints for a Service. |
| 40 | + |
| 41 | +The APISIX Ingress Controller continuously tracks matching EndpointSlice objects, and whenever the set of Pods in a Service changes, the set of Pods proxied by the APISIX Gateway will also update accordingly. |
| 42 | + |
| 43 | +### Ingress |
| 44 | + |
| 45 | +Ingress is a Kubernetes resource that manages external access to services within a cluster, typically HTTP and HTTPS traffic. It provides a way to define rules for routing external traffic to internal services. |
| 46 | + |
| 47 | +## Gateway API |
| 48 | + |
| 49 | +Gateway API is an official Kubernetes project focused on L4 and L7 routing in Kubernetes. This project represents the next generation of Kubernetes Ingress, Load Balancing, and Service Mesh APIs. |
| 50 | + |
| 51 | +For more information on supporting Gateway API, please refer to [Gateway API](./gateway-api.md). |
| 52 | + |
| 53 | +## APISIX Ingress Controller CRDs API |
| 54 | + |
| 55 | +The APISIX Ingress Controller defines several Custom Resource Definitions (CRDs) to manage routing, upstreams, TLS, and cluster settings declaratively. |
| 56 | + |
| 57 | +### Gateway API Extensions |
| 58 | + |
| 59 | +Enable additional features not included in the standard Kubernetes Gateway API, developed and maintained by Gateway API implementers to extend functionality securely and reliably. |
| 60 | + |
| 61 | +* GatewayProxy: Defines connection settings between the APISIX Ingress Controller and APISIX, including auth, endpoints, and global plugins. Referenced via parametersRef in Gateway, GatewayClass, or IngressClass |
| 62 | + |
| 63 | +* BackendTrafficPolicy: Defines traffic management settings for backend services, including load balancing, timeouts, retries, and host header handling in the APISIX Ingress Controller. |
| 64 | + |
| 65 | +* Consumer: Defines API consumers and their credentials, enabling authentication and plugin configuration for controlling access to API endpoints. |
| 66 | + |
| 67 | +* PluginConfig: Defines reusable plugin configurations that can be referenced by other resources like HTTPRoute, enabling separation of routing logic and plugin settings for better reusability and manageability. |
| 68 | + |
| 69 | +* HTTPRoutePolicy: Configures advanced traffic management and routing policies for HTTPRoute or Ingress resources, enhancing functionality without modifying the original resources. |
| 70 | + |
| 71 | + |
| 72 | + |
| 73 | +## Ingress API Extensions |
| 74 | + |
| 75 | +APISIX Ingress Controller CRDs extend Kubernetes functionality to provide declarative configuration management for the Apache APISIX gateway, supporting advanced routing, traffic management, and security policies. |
| 76 | + |
| 77 | +* ApisixRoute: Defines routing rules for HTTP/TCP/UDP, supporting path matching, hostnames, method filtering, and backend service configurations. Can reference ApisixUpstream and ApisixPluginConfig resources. |
| 78 | + |
| 79 | +* ApisixUpstream: Extends Kubernetes Services with advanced configurations such as load balancing, health checks, retries, timeouts, and service subset selection. |
| 80 | + |
| 81 | +* ApisixConsumer: Defines API consumers and their authentication credentials, supporting methods like basicAuth, keyAuth, jwtAuth, hmacAuth, wolfRBAC, and ldapAuth. |
| 82 | + |
| 83 | +* ApisixPluginConfig: Defines reusable plugin configurations referenced by ApisixRoute through the plugin_config_name field, promoting separation of routing logic and plugin settings. |
| 84 | + |
| 85 | +* ApisixTls: Manages SSL/TLS certificates, supporting SNI binding and mutual TLS for secure APISIX gateway connections. |
| 86 | + |
| 87 | + |
0 commit comments