Skip to content

Commit bdbb3b9

Browse files
authored
docs: add FAQ page (#2561)
* add FAQ * lint * remove section
1 parent b47ed04 commit bdbb3b9

File tree

2 files changed

+60
-0
lines changed

2 files changed

+60
-0
lines changed

docs/en/latest/FAQ.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
---
2+
title: FAQ
3+
keywords:
4+
- APISIX Ingress
5+
- Apache APISIX
6+
- Kubernetes Ingress
7+
- Gateway API
8+
- FAQ
9+
description: This document provides answers to frequently asked questions (FAQ) when using APISIX Ingress Controller.
10+
---
11+
12+
<!--
13+
#
14+
# Licensed to the Apache Software Foundation (ASF) under one or more
15+
# contributor license agreements.See the NOTICE file distributed with
16+
# this work for additional information regarding copyright ownership.
17+
# The ASF licenses this file to You under the Apache License, Version 2.0
18+
# (the "License"); you may not use this file except in compliance with
19+
# the License.You may obtain a copy of the License at
20+
#
21+
# http://www.apache.org/licenses/LICENSE-2.0
22+
#
23+
# Unless required by applicable law or agreed to in writing, software
24+
# distributed under the License is distributed on an "AS IS" BASIS,
25+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
26+
# See the License for the specific language governing permissions and
27+
# limitations under the License.
28+
#
29+
-->
30+
31+
This document provides answers to frequently asked questions (FAQ) when using APISIX Ingress Controller.
32+
33+
### How does Ingress Controller handle route priority across multiple resources?
34+
35+
In APISIX, a higher value indicates a higher route priority.
36+
37+
* **Ingress:** Does not support explicit route priority. Routes created using Ingress are assigned a default priority of 0, typically the lowest.
38+
* **HTTPRoute:** Has a [38-bit priority](https://github.com/apache/apisix-ingress-controller/blob/master/internal/adc/translator/httproute.go#L428-L448). The priority calculation is dynamic and may change, making exact values difficult to predict.
39+
* **APISIXRoute:** Can be assigned an explicit priority. To have a higher priority than an HTTPRoute, the value must exceed 549,755,813,887 (2^39 − 1).
40+
41+
### How do HTTPRoute filters interact with PluginConfig CRDs?
42+
43+
APISIX maps built-in Gateway API HTTPRoute filters to specific plugins:
44+
45+
* `RequestHeaderModifier``proxy-rewrite`
46+
* `RequestRedirect``redirect`
47+
* `RequestMirror``proxy-mirror`
48+
* `URLRewrite``proxy-rewrite`
49+
* `ResponseHeaderModifier``response-rewrite`
50+
* `CORS``cors`
51+
* `ExtensionRef` → user-defined plugin reference
52+
53+
When both filters and a PluginConfig CRD are applied:
54+
55+
* If filters are applied first, PluginConfig overrides any overlapping plugin settings.
56+
* If PluginConfig is applied first, filters merge with PluginConfig settings, and overlapping fields from filters take precedence.

docs/en/latest/config.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,10 @@
4545
"type": "doc",
4646
"id": "upgrade-guide"
4747
},
48+
{
49+
"type": "doc",
50+
"id": "FAQ"
51+
},
4852
{
4953
"type": "link",
5054
"label": "CHANGELOG",

0 commit comments

Comments
 (0)