sbrouet opened a new issue, #1496:
URL: https://github.com/apache/apisix-ingress-controller/issues/1496
Hello Team,
`ApisixRoute` CRD allows defining plugins to use at rule level only, either
with `plugins` or `plugin_config_name` element.
Currently, when 1 `ApisixRoute` has multiple rules, the plugins
configuration must be repeated to each rule. Even though we can define the
plugin configuration in an `ApisixPluginConfig`, we still need to specify the
`plugin_config_name` element for each rule.
Please feel free to comment and propose better approach.
Let me know if any information is missing or I did not respect some rule
when writing this issue, this is the first one I am opening on the project.
### High level proposal
- Allow plugin configurations at ApisixRoute level
- Note: I am not sure whether correct place would be directly under the
“spec” element or the “http” element
- Use same elements types as existing ones for defining plugins
configuration (`plugins` or `plugin_config_name`)
- Precedence rules must be defined
- Precedence rules should be consistent with other existing uses cases
- The most specific location overrides global configuration
- So if a plugin is defined at rule level, and same plugin is also defined
at `ApisixRoute` level, the plugin configuration at rule level overrides the
one from `ApisixRoute` level
### Sample ApisixRoute BEFORE change (current situation)
#### Using `plugins` element
The `proxy-rewrite` plugin configuration must be repeated for each rule
```
apiVersion: apisix.apache.org/v2
kind: ApisixRoute
metadata:
name: route-1-httpbin
namespace: httpbin
spec:
http:
- name: rule-1
# Criteria for a request to match this rule
match:
paths:
- /httpbin/*
methods:
- GET
backends:
# Name (metadata.name) of target ApisixUpstream object
- serviceName: httpbin
servicePort: 80
resolveGranularity: service
plugins:
- name: proxy-rewrite
enable: true
config:
regex_uri: [ "/httpbin/(.*)", "/$1" ]
- name: rule-2
# Criteria for a request to match this rule
match:
paths:
- /httpbin/status/*
methods:
- POST
backends:
# Name (metadata.name) of target ApisixUpstream object
- serviceName: httpbin
servicePort: 80
resolveGranularity: service
plugins:
- name: proxy-rewrite
enable: true
config:
regex_uri: [ "/httpbin/(.*)", "/$1" ]
```
#### Using `plugin_config_name` element
The `plugin_config_name` element must be repeated for each rule
```
apiVersion: apisix.apache.org/v2
kind: ApisixRoute
metadata:
name: route-1-httpbin
namespace: httpbin
spec:
http:
- name: rule-1
# Criteria for a request to match this rule
match:
paths:
- /httpbin/*
methods:
- GET
backends:
# Name (metadata.name) of target ApisixUpstream object
- serviceName: httpbin
servicePort: 80
resolveGranularity: service
# Plugin configuration is the name of ApisixPluginConfig object
plugin_config_name: httpbin-plugin-config
- name: rule-2
# Criteria for a request to match this rule
match:
paths:
- /httpbin/status/*
methods:
- POST
backends:
# Name (metadata.name) of target ApisixUpstream object
- serviceName: httpbin
servicePort: 80
resolveGranularity: service
# Plugin configuration is the name of ApisixPluginConfig object
plugin_config_name: httpbin-plugin-config
```
### Sample ApisixRoute AFTER change (current situation)
#### Using `plugins` element
```
apiVersion: apisix.apache.org/v2
kind: ApisixRoute
metadata:
name: route-1-httpbin
namespace: httpbin
spec:
# This plugin configuration should apply to all rules
plugins:
- name: proxy-rewrite
enable: true
config:
regex_uri: [ "/httpbin/(.*)", "/$1" ]
http:
- name: rule-1
# Criteria for a request to match this rule
match:
paths:
- /httpbin/*
methods:
- GET
backends:
# Name (metadata.name) of target ApisixUpstream object
- serviceName: httpbin
servicePort: 80
resolveGranularity: service
# proxy-rewrite does not need anymore to be defined here, but can be
overridden if required
# Other plugins configurations specific to this rule could be added
- name: rule-2
# Criteria for a request to match this rule
match:
paths:
- /httpbin/status/*
methods:
- POST
backends:
# Name (metadata.name) of target ApisixUpstream object
- serviceName: httpbin
servicePort: 80
resolveGranularity: service
# proxy-rewrite does not need anymore to be defined here, but can
be overridden if required
# Sample additional plugin configuration which should apply to
this rule
# in addition to the globally defined proxy-rewrite
plugins:
- name: request-id
enable: true
```
#### Using `plugin_config_name` element
```
apiVersion: apisix.apache.org/v2
kind: ApisixRoute
metadata:
name: route-1-httpbin
namespace: httpbin
spec:
http:
- name: rule-1
# Criteria for a request to match this rule
match:
paths:
- /httpbin/*
methods:
- GET
backends:
# Name (metadata.name) of target ApisixUpstream object
- serviceName: httpbin
servicePort: 80
resolveGranularity: service
# Plugin configuration is the name of ApisixPluginConfig object
plugin_config_name: httpbin-plugin-config
- name: rule-2
# Criteria for a request to match this rule
match:
paths:
- /httpbin/status/*
methods:
- POST
backends:
# Name (metadata.name) of target ApisixUpstream object
- serviceName: httpbin
servicePort: 80
resolveGranularity: service
# Plugin configuration is the name of ApisixPluginConfig object
plugin_config_name: httpbin-plugin-config
```
Thank you Team for your good work !
Sébastien
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
