help request: plugin conflict handling and aprerequisites #7179

mygaochunming · 2022-06-01T08:35:16Z

mygaochunming
Jun 1, 2022

I have read the priority of the plugin by documents

the chapter Global rules does not tell me the conflict handling rules between "global rules" and rules in cosumer/route/service.

Exclude global rules, I think apisix handle plugin‘s flow like this(image 001)

but when I read the plugins chapter , I'm confused .

For Key-Auth plugin

curl http://127.0.0.1:9080/apisix/admin/consumers -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
{
    "username": "jack",
    "plugins": {
        "key-auth": {
            "key": "auth-one"
        }
    }
}'

curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
{
    "methods": ["GET"],
    "uri": "/index.html",
    "id": 1,
    "upstream": {
        "type": "roundrobin",
        "nodes": {
            "127.0.0.1:1980": 1
        }
    }
}'



curl http://127.0.0.2:9080/index.html -i

=============I GOT BEGIN==================

HTTP/1.1 502 Bad Gateway
Date: Wed, 01 Jun 2022 07:13:05 GMT
Content-Type: text/html; charset=utf-8
Content-Length: 154
Connection: keep-alive
Server: APISIX/2.14.0
X-APISIX-Upstream-Status: 502

<html>
<head><title>502 Bad Gateway</title></head>
<body>
<center><h1>502 Bad Gateway</h1></center>
<hr><center>openresty</center>
</body>
</html>
=============I GOT END==================

curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
{
    "methods": ["GET"],
    "uri": "/index.html",
    "id": 1,
    "plugins": {
        "key-auth": {}
    },
    "upstream": {
        "type": "roundrobin",
        "nodes": {
            "127.0.0.1:1980": 1
        }
    }
}'

curl http://127.0.0.2:9080/index.html -i

=============I GOT BEGIN==================

HTTP/1.1 401 Unauthorized
Date: Wed, 01 Jun 2022 07:16:45 GMT
Content-Type: text/html; charset=utf-8
Transfer-Encoding: chunked
Connection: keep-alive
Server: APISIX/2.14.0

{"message":"Missing API key found in request"}
=============I GOT END==================

curl http://127.0.0.2:9080/index.html -H 'apikey: auth-one' -i

=============I GOT BEGIN==================

HTTP/1.1 502 Bad Gateway
Date: Wed, 01 Jun 2022 07:17:49 GMT
Content-Type: text/html; charset=utf-8
Content-Length: 154
Connection: keep-alive
Server: APISIX/2.14.0
X-APISIX-Upstream-Status: 502

<html>
<head><title>502 Bad Gateway</title></head>
<body>
<center><h1>502 Bad Gateway</h1></center>
<hr><center>openresty</center>
</body>
</html>
=============I GOT END==================

ignore the "502 Bad Gateway" error messages, It looks like that whether the Key-Auth plugin works or not is restricted by the route rule

"plugins": {
        "key-auth": {}
    }

If it configed then the key-Auth works otherwise it not work.

Maybe the operation of a plugin is not only affected by the priority and the above conflict handling rules, some plugins require aprerequisites to run.

Because I’m new about lua and openResty, it's hard for me to read the source code, I need help for explaining about :

thanks in advance.

Answered by membphis

Jun 8, 2022

I drew a picture for you to know the detail, and you can get the flow from the source code:

https://github.com/apache/apisix/blob/master/apisix/init.lua#L366-L453

View full answer

moonming · 2022-06-08T01:07:36Z

moonming
Jun 8, 2022
Collaborator

@membphis please take a look

3 replies

tokers Jun 8, 2022
Collaborator

Actually, the "plugin" you configured on the consumer is just some credentials, these "plugins" don't affect the running of APISIX. Whether a plugin will be executed for a request is decided by the current route matched with this request.

mygaochunming Jun 13, 2022
Author

Thanks very much.

mygaochunming Jun 14, 2022
Author

@tokers

Does this mean the consumer's plugins will be run whether or not it defined in the route?

membphis · 2022-06-08T07:08:14Z

membphis
Jun 8, 2022
Collaborator

I drew a picture for you to know the detail, and you can get the flow from the source code:

https://github.com/apache/apisix/blob/master/apisix/init.lua#L366-L453

1 reply

mygaochunming Jun 13, 2022
Author

Thanks for your answer, Much clearer now.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

help request: plugin conflict handling and aprerequisites #7179

Uh oh!

{{title}}

Uh oh!

Replies: 2 comments 4 replies

Uh oh!

{{title}}

Uh oh!

Uh oh!

{{title}}

Uh oh!

Uh oh!

{{title}}

Uh oh!

Uh oh!

{{title}}

Uh oh!

Uh oh!

{{title}}

Uh oh!

Uh oh!

{{title}}

Uh oh!

Select a reply

Uh oh!

help request: plugin conflict handling and aprerequisites #7179

Uh oh!

mygaochunming Jun 1, 2022

Replies: 2 comments · 4 replies

Uh oh!

moonming Jun 8, 2022 Collaborator

Uh oh!

tokers Jun 8, 2022 Collaborator

Uh oh!

mygaochunming Jun 13, 2022 Author

Uh oh!

mygaochunming Jun 14, 2022 Author

Uh oh!

membphis Jun 8, 2022 Collaborator

Uh oh!

mygaochunming Jun 13, 2022 Author

mygaochunming
Jun 1, 2022

Replies: 2 comments 4 replies

moonming
Jun 8, 2022
Collaborator

tokers Jun 8, 2022
Collaborator

mygaochunming Jun 13, 2022
Author

mygaochunming Jun 14, 2022
Author

membphis
Jun 8, 2022
Collaborator

mygaochunming Jun 13, 2022
Author