Support global plugin #820

juzhiyuan · 2020-11-18T05:54:00Z

Background

The global plugin acts on every request and it is not bound to any Service, Route, or Consumer, which reduces the need to set up the same plugin configuration repeatedly for multiple resources.

Solution

Frontend

In the plug-in module, we will first support the global plugin, and in-scope plugin in the future. In this proposal, the focus will be on the global plugin.

3 pages are involved:

The plugin enabled list page;
Plugin list page;
The plugin configuration page.

In this revision, the plugin list page and plugin configuration page will be adjusted, and the following are the changes:

The plugin list page is only used to select plug-ins;
Plugin configuration from the original drawer, changed to a separate plugin configuration page, mainly to be compatible with the increase in the number of fields behind, resulting in the drawer can not well carry more content.

Use process

Users in the plugin module, click the Add Plugin button to jump to the plug-in list page;
The user in the plugin list page, find the target plugin, then click the configuration button to enter the plugin configuration page;
Users in the plugin configuration page, you can choose to enable or disable the plugin, you can choose the scope of the plugin: global or with scope (Service, Route), currently only supports the global;
The user enters data in the plugin data editor (form or code editor, currently only the latter is supported) and returns to the enabled plugins list page after successful saving.

NOTE
We will modify 3 modules:

Add Plugins module;
Update Route, Consumer with the latest plugin component mentioned above.

Backend

refer to https://github.com/apache/apisix/blob/5de6ee467f83c38f31eff6cfd683736b441ac9c2/doc/zh-cn/architecture-design.md#global-rule

API: set global plugins

PUT /apisix/admin/global_rules/{FIXED_GLOBAL_RULE_ID}

{
        "plugins": {
            "limit-count": {
                "time_window": 60,
                "policy": "local",
                "count": 2,
                "key": "remote_addr",
                "rejected_code": 503
            }
        }
    }

API: get global plugins

GET /apisix/admin/global_rules/{FIXED_GLOBAL_RULE_ID}

{
        "plugins": {
            "limit-count": {
                "time_window": 60,
                "policy": "local",
                "count": 2,
                "key": "remote_addr",
                "rejected_code": 503
            }
        }
    }

Reference

The text was updated successfully, but these errors were encountered:

moonming · 2020-11-18T05:55:46Z

We need to list the plug-in as an object separately, at this time etcd may not be convenient to use directly

juzhiyuan · 2020-11-18T09:12:49Z

got it

moonming · 2020-12-11T10:46:55Z

why remove from MS？

membphis · 2020-12-12T01:05:36Z

@juzhiyuan you need to submit your design for this issue and update the title

juzhiyuan · 2020-12-12T01:14:14Z

Of course, the proposal would be finished and discuss completed no longer than next week.

juzhiyuan · 2020-12-13T06:14:26Z

Please take a look at this proposal, to check if there have any improvements about Global Plugin.

cc @nic-chen @liuxiran @ShiningRush @tokers @LiteSun @Miss-you @membphis

membphis · 2020-12-13T13:56:53Z

@juzhiyuan the Admin API has implemented the global rule API: https://github.com/apache/apisix/blob/5de6ee467f83c38f31eff6cfd683736b441ac9c2/doc/zh-cn/architecture-design.md#global-rule

So I think we'd better use the existing APIs.

membphis · 2020-12-13T13:58:50Z

juzhiyuan · 2020-12-13T14:53:27Z

@membphis np, I just updated the proposal about the API part.

Global Plugin is easier to understand than Global Rule IMHO 🤔 Let's wait for others feedback.

nic-chen · 2020-12-14T01:37:57Z

I think the APIs should be consistent with the existing, refer to:

API: set global rule

PUT /apisix/admin/global_rules/1

{
        "plugins": {
            "limit-count": {
                "time_window": 60,
                "policy": "local",
                "count": 2,
                "key": "remote_addr",
                "rejected_code": 503
            }
        }
    }

API: get global rule

GET /apisix/admin/global_rules/1

{
        "plugins": {
            "limit-count": {
                "time_window": 60,
                "policy": "local",
                "count": 2,
                "key": "remote_addr",
                "rejected_code": 503
            }
        }
    }

API: get global rule list(new)

GET /apisix/admin/global_rules?page=1&page_size=10

{
    "code": 0,
    "message": "",
    "data": {
        "rows": [
            {
                "id": 1,
                "plugins": {
                    "limit-count": {
                        "time_window": 60,
                        "policy": "local",
                        "count": 2,
                        "key": "remote_addr",
                        "rejected_code": 503
                    }
                }
            }
        ]
    }
}

moonming · 2020-12-14T01:53:11Z

There is a more obvious problem in this design:
The plugin menu bar on the left is not just for global plugins. It can also become a universal plug-in object like service and upstream. For example, a limit count plugin and configuration can be referenced by multiple routes.

The global plug-in is just an attribute of the plug-in, and it is not worth a separate menu.

juzhiyuan · 2020-12-14T03:21:44Z

after discussion with @membphis @moonming @nic-chen, we have reached an agreement in the general direction, I will update the proposal today:

UE
features in the future

juzhiyuan · 2020-12-14T10:35:11Z

Hello, I just updated this proposal, kindly review when you are free 😊

cc @nic-chen @liuxiran @membphis @moonming

sampy2518 · 2024-01-25T18:38:38Z

I have a peculiar situation in my project where I am trying to replace my existing old Proxy code with APISIX. my current proxy backtrack the versions apis and services in a different way. for example.
API Versions available : V1, V2, V3

Routes should be created in below format
V1
API1
Service1
Service2
API2
Service3
Service4
API3
Service5

V2
API2
Service4
API4
Service6
V3
API2
Service4
API5
Service7

API routing, fallback and backtracking rules to follow
case 1:
APP A : current Version used V2. All any API from the frontend will be called with V2

Invoke V2/API1/Service1/ will be redirected to V1/API1/Service1, As it is not present in current version V2, so it will backtrack or fallback to previous version which is V1 and search for the Service1 in API1.

Invoke V2/API1/Service2/ will be redirected to V1/API1/Service2, As it is not present in current version V2, so it will backtrack or fallback to previous version which is V1 and search for the Service2 in API1.

Invoke V2/API2/Service3/ will be redirected to V1/API2/Service3, As it is not present in current version V2, so it will backtrack or fallback to previous version which is V1 and search for the Service3 in API2.

Invoke V2/API2/Service4/ will be redirected to V2/API2/Service4, As it is present in V2

Invoke V2/API3/Service5/ will be redirected to V1/API3/Service5, As it is not present in current version V2, so it will backtrack or fallback to previous version which is V1 and search for the Service5 in API3.

Invoke V2/API4/Service6/ will be redirected to V2/API4/Service6, As it is present in V2

case 2:
APP b : current Version used V3. All any API from the frontend will be called with V3

Invoke V3/API1/Service1/ will be redirected to V1/API1/Service1, As it is not present in current version V3, so it will backtrack or fallback to previous version which is V1 and search for the Service1 in API1.

Invoke V3/API1/Service2/ will be redirected to V1/API1/Service2, As it is not present in current version V3, so it will backtrack or fallback to previous version which is V1 and search for the Service2 in API1.

Invoke V3/API2/Service3/ will be redirected to V1/API2/Service3, As it is not present in current version V3, so it will backtrack or fallback to previous version which is V1 and search for the Service3 in API2.

Invoke V3/API2/Service4/ will be redirected to V3/API2/Service4, As it is present in V3

Invoke V3/API3/Service5/ will be redirected to V1/API3/Service5, As it is not present in current version V3, so it will backtrack or fallback to previous version which is V1 and search for the Service5 in API3.

Invoke V3/API4/Service6/ will be redirected to V2/API4/Service6, As it is not present in current version V3, so it will backtrack or fallback to previous version which is V2 and search for the Service6 in API4.

Invoke V3/API4/Service7/ will be redirected to V3/API5/Service7, As it is present in V3

I would like to ask how can i define a customer global plugin which is work when for any incoming request from client and rewrite the URL as per above rule.

juzhiyuan added proposal plugin labels Nov 18, 2020

juzhiyuan added this to the 2.1 milestone Nov 18, 2020

juzhiyuan self-assigned this Nov 18, 2020

juzhiyuan added the frontend label Nov 24, 2020

juzhiyuan mentioned this issue Dec 9, 2020

Dashboard function does not seem to be perfect. #995

Closed

membphis removed this from the 2.2 milestone Dec 11, 2020

juzhiyuan added this to the 2.3 milestone Dec 11, 2020

juzhiyuan added wait for update 1. Solution 2. Due date 3. Assignees if needed and removed wait for update 1. Solution 2. Due date 3. Assignees if needed labels Dec 12, 2020

juzhiyuan changed the title ~~[DRAFT] Support global plugin~~ Support global plugin Dec 13, 2020

This comment has been minimized.

Sign in to view

nic-chen mentioned this issue Dec 14, 2020

feat: support global rule in Manager API #1042

Closed

juzhiyuan assigned LiteSun and unassigned juzhiyuan Dec 18, 2020

This was referenced Dec 25, 2020

feat(FE): add global plugin #1106

Merged

support unit test for ajv #1070

Closed

juzhiyuan closed this as completed in #1106 Dec 30, 2020

nic-chen mentioned this issue Jan 5, 2021

bug(global_rule): check if the returned global_rule list data is as expected #1208

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support global plugin #820

Support global plugin #820

juzhiyuan commented Nov 18, 2020 •

edited

Loading

moonming commented Nov 18, 2020

juzhiyuan commented Nov 18, 2020

moonming commented Dec 11, 2020

membphis commented Dec 12, 2020

juzhiyuan commented Dec 12, 2020

juzhiyuan commented Dec 13, 2020

membphis commented Dec 13, 2020

membphis commented Dec 13, 2020

juzhiyuan commented Dec 13, 2020 •

edited

Loading

nic-chen commented Dec 14, 2020

This comment has been minimized.

moonming commented Dec 14, 2020

juzhiyuan commented Dec 14, 2020

juzhiyuan commented Dec 14, 2020

sampy2518 commented Jan 25, 2024

Support global plugin #820

Support global plugin #820

Comments

juzhiyuan commented Nov 18, 2020 • edited Loading

Background

Solution

Frontend

Backend

Reference

moonming commented Nov 18, 2020

juzhiyuan commented Nov 18, 2020

moonming commented Dec 11, 2020

membphis commented Dec 12, 2020

juzhiyuan commented Dec 12, 2020

juzhiyuan commented Dec 13, 2020

membphis commented Dec 13, 2020

membphis commented Dec 13, 2020

juzhiyuan commented Dec 13, 2020 • edited Loading

nic-chen commented Dec 14, 2020

This comment has been minimized.

moonming commented Dec 14, 2020

juzhiyuan commented Dec 14, 2020

juzhiyuan commented Dec 14, 2020

sampy2518 commented Jan 25, 2024

juzhiyuan commented Nov 18, 2020 •

edited

Loading

juzhiyuan commented Dec 13, 2020 •

edited

Loading