You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@apisix.apache.org by "Ajay-singh1 (via GitHub)" <gi...@apache.org> on 2023/03/06 11:29:14 UTC
[GitHub] [apisix] Ajay-singh1 opened a new pull request, #9017: docs: architecture-design-fix
Ajay-singh1 opened a new pull request, #9017:
URL: https://github.com/apache/apisix/pull/9017
### Description
<!-- Please include a summary of the change and which issue is fixed. -->
Updated The Documentation
<!-- Please also include relevant motivation and context. -->
Better Understanding of the Components
Fixes #7336
### Checklist
- [ ] I have explained the need for this PR and the problem it solves
- [ ] I have explained the changes or the new features added to this PR
- [ ] I have added tests corresponding to this change
- [ ] I have updated the documentation to reflect this change
- [ ] I have verified that this change is backward compatible (If not, please discuss on the [APISIX mailing list](https://github.com/apache/apisix/tree/master#community) first)
<!--
Note
1. Mark the PR as draft until it's ready to be reviewed.
2. Always add/update tests for any changes unless you have a good reason.
3. Always update the documentation to reflect the changes made in the PR.
4. Make a new commit to resolve conversations instead of `push -f`.
5. To resolve merge conflicts, merge master instead of rebasing.
6. Use "request review" to notify the reviewer after making changes.
7. Only a reviewer can mark a conversation as resolved.
-->
--
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: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs: update Architecture doc [apisix]
Posted by "Ajay-singh1 (via GitHub)" <gi...@apache.org>.
Ajay-singh1 commented on PR #9017:
URL: https://github.com/apache/apisix/pull/9017#issuecomment-1771960696
@kayx23 Can you work on this issue I don't quite understand the working of the API Gateway
--
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: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] Neilblaze commented on pull request #9017: docs: architecture-design-fix
Posted by "Neilblaze (via GitHub)" <gi...@apache.org>.
Neilblaze commented on PR #9017:
URL: https://github.com/apache/apisix/pull/9017#issuecomment-1458466181
Too many duplicate commits. Squash them into one.
--
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: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs: update Architecture doc [apisix]
Posted by "kayx23 (via GitHub)" <gi...@apache.org>.
kayx23 commented on PR #9017:
URL: https://github.com/apache/apisix/pull/9017#issuecomment-1772128145
If you don't understand what you're writing about / generating then how's the content going to help others? The content don't really correspond to the diagram that well and I suggest we just close this PR. cc @monkeyDluffy6017
--
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: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] Ajay-singh1 commented on pull request #9017: docs: architecture-design-fix
Posted by "Ajay-singh1 (via GitHub)" <gi...@apache.org>.
Ajay-singh1 commented on PR #9017:
URL: https://github.com/apache/apisix/pull/9017#issuecomment-1458081312
@juzhiyuan thoughts on this?
--
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: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] Ajay-singh1 commented on pull request #9017: docs: architecture-design-fix
Posted by "Ajay-singh1 (via GitHub)" <gi...@apache.org>.
Ajay-singh1 commented on PR #9017:
URL: https://github.com/apache/apisix/pull/9017#issuecomment-1459489770
@Neilblaze Do you want to work on this issue?
--
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: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] Ajay-singh1 commented on pull request #9017: docs: architecture-design-fix
Posted by "Ajay-singh1 (via GitHub)" <gi...@apache.org>.
Ajay-singh1 commented on PR #9017:
URL: https://github.com/apache/apisix/pull/9017#issuecomment-1586517150
@Neilblaze You can work on this issue.:)
--
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: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] shreemaan-abhishek commented on a diff in pull request #9017: docs: architecture-design-fix
Posted by "shreemaan-abhishek (via GitHub)" <gi...@apache.org>.
shreemaan-abhishek commented on code in PR #9017:
URL: https://github.com/apache/apisix/pull/9017#discussion_r1342254824
##########
docs/en/latest/architecture-design/apisix.md:
##########
@@ -38,14 +38,60 @@ The APISIX core handles the important functions like matching Routes, load balan
APISIX also has a set of [built-in Plugins](https://apisix.apache.org/docs/apisix/plugins/batch-requests) that adds features like authentication, security, observability, etc. They are written in Lua.
+## Here is an overview of the architecture
+
+1.Nginx: APISIX is built on top of Nginx, an open source web server that is known for its high performance and scalability. Nginx acts as a reverse proxy and is responsible for routing the client requests to the appropriate backend service.
+
+2.Lua: APISIX is implemented in Lua, a lightweight programming language that is easy to learn and highly extensible. Lua is used to write plugins and extensions that can be added to APISIX to add custom functionality.
+
+3.Etcd: APISIX uses etcd, a distributed key-value store, to store its configuration data. The configuration data includes information about the backend services, the routes, and the plugins that are used by APISIX.
+
+4.REST API: APISIX provides a REST API that can be used to configure and manage the gateway. The REST API allows developers to add new routes, plugins, and services, as well as modify the existing configuration.
Review Comment:
Please mention the Admin API and the Control API here.
##########
docs/en/latest/architecture-design/apisix.md:
##########
@@ -38,14 +38,60 @@ The APISIX core handles the important functions like matching Routes, load balan
APISIX also has a set of [built-in Plugins](https://apisix.apache.org/docs/apisix/plugins/batch-requests) that adds features like authentication, security, observability, etc. They are written in Lua.
+## Here is an overview of the architecture
+
+1.Nginx: APISIX is built on top of Nginx, an open source web server that is known for its high performance and scalability. Nginx acts as a reverse proxy and is responsible for routing the client requests to the appropriate backend service.
Review Comment:
It's good to have a space after the period symbol.
--
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: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] Ajay-singh1 commented on pull request #9017: docs: architecture-design-fix
Posted by "Ajay-singh1 (via GitHub)" <gi...@apache.org>.
Ajay-singh1 commented on PR #9017:
URL: https://github.com/apache/apisix/pull/9017#issuecomment-1538409467
@navendu-pottekkat How does this look like?
--
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: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] Ajay-singh1 commented on pull request #9017: docs: architecture-design-fix
Posted by "Ajay-singh1 (via GitHub)" <gi...@apache.org>.
Ajay-singh1 commented on PR #9017:
URL: https://github.com/apache/apisix/pull/9017#issuecomment-1459507923
@Neilblaze I will squash it till the End Of Day.
--
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: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs: update Architecture doc [apisix]
Posted by "monkeyDluffy6017 (via GitHub)" <gi...@apache.org>.
monkeyDluffy6017 commented on PR #9017:
URL: https://github.com/apache/apisix/pull/9017#issuecomment-1772361511
I'm going to close this pr, feel free to reopen it
--
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: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs: update Architecture doc [apisix]
Posted by "monkeyDluffy6017 (via GitHub)" <gi...@apache.org>.
monkeyDluffy6017 closed pull request #9017: docs: update Architecture doc
URL: https://github.com/apache/apisix/pull/9017
--
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: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] Neilblaze commented on pull request #9017: docs: architecture-design-fix
Posted by "Neilblaze (via GitHub)" <gi...@apache.org>.
Neilblaze commented on PR #9017:
URL: https://github.com/apache/apisix/pull/9017#issuecomment-1464892169
@Ajay-singh1 Any update on this?
--
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: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] github-actions[bot] commented on pull request #9017: docs: architecture-design-fix
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #9017:
URL: https://github.com/apache/apisix/pull/9017#issuecomment-1737096257
This pull request has been marked as stale due to 60 days of inactivity. It will be closed in 4 weeks if no further activity occurs. If you think that's incorrect or this pull request should instead be reviewed, please simply write any comment. Even if closed, you can still revive the PR at any time or discuss it on the dev@apisix.apache.org list. Thank you for your contributions.
--
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: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs: architecture-design-fix [apisix]
Posted by "kayx23 (via GitHub)" <gi...@apache.org>.
kayx23 commented on code in PR #9017:
URL: https://github.com/apache/apisix/pull/9017#discussion_r1357612305
##########
docs/en/latest/architecture-design/apisix.md:
##########
@@ -38,14 +38,60 @@ The APISIX core handles the important functions like matching Routes, load balan
APISIX also has a set of [built-in Plugins](https://apisix.apache.org/docs/apisix/plugins/batch-requests) that adds features like authentication, security, observability, etc. They are written in Lua.
+## Here is an overview of the architecture
Review Comment:
Please adjust title and not use full sentence here
##########
docs/en/latest/architecture-design/apisix.md:
##########
@@ -38,14 +38,60 @@ The APISIX core handles the important functions like matching Routes, load balan
APISIX also has a set of [built-in Plugins](https://apisix.apache.org/docs/apisix/plugins/batch-requests) that adds features like authentication, security, observability, etc. They are written in Lua.
+## Here is an overview of the architecture
+
+1.Nginx: APISIX is built on top of Nginx, an open source web server that is known for its high performance and scalability. Nginx acts as a reverse proxy and is responsible for routing the client requests to the appropriate backend service.
+
+2.Lua: APISIX is implemented in Lua, a lightweight programming language that is easy to learn and highly extensible. Lua is used to write plugins and extensions that can be added to APISIX to add custom functionality.
+
+3.Etcd: APISIX uses etcd, a distributed key-value store, to store its configuration data. The configuration data includes information about the backend services, the routes, and the plugins that are used by APISIX.
+
+4.REST API: APISIX provides a REST API that can be used to configure and manage the gateway. The REST API allows developers to add new routes, plugins, and services, as well as modify the existing configuration.
+
+5.Plugin System: APISIX has a plugin system that allows developers to extend the functionality of the gateway. APISIX provides a number of plugins out of the box, such as rate limiting, authentication, and SSL termination, but developers can also create their own custom plugins.
+
+6.Load Balancing: APISIX provides load balancing capabilities out of the box. It can distribute traffic evenly across multiple backend services, improving reliability and scalability.
+
+7.Caching: APISIX has a built-in caching system that can be used to cache responses from backend services. This can improve performance and reduce the load on the backend services.
+
+8.Service Discovery: APISIX can use service discovery systems, such as Consul or ZooKeeper, to automatically discover backend services and configure routing accordingly.
+
+9.Metrics: APISIX provides metrics and monitoring capabilities that can be used to monitor the performance of the gateway and the backend services.
+
## Request handling process
The diagram below shows how APISIX handles an incoming request and applies corresponding Plugins:
+When a request arrives at APISIX, the following steps take place:
Review Comment:
```suggestion
When a request arrives at APISIX, the following steps take place:
```
##########
docs/en/latest/architecture-design/apisix.md:
##########
@@ -38,14 +38,60 @@ The APISIX core handles the important functions like matching Routes, load balan
APISIX also has a set of [built-in Plugins](https://apisix.apache.org/docs/apisix/plugins/batch-requests) that adds features like authentication, security, observability, etc. They are written in Lua.
+## Here is an overview of the architecture
+
+1.Nginx: APISIX is built on top of Nginx, an open source web server that is known for its high performance and scalability. Nginx acts as a reverse proxy and is responsible for routing the client requests to the appropriate backend service.
+
+2.Lua: APISIX is implemented in Lua, a lightweight programming language that is easy to learn and highly extensible. Lua is used to write plugins and extensions that can be added to APISIX to add custom functionality.
+
+3.Etcd: APISIX uses etcd, a distributed key-value store, to store its configuration data. The configuration data includes information about the backend services, the routes, and the plugins that are used by APISIX.
+
+4.REST API: APISIX provides a REST API that can be used to configure and manage the gateway. The REST API allows developers to add new routes, plugins, and services, as well as modify the existing configuration.
+
+5.Plugin System: APISIX has a plugin system that allows developers to extend the functionality of the gateway. APISIX provides a number of plugins out of the box, such as rate limiting, authentication, and SSL termination, but developers can also create their own custom plugins.
+
+6.Load Balancing: APISIX provides load balancing capabilities out of the box. It can distribute traffic evenly across multiple backend services, improving reliability and scalability.
+
+7.Caching: APISIX has a built-in caching system that can be used to cache responses from backend services. This can improve performance and reduce the load on the backend services.
Review Comment:
What is this built-in caching system referring to? With the `proxy-cache` plugin?
##########
docs/en/latest/architecture-design/apisix.md:
##########
@@ -38,14 +38,60 @@ The APISIX core handles the important functions like matching Routes, load balan
APISIX also has a set of [built-in Plugins](https://apisix.apache.org/docs/apisix/plugins/batch-requests) that adds features like authentication, security, observability, etc. They are written in Lua.
+## Here is an overview of the architecture
+
+1.Nginx: APISIX is built on top of Nginx, an open source web server that is known for its high performance and scalability. Nginx acts as a reverse proxy and is responsible for routing the client requests to the appropriate backend service.
+
+2.Lua: APISIX is implemented in Lua, a lightweight programming language that is easy to learn and highly extensible. Lua is used to write plugins and extensions that can be added to APISIX to add custom functionality.
+
+3.Etcd: APISIX uses etcd, a distributed key-value store, to store its configuration data. The configuration data includes information about the backend services, the routes, and the plugins that are used by APISIX.
+
+4.REST API: APISIX provides a REST API that can be used to configure and manage the gateway. The REST API allows developers to add new routes, plugins, and services, as well as modify the existing configuration.
+
+5.Plugin System: APISIX has a plugin system that allows developers to extend the functionality of the gateway. APISIX provides a number of plugins out of the box, such as rate limiting, authentication, and SSL termination, but developers can also create their own custom plugins.
+
+6.Load Balancing: APISIX provides load balancing capabilities out of the box. It can distribute traffic evenly across multiple backend services, improving reliability and scalability.
+
+7.Caching: APISIX has a built-in caching system that can be used to cache responses from backend services. This can improve performance and reduce the load on the backend services.
+
+8.Service Discovery: APISIX can use service discovery systems, such as Consul or ZooKeeper, to automatically discover backend services and configure routing accordingly.
+
+9.Metrics: APISIX provides metrics and monitoring capabilities that can be used to monitor the performance of the gateway and the backend services.
+
## Request handling process
The diagram below shows how APISIX handles an incoming request and applies corresponding Plugins:
+When a request arrives at APISIX, the following steps take place:
+
+APISIX receives the request: When a client sends a request to the API, APISIX receives it and processes it. The request could be an HTTP request or any other protocol that APISIX supports.
+
+Route matching: APISIX checks the incoming request against the configured routes to find a match. Each route is defined by a combination of a URI path, an HTTP method, and any additional criteria, such as headers or query parameters. If a match is found, APISIX proceeds to the next step.
+
+Plugin execution: Once APISIX has identified the correct route, it executes the plugins associated with that route. Plugins can perform a variety of actions, such as authentication, rate limiting, request/response transformation, and more. The plugins are executed in the order specified in the configuration file.
+
+Proxying: After all the plugins have been executed, APISIX proxies the request to the upstream service. The upstream service could be a web application, a microservice, or any other endpoint that can handle the request.
+
+Response processing: When the upstream service returns a response, APISIX processes it according to the plugins associated with the route. Plugins can modify the response, add headers, or perform other actions.
+
+Response delivery: Finally, APISIX delivers the response to the client. If any plugins have modified the response, the modified version is returned to the client.
## Plugin hierarchy
The chart below shows the order in which different types of Plugin are applied to a request:
+
+In APISIX, the order in which plugins are applied to a request is determined by the order in which they are specified in the configuration file. There are several different types of plugins that can be applied to a request, and they can be categorized into three main groups based on when they are executed:
Review Comment:
The sentence above `The chart below shows the order in which different types of Plugin are applied to a request:` is actually not accurate for what the diagram is about, so it may have misled you. The diagram is more for the plugin internal.
##########
docs/en/latest/architecture-design/apisix.md:
##########
@@ -38,14 +38,60 @@ The APISIX core handles the important functions like matching Routes, load balan
APISIX also has a set of [built-in Plugins](https://apisix.apache.org/docs/apisix/plugins/batch-requests) that adds features like authentication, security, observability, etc. They are written in Lua.
+## Here is an overview of the architecture
+
+1.Nginx: APISIX is built on top of Nginx, an open source web server that is known for its high performance and scalability. Nginx acts as a reverse proxy and is responsible for routing the client requests to the appropriate backend service.
+
+2.Lua: APISIX is implemented in Lua, a lightweight programming language that is easy to learn and highly extensible. Lua is used to write plugins and extensions that can be added to APISIX to add custom functionality.
Review Comment:
LuaJIT
##########
docs/en/latest/architecture-design/apisix.md:
##########
@@ -38,14 +38,60 @@ The APISIX core handles the important functions like matching Routes, load balan
APISIX also has a set of [built-in Plugins](https://apisix.apache.org/docs/apisix/plugins/batch-requests) that adds features like authentication, security, observability, etc. They are written in Lua.
+## Here is an overview of the architecture
+
+1.Nginx: APISIX is built on top of Nginx, an open source web server that is known for its high performance and scalability. Nginx acts as a reverse proxy and is responsible for routing the client requests to the appropriate backend service.
+
+2.Lua: APISIX is implemented in Lua, a lightweight programming language that is easy to learn and highly extensible. Lua is used to write plugins and extensions that can be added to APISIX to add custom functionality.
+
+3.Etcd: APISIX uses etcd, a distributed key-value store, to store its configuration data. The configuration data includes information about the backend services, the routes, and the plugins that are used by APISIX.
+
+4.REST API: APISIX provides a REST API that can be used to configure and manage the gateway. The REST API allows developers to add new routes, plugins, and services, as well as modify the existing configuration.
+
+5.Plugin System: APISIX has a plugin system that allows developers to extend the functionality of the gateway. APISIX provides a number of plugins out of the box, such as rate limiting, authentication, and SSL termination, but developers can also create their own custom plugins.
+
+6.Load Balancing: APISIX provides load balancing capabilities out of the box. It can distribute traffic evenly across multiple backend services, improving reliability and scalability.
+
+7.Caching: APISIX has a built-in caching system that can be used to cache responses from backend services. This can improve performance and reduce the load on the backend services.
+
+8.Service Discovery: APISIX can use service discovery systems, such as Consul or ZooKeeper, to automatically discover backend services and configure routing accordingly.
+
+9.Metrics: APISIX provides metrics and monitoring capabilities that can be used to monitor the performance of the gateway and the backend services.
+
## Request handling process
The diagram below shows how APISIX handles an incoming request and applies corresponding Plugins:
+When a request arrives at APISIX, the following steps take place:
+
+APISIX receives the request: When a client sends a request to the API, APISIX receives it and processes it. The request could be an HTTP request or any other protocol that APISIX supports.
+
+Route matching: APISIX checks the incoming request against the configured routes to find a match. Each route is defined by a combination of a URI path, an HTTP method, and any additional criteria, such as headers or query parameters. If a match is found, APISIX proceeds to the next step.
+
+Plugin execution: Once APISIX has identified the correct route, it executes the plugins associated with that route. Plugins can perform a variety of actions, such as authentication, rate limiting, request/response transformation, and more. The plugins are executed in the order specified in the configuration file.
+
+Proxying: After all the plugins have been executed, APISIX proxies the request to the upstream service. The upstream service could be a web application, a microservice, or any other endpoint that can handle the request.
+
+Response processing: When the upstream service returns a response, APISIX processes it according to the plugins associated with the route. Plugins can modify the response, add headers, or perform other actions.
+
+Response delivery: Finally, APISIX delivers the response to the client. If any plugins have modified the response, the modified version is returned to the client.
## Plugin hierarchy
The chart below shows the order in which different types of Plugin are applied to a request:
+
+In APISIX, the order in which plugins are applied to a request is determined by the order in which they are specified in the configuration file. There are several different types of plugins that can be applied to a request, and they can be categorized into three main groups based on when they are executed:
Review Comment:
Information here does not correspond with the digram above and is more geared towards plugin execution order. Plugin execution orders has been covered here: https://apisix.apache.org/docs/apisix/terminology/plugin/#plugins-merging-precedence
Please update.
--
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: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org