feat: Route group feature

[LiteSun]

why

In order to allow users to filter out routes with a specified group from a large number of routes, I propose to add the route groups feature.

how

front-end

In order to finish this feature. There are 3 steps need to do.

• Adding group options to the edit or create route page.
  

• Route group list page
  

• Create or Edit route group page
  

back-end

Create or update API to match front-end requirements.

• Create route and update route API need to update.
• Route Group List API.
• Create and update route group API.

APISIX

Need to discuss how to implement route group requirements.

Free to comment here.

cc @juzhiyuan @liuxiran @gxthrj @nic-chen @membphis

[juzhiyuan]

@liuxiran @membphis Just to make sure, if there will have 1-to-n requirement? (1 route with multiple group)

[liuxiran]

@liuxiran @membphis Just to make sure, if there will have 1-to-n requirement? (1 route with multiple group)

I think one route only belongs to one group

[juzhiyuan]

ok then it looks good to me 👏

[gxthrj]

I propose to use the label selection method to achieve group capabilities, Route/upstream and service already have label attributes, so we can avoid adding the groupId field on the route.

[juzhiyuan]

But a label is more like to describe what it is, right? 🤔

[membphis]

I would like the way of label, which is more flexible than group.

• one route allows binding multiple labels

[juzhiyuan]

There is a difference here, we should continue discussing this proposal.

[nic-chen]

If used for management, I prefer to use a separate group id. If it's just for group display, label is a better choice.

[juzhiyuan]

The label would be closer to the description but not logic IMHO.

[liuxiran]

I propose to use the label selection method to achieve group capabilities, Route/upstream and service already have label attributes, so we can avoid adding the groupId field on the route.

Agree +1.

Refer to the previous discussion #431 (comment), and prs: apache/apisix#2279 apache/apisix#2345 , We've already introduced labels in apisix, and labels were originally preparing for group.

Basicly, we need to add group schema to APISIX, and as @gxthrj mentioned, we also need a labelsSelectors mate to do it with labels[1]

The Route data structure would be as follows, (group is not a required attr for a route). we use labels to describe which group is the route in.

{
  "name": "route1",
   ...,
  "labels": {
    ...,
    "group": "group1"
  }
}

{
  "name": "route2",
   ...,
  "labels": {
    "group": "group1"
  }
}

{
  "name": "route3",
   ...,
}

Group data structure would be as follows: (we could also add other selectors for a group).

we use labelSelectors to describe that resources with the selector belong to the group.

{
  "name": "group1",
  "desc": "xxx",
  "labelSelectors": {
    "group": "group1",
  }
}

{
  "name": "group2",
   ...,
  "labelSelectors": {
    "group": "group2",
    "version": "v2",
     ...
  }
}

Reference:
[1]: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

[juzhiyuan]

@membphis would you like to share your ideas?