Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Plugin template configuration #1512

Closed
LiteSun opened this issue Feb 25, 2021 · 14 comments
Closed

Plugin template configuration #1512

LiteSun opened this issue Feb 25, 2021 · 14 comments

Comments

@LiteSun
Copy link
Member

LiteSun commented Feb 25, 2021

Background and purpose

To allow users to configure plugin templates in advance and bind the corresponding plugin templates when creating routes to achieve the fast configuration of routing plugin.

Design options

Front-end

  • Plugin template configuration portal:
    Add the Plugin Template Config button to the top of the route list, and enter the Plugin Template list page after clicking the button.

image

  • New plugin template configuration list page
    The list page is consistent with the style of other list pages and contains CRUD.

image

  • Add a new plugin template configuration step page
    After clicking Create or Edit in the plugin template configuration List page, you will enter the plugin template configuration Steps page.
    The steps page is divided into two pages:

    • Basic configuration information (e.g., desc) and plugin template configuration, which interacts with the Plugin Marketplace page.
      image
    • Preview page
  • Update the Create Route configuration route page to include the plugin template selector, and render the corresponding plugin information after selecting the corresponding plugin template.
    image

    Policy is consistent with apisix:

    • If the route is already configured with plugins, then the plugin configuration inside the Plugin config will be merged in.
    • The same plugins will overwrite the original plugins plugins

Back-end

Required interfaces:

  • Plugin configuration list
  • Plugin list search
  • Create plugin configuration
  • Update Plugin Configuration
  • Delete plugin configuration
  • May need to update Create and update routing interface, need @nic-chen to confirm
@moonming
Copy link
Member

will pugin support tag?
In this way, the management and grouping of plug-ins can be completed, which is more flexible

@LiteSun
Copy link
Member Author

LiteSun commented Feb 25, 2021

will pugin support tag?
In this way, the management and grouping of plug-ins can be completed, which is more flexible

Good catch!
Does apisix plugin config support tag? Need @spacewander to confirm, if apisix supports it, I will update the tag to the solution.

@nic-chen
Copy link
Member

May need to update Create and update routing interface, need @nic-chen to confirm

need to update entity and schema for route.

@LiteSun
Copy link
Member Author

LiteSun commented Mar 1, 2021

will pugin support tag?

In this way, the management and grouping of plug-ins can be completed, which is more flexible

Good catch!

Does apisix plugin config support tag? Need @spacewander to confirm, if apisix supports it, I will update the tag to the solution.

Ping @spacewander

@LiteSun
Copy link
Member Author

LiteSun commented Mar 1, 2021

Apisix has submitted pr to complete this requirement: apache/apisix#3703

The front-end page was changed as follows to complete the requirement.

  1. new label search on the plugin template list page, similar to the route list label search.
    image

  2. add label field in the basic information configuration. similar to the creation of the route when the configuration label.
    image

@spacewander
Copy link
Member

spacewander commented Mar 1, 2021

will pugin support tag?

In this way, the management and grouping of plug-ins can be completed, which is more flexible

Good catch!
Does apisix plugin config support tag? Need @spacewander to confirm, if apisix supports it, I will update the tag to the solution.

Ping @spacewander

Added in apache/apisix#3703. Please have a look.

@liuxiran
Copy link
Contributor

liuxiran commented Mar 1, 2021

I am a little confused about how to use the plugin template. Do we need to bind the template to the target route manually? @LiteSun

@LiteSun
Copy link
Member Author

LiteSun commented Mar 2, 2021

I am a little confused about how to use the plugin template. Do we need to bind the template to the target route manually? @LiteSun

Yes, just like binding upstream in a route.

@liuxiran
Copy link
Contributor

liuxiran commented Mar 2, 2021

I am a little confused about how to use the plugin template. Do we need to bind the template to the target route manually? @LiteSun

Yes, just like binding upstream in a route.

Got it, and does the plugin template can also be bind to service?

@LiteSun
Copy link
Member Author

LiteSun commented Mar 2, 2021

I am a little confused about how to use the plugin template. Do we need to bind the template to the target route manually? @LiteSun

Yes, just like binding upstream in a route.

Got it, and does the plugin template can also be bind to service?

Binding service depends on apisix, which does not currently support this feature

@membphis
Copy link
Member

@LiteSun can we close this issue now?

@juzhiyuan
Copy link
Member

@LiteSun Do remember to use close/resolve/fix #xxx to link issue in PR.

@LiteSun
Copy link
Member Author

LiteSun commented Mar 15, 2021

closed by #1540

@LiteSun
Copy link
Member Author

LiteSun commented Mar 15, 2021

@LiteSun can we close this issue now?

Sure.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

7 participants