You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@apisix.apache.org by GitBox <gi...@apache.org> on 2022/03/23 10:40:18 UTC
[GitHub] [apisix] navendu-pottekkat opened a new pull request #6695: docs: update FAQ docs
navendu-pottekkat opened a new pull request #6695:
URL: https://github.com/apache/apisix/pull/6695
Signed-off-by: Navendu Pottekkat <na...@gmail.com>
### Description
This PR updates the FAQ section to be more readable and consistent.
Fixes #6594
--
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] bisakhmondal commented on a change in pull request #6695: docs: update FAQ docs
Posted by GitBox <gi...@apache.org>.
bisakhmondal commented on a change in pull request #6695:
URL: https://github.com/apache/apisix/pull/6695#discussion_r833936863
##########
File path: docs/en/latest/FAQ.md
##########
@@ -21,74 +21,80 @@ title: FAQ
#
-->
-## Why a new API gateway?
+## Why do I need a new API gateway?
-There are new requirements for API gateways in the field of microservices: higher flexibility, higher performance requirements, and cloud native.
+As organizations move towards cloud native microservices, there is a need for an API gateway that is performant, flexible, secure and scalable.
-## What are the differences between Apache APISIX and other API gateways?
+APISIX outperforms other API gateways in these metrics while delivering functions like dynamic routing, a plugin mechanism, a low code dashboard and more.
-Apache APISIX is based on etcd to save and synchronize configuration, not relational databases such as Postgres or MySQL.
+## How does Apache APISIX differ from other API gateways?
-This not only eliminates polling, makes the code more concise, but also makes configuration synchronization more real-time. At the same time, there will be no single point in the system, which is more usable.
+Apache APISIX differs in the following ways:
-In addition, Apache APISIX has dynamic routing and hot loading of plug-ins, which is especially suitable for API management under micro-service system.
+- It uses etcd to save and synchronize configurations rather than relational databases like PostgreSQL or MySQL. This eliminates the need for polling, synchronizes the configuration in real-time, makes the code concise and avoids a single point of failure.
+- Supports dynamic routing.
Review comment:
`This eliminates the need for polling` - Let's rephrase this. Polling is one of many options in RDBs but they do support event-based push. For eg., Postgres has 1. logical replication and 2. PG_NOTIFY to support real-time event notification. But they are pretty hard to scale compared to etcd - that might be the issue (at least that's what I think).
--
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] nic-chen commented on a change in pull request #6695: docs: update FAQ docs
Posted by GitBox <gi...@apache.org>.
nic-chen commented on a change in pull request #6695:
URL: https://github.com/apache/apisix/pull/6695#discussion_r833267562
##########
File path: docs/en/latest/FAQ.md
##########
@@ -21,74 +21,80 @@ title: FAQ
#
-->
-## Why a new API gateway?
+## Why do I need a new API gateway?
-There are new requirements for API gateways in the field of microservices: higher flexibility, higher performance requirements, and cloud native.
+As organizations move towards cloud native microservices, there is a need for an API gateway that is performant, flexible, secure and scalable.
-## What are the differences between Apache APISIX and other API gateways?
+APISIX outperforms other API gateways in these metrics while delivering functions like dynamic routing, a plugin mechanism, a low code dashboard and more.
Review comment:
all configuration is dynamic, not just route.
--
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] yzeng25 commented on a change in pull request #6695: docs: update FAQ docs
Posted by GitBox <gi...@apache.org>.
yzeng25 commented on a change in pull request #6695:
URL: https://github.com/apache/apisix/pull/6695#discussion_r833883688
##########
File path: docs/en/latest/FAQ.md
##########
@@ -21,74 +21,80 @@ title: FAQ
#
-->
-## Why a new API gateway?
+## Why do I need a new API gateway?
-There are new requirements for API gateways in the field of microservices: higher flexibility, higher performance requirements, and cloud native.
+As organizations move towards cloud native microservices, there is a need for an API gateway that is performant, flexible, secure and scalable.
-## What are the differences between Apache APISIX and other API gateways?
+APISIX outperforms other API gateways in these metrics while delivering functions like dynamic routing, a plugin mechanism, a low code dashboard and more.
-Apache APISIX is based on etcd to save and synchronize configuration, not relational databases such as Postgres or MySQL.
+## How does Apache APISIX differ from other API gateways?
-This not only eliminates polling, makes the code more concise, but also makes configuration synchronization more real-time. At the same time, there will be no single point in the system, which is more usable.
+Apache APISIX differs in the following ways:
-In addition, Apache APISIX has dynamic routing and hot loading of plug-ins, which is especially suitable for API management under micro-service system.
+- It uses etcd to save and synchronize configurations rather than relational databases like PostgreSQL or MySQL. This eliminates the need for polling, synchronizes the configuration in real-time, makes the code concise and avoids a single point of failure.
+- Supports dynamic routing.
+- Supports [hot loading of Plugins](/docs/apisix/plugins/#hot-reload).
-## What's the performance of Apache APISIX?
+## What is the performance impact of using Apache APISIX?
-One of the goals of Apache APISIX design and development is the highest performance in the industry. Specific test data can be found here：[benchmark](benchmark.md)
+Apache APISIX delivers the best performance among other API gateways with a single-core QPS of 23,000 with an average delay of 0.6 ms.
Review comment:
Could you double check on the QPS and the latency stats? I remember the stats are 18,000 QPS and 0.2 ms latency on the [GitHub intro page](https://github.com/apache/apisix).
##########
File path: docs/en/latest/FAQ.md
##########
@@ -21,74 +21,80 @@ title: FAQ
#
-->
-## Why a new API gateway?
+## Why do I need a new API gateway?
-There are new requirements for API gateways in the field of microservices: higher flexibility, higher performance requirements, and cloud native.
+As organizations move towards cloud native microservices, there is a need for an API gateway that is performant, flexible, secure and scalable.
-## What are the differences between Apache APISIX and other API gateways?
+APISIX outperforms other API gateways in these metrics while delivering functions like dynamic routing, a plugin mechanism, a low code dashboard and more.
-Apache APISIX is based on etcd to save and synchronize configuration, not relational databases such as Postgres or MySQL.
+## How does Apache APISIX differ from other API gateways?
-This not only eliminates polling, makes the code more concise, but also makes configuration synchronization more real-time. At the same time, there will be no single point in the system, which is more usable.
+Apache APISIX differs in the following ways:
-In addition, Apache APISIX has dynamic routing and hot loading of plug-ins, which is especially suitable for API management under micro-service system.
+- It uses etcd to save and synchronize configurations rather than relational databases like PostgreSQL or MySQL. This eliminates the need for polling, synchronizes the configuration in real-time, makes the code concise and avoids a single point of failure.
+- Supports dynamic routing.
+- Supports [hot loading of Plugins](/docs/apisix/plugins/#hot-reload).
-## What's the performance of Apache APISIX?
+## What is the performance impact of using Apache APISIX?
-One of the goals of Apache APISIX design and development is the highest performance in the industry. Specific test data can be found here：[benchmark](benchmark.md)
+Apache APISIX delivers the best performance among other API gateways with a single-core QPS of 23,000 with an average delay of 0.6 ms.
Review comment:
I mean either of them or all of them could be right. But we need to keep stats correct.
##########
File path: docs/en/latest/FAQ.md
##########
@@ -21,74 +21,80 @@ title: FAQ
#
-->
-## Why a new API gateway?
+## Why do I need a new API gateway?
-There are new requirements for API gateways in the field of microservices: higher flexibility, higher performance requirements, and cloud native.
+As organizations move towards cloud native microservices, there is a need for an API gateway that is performant, flexible, secure and scalable.
-## What are the differences between Apache APISIX and other API gateways?
+APISIX outperforms other API gateways in these metrics while delivering functions like dynamic routing, a plugin mechanism, a low code dashboard and more.
-Apache APISIX is based on etcd to save and synchronize configuration, not relational databases such as Postgres or MySQL.
+## How does Apache APISIX differ from other API gateways?
-This not only eliminates polling, makes the code more concise, but also makes configuration synchronization more real-time. At the same time, there will be no single point in the system, which is more usable.
+Apache APISIX differs in the following ways:
-In addition, Apache APISIX has dynamic routing and hot loading of plug-ins, which is especially suitable for API management under micro-service system.
+- It uses etcd to save and synchronize configurations rather than relational databases like PostgreSQL or MySQL. This eliminates the need for polling, synchronizes the configuration in real-time, makes the code concise and avoids a single point of failure.
+- Supports dynamic routing.
+- Supports [hot loading of Plugins](/docs/apisix/plugins/#hot-reload).
-## What's the performance of Apache APISIX?
+## What is the performance impact of using Apache APISIX?
-One of the goals of Apache APISIX design and development is the highest performance in the industry. Specific test data can be found here：[benchmark](benchmark.md)
+Apache APISIX delivers the best performance among other API gateways with a single-core QPS of 23,000 with an average delay of 0.6 ms.
-Apache APISIX is the highest performance API gateway with a single-core QPS of 23,000, with an average delay of only 0.6 milliseconds.
+Specific results of the performance benchmarks can be found [here](benchmark.md).
## Does Apache APISIX have a user interface？
-Yes. Apache APISIX has an experimental feature called [Apache APISIX Dashboard](https://github.com/apache/apisix-dashboard), which is an independent project apart from Apache APISIX. You can deploy Apache APISIX Dashboard to operate Apache APISIX through the user interface.
+Yes. Apache APISIX has an experimental feature called [Apache APISIX Dashboard](https://github.com/apache/apisix-dashboard), which is independent from Apache APISIX. To work with Apache APISIX through a user interface, you can deploy the Apache APISIX Dashboard.
-## Can I write my own plugin?
+## Can I write my on Plugins for Apache APISIX?
Review comment:
```suggestion
## Can I write my own Plugins for Apache APISIX?
```
--
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] navendu-pottekkat commented on pull request #6695: docs: update FAQ docs
Posted by GitBox <gi...@apache.org>.
navendu-pottekkat commented on pull request #6695:
URL: https://github.com/apache/apisix/pull/6695#issuecomment-1076216062
@juzhiyuan @yzeng25 @avinal Could you review this PR?
--
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] navendu-pottekkat commented on pull request #6695: docs: update FAQ docs
Posted by GitBox <gi...@apache.org>.
navendu-pottekkat commented on pull request #6695:
URL: https://github.com/apache/apisix/pull/6695#issuecomment-1078693537
@spacewander @nic-chen @yzeng25 @bisakhmondal @avinal I have made the changes as suggestions.
--
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] nic-chen commented on a change in pull request #6695: docs: update FAQ docs
Posted by GitBox <gi...@apache.org>.
nic-chen commented on a change in pull request #6695:
URL: https://github.com/apache/apisix/pull/6695#discussion_r834133682
##########
File path: docs/en/latest/FAQ.md
##########
@@ -21,74 +21,80 @@ title: FAQ
#
-->
-## Why a new API gateway?
+## Why do I need a new API gateway?
-There are new requirements for API gateways in the field of microservices: higher flexibility, higher performance requirements, and cloud native.
+As organizations move towards cloud native microservices, there is a need for an API gateway that is performant, flexible, secure and scalable.
-## What are the differences between Apache APISIX and other API gateways?
+APISIX outperforms other API gateways in these metrics while delivering functions like dynamic routing, a plugin mechanism, a low code dashboard and more.
Review comment:
> Maybe pick theses headers: [apache/apisix#features](https://github.com/apache/apisix#features)
yes, the `Full Dynamic` section
--
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] navendu-pottekkat commented on a change in pull request #6695: docs: update FAQ docs
Posted by GitBox <gi...@apache.org>.
navendu-pottekkat commented on a change in pull request #6695:
URL: https://github.com/apache/apisix/pull/6695#discussion_r833899023
##########
File path: docs/en/latest/FAQ.md
##########
@@ -21,74 +21,80 @@ title: FAQ
#
-->
-## Why a new API gateway?
+## Why do I need a new API gateway?
-There are new requirements for API gateways in the field of microservices: higher flexibility, higher performance requirements, and cloud native.
+As organizations move towards cloud native microservices, there is a need for an API gateway that is performant, flexible, secure and scalable.
-## What are the differences between Apache APISIX and other API gateways?
+APISIX outperforms other API gateways in these metrics while delivering functions like dynamic routing, a plugin mechanism, a low code dashboard and more.
-Apache APISIX is based on etcd to save and synchronize configuration, not relational databases such as Postgres or MySQL.
+## How does Apache APISIX differ from other API gateways?
-This not only eliminates polling, makes the code more concise, but also makes configuration synchronization more real-time. At the same time, there will be no single point in the system, which is more usable.
+Apache APISIX differs in the following ways:
-In addition, Apache APISIX has dynamic routing and hot loading of plug-ins, which is especially suitable for API management under micro-service system.
+- It uses etcd to save and synchronize configurations rather than relational databases like PostgreSQL or MySQL. This eliminates the need for polling, synchronizes the configuration in real-time, makes the code concise and avoids a single point of failure.
+- Supports dynamic routing.
Review comment:
@spacewander I did not change what was already existing there.
What do you suggest we add here instead?
--
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] spacewander commented on a change in pull request #6695: docs: update FAQ docs
Posted by GitBox <gi...@apache.org>.
spacewander commented on a change in pull request #6695:
URL: https://github.com/apache/apisix/pull/6695#discussion_r833836188
##########
File path: docs/en/latest/FAQ.md
##########
@@ -469,40 +468,47 @@ HTTP/1.1 200 OK
......
```
-The route was created successfully. It means that the modification of `X-API-KEY` takes effect.
+**Note**: By using the default token, you could be exposed to security risks. It is recommended to update it when deploying to a production environment.
Review comment:
```suggestion
**Note**: By using the default token, you could be exposed to security risks. It is required to update it when deploying to a production environment.
```
would that be better?
##########
File path: docs/en/latest/FAQ.md
##########
@@ -21,74 +21,80 @@ title: FAQ
#
-->
-## Why a new API gateway?
+## Why do I need a new API gateway?
-There are new requirements for API gateways in the field of microservices: higher flexibility, higher performance requirements, and cloud native.
+As organizations move towards cloud native microservices, there is a need for an API gateway that is performant, flexible, secure and scalable.
-## What are the differences between Apache APISIX and other API gateways?
+APISIX outperforms other API gateways in these metrics while delivering functions like dynamic routing, a plugin mechanism, a low code dashboard and more.
-Apache APISIX is based on etcd to save and synchronize configuration, not relational databases such as Postgres or MySQL.
+## How does Apache APISIX differ from other API gateways?
-This not only eliminates polling, makes the code more concise, but also makes configuration synchronization more real-time. At the same time, there will be no single point in the system, which is more usable.
+Apache APISIX differs in the following ways:
-In addition, Apache APISIX has dynamic routing and hot loading of plug-ins, which is especially suitable for API management under micro-service system.
+- It uses etcd to save and synchronize configurations rather than relational databases like PostgreSQL or MySQL. This eliminates the need for polling, synchronizes the configuration in real-time, makes the code concise and avoids a single point of failure.
+- Supports dynamic routing.
Review comment:
Almost every gateway supports dynamic routing...
--
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] navendu-pottekkat commented on a change in pull request #6695: docs: update FAQ docs
Posted by GitBox <gi...@apache.org>.
navendu-pottekkat commented on a change in pull request #6695:
URL: https://github.com/apache/apisix/pull/6695#discussion_r833899153
##########
File path: docs/en/latest/FAQ.md
##########
@@ -21,74 +21,80 @@ title: FAQ
#
-->
-## Why a new API gateway?
+## Why do I need a new API gateway?
-There are new requirements for API gateways in the field of microservices: higher flexibility, higher performance requirements, and cloud native.
+As organizations move towards cloud native microservices, there is a need for an API gateway that is performant, flexible, secure and scalable.
-## What are the differences between Apache APISIX and other API gateways?
+APISIX outperforms other API gateways in these metrics while delivering functions like dynamic routing, a plugin mechanism, a low code dashboard and more.
Review comment:
@nic-chen What do you suggest we add instead?
--
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] avinal commented on a change in pull request #6695: docs: update FAQ docs
Posted by GitBox <gi...@apache.org>.
avinal commented on a change in pull request #6695:
URL: https://github.com/apache/apisix/pull/6695#discussion_r834085392
##########
File path: docs/en/latest/FAQ.md
##########
@@ -21,74 +21,80 @@ title: FAQ
#
-->
-## Why a new API gateway?
+## Why do I need a new API gateway?
-There are new requirements for API gateways in the field of microservices: higher flexibility, higher performance requirements, and cloud native.
+As organizations move towards cloud native microservices, there is a need for an API gateway that is performant, flexible, secure and scalable.
-## What are the differences between Apache APISIX and other API gateways?
+APISIX outperforms other API gateways in these metrics while delivering functions like dynamic routing, a plugin mechanism, a low code dashboard and more.
Review comment:
Maybe pick theses headers: https://github.com/apache/apisix#features
--
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] guoqqqi commented on pull request #6695: docs: update FAQ docs
Posted by GitBox <gi...@apache.org>.
guoqqqi commented on pull request #6695:
URL: https://github.com/apache/apisix/pull/6695#issuecomment-1078843921
I will create issues, and find a new contributor to complete 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
[GitHub] [apisix] spacewander merged pull request #6695: docs: update FAQ docs
Posted by GitBox <gi...@apache.org>.
spacewander merged pull request #6695:
URL: https://github.com/apache/apisix/pull/6695
--
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