apisix
apisix copied to clipboard
docs: improve the Deployment Role document
Current State
Resource
- Document Link: https://apisix.apache.org/docs/apisix/next/architecture-design/deployment-role/
Improvements
- SEO: Missing keywords
Deployment Role: What's aRole? Should it beoptionsormodes?- This document contains a table that explains what's
traditional,decoupled,andstandalone,but thedescriptionfield misses details. - For the
traditional's description, it'sDP + CP are deployed together by default. People need to disable enable_admin manually. How about updating it toXXXX. This mode enables "enable_admin" by default? - This document mentions
Control Plane. Some developers will get confused because of the relationship betweenDashboardandAdminAPI. - In the
Traditionalsection, the diagram showsAdmin APIis listening on the9180port, but our document uses:9080/apisix/admin/XXXby default. Should we use the same port? Or should we explain why we use a different port? - In the
standalonesection, we should also link readers to theStandalonedocument. - How about adding more `reasons/benefits for each mode? The readers will know why and which way is suitable for their case.
- It's an English version only currently, need to translate to Chinese as well. cc @hf400159
Desired State
See Current State.
- We can test in different modes so that users can intuitively feel the difference between the three modes.
- It needs to be confirmed that if this function is released in the next version, it is necessary to explain to the user whether it is possible to directly upgrade the lower version of APISIX to the new version.
- For
4, the description is still not clear. Should be: xxx, if you want to achieve independent deployment of CP and DP, you need to disableenable_admin. - We need a how-to document that tells users how to deploy these three methods, rather than just giving examples of
configuration files.
Hi - this issue seems outdated. Please re-evaluate and see if this can be closed. Thanks.