mirror of
https://gitee.com/iresty/apisix.git
synced 2024-11-30 02:57:49 +08:00
doc: remove all ‘incubator’ in doc (#2014)
This commit is contained in:
jie
GitHub
parent
b450320501
commit
b4890bf607
@ -29,18 +29,18 @@ Most of the contributions that we receive are code contributions, but you can
|
||||
also contribute to the documentation or simply report solid bugs
|
||||
for us to fix.
|
||||
|
||||
For new contributors, please take a look at issues with a tag called [Good first issue](https://github.com/apache/incubator-apisix/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) or [Help wanted](https://github.com/apache/incubator-apisix/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22).
|
||||
For new contributors, please take a look at issues with a tag called [Good first issue](https://github.com/apache/apisix/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) or [Help wanted](https://github.com/apache/apisix/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22).
|
||||
|
||||
## How to report a bug?
|
||||
|
||||
* **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/apache/incubator-apisix/issues).
|
||||
* **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/apache/apisix/issues).
|
||||
|
||||
* If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/apache/incubator-apisix/issues/new). Be sure to include a **title and clear description**, as much relevant information as possible, and a **code sample** or an **executable test case** demonstrating the expected behavior that is not occurring.
|
||||
* If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/apache/apisix/issues/new). Be sure to include a **title and clear description**, as much relevant information as possible, and a **code sample** or an **executable test case** demonstrating the expected behavior that is not occurring.
|
||||
|
||||
|
||||
## How to add a new feature or change an existing one
|
||||
|
||||
_Before making any significant changes, please [open an issue](https://github.com/apache/incubator-apisix/issues)._ Discussing your proposed changes ahead of time will make the contribution process smooth for everyone.
|
||||
_Before making any significant changes, please [open an issue](https://github.com/apache/apisix/issues)._ Discussing your proposed changes ahead of time will make the contribution process smooth for everyone.
|
||||
|
||||
Once we've discussed your changes and you've got your code ready, make sure that tests are passing and open your pull request. Your PR is most likely to be accepted if it:
|
||||
|
||||
@ -53,7 +53,7 @@ Once we've discussed your changes and you've got your code ready, make sure that
|
||||
|
||||
* Linting/Style
|
||||
|
||||
Use a markdown linting tool to lint the content. The following is a [plugin](https://github.com/apache/incubator-apisix/issues/1273)
|
||||
Use a markdown linting tool to lint the content. The following is a [plugin](https://github.com/apache/apisix/issues/1273)
|
||||
used by our community to lint the docs.
|
||||
|
||||
* Active Voice
|
||||
|
||||
2
FAQ.md
2
FAQ.md
@ -33,7 +33,7 @@ In addition, APISIX has dynamic routing and hot loading of plug-ins, which is es
|
||||
|
||||
## What's the performance of APISIX?
|
||||
|
||||
One of the goals of APISIX design and development is the highest performance in the industry. Specific test data can be found here：[benchmark](https://github.com/apache/incubator-apisix/blob/master/doc/benchmark.md)
|
||||
One of the goals of APISIX design and development is the highest performance in the industry. Specific test data can be found here：[benchmark](https://github.com/apache/apisix/blob/master/doc/benchmark.md)
|
||||
|
||||
APISIX is the highest performance API gateway with a single-core QPS of 23,000, with an average delay of only 0.6 milliseconds.
|
||||
|
||||
|
||||
@ -33,7 +33,7 @@ APISIX 基于 etcd 来完成配置的保存和同步，而不是 postgres 或者
|
||||
|
||||
## APISIX 的性能怎么样？
|
||||
|
||||
APISIX 设计和开发的目标之一，就是业界最高的性能。具体测试数据见这里：[benchmark](https://github.com/apache/incubator-apisix/blob/master/doc/benchmark-cn.md)
|
||||
APISIX 设计和开发的目标之一，就是业界最高的性能。具体测试数据见这里：[benchmark](https://github.com/apache/apisix/blob/master/doc/benchmark-cn.md)
|
||||
|
||||
APISIX 是当前性能最好的 API 网关，单核 QPS 达到 2.3 万，平均延时仅有 0.6 毫秒。
|
||||
|
||||
|
||||
16
README.md
16
README.md
@ -20,8 +20,8 @@
|
||||
[Chinese](README_CN.md)
|
||||
## APISIX
|
||||
|
||||
[](https://travis-ci.org/apache/incubator-apisix)
|
||||
[](https://github.com/apache/incubator-apisix/blob/master/LICENSE)
|
||||
[](https://travis-ci.org/apache/apisix)
|
||||
[](https://github.com/apache/apisix/blob/master/LICENSE)
|
||||
|
||||
- **QQ group**: 552030619
|
||||
- Mail list: Mail to dev-subscribe@apisix.apache.org, follow the reply to subscribe the mail list.
|
||||
@ -95,7 +95,7 @@ A/B testing, canary release, blue-green deployment, limit rate, defense against
|
||||
|
||||
- **OPS friendly**
|
||||
- OpenTracing: support [Apache Skywalking](doc/plugins/skywalking.md) and [Zipkin](doc/plugins/zipkin.md)
|
||||
- works with external service discovery：In addition to the built-in etcd, it also supports `Consul` and `Nacos` [DNS discovery mode](https://github.com/apache/incubator-apisix/issues/1731#issuecomment-646392129), and [Eureka](doc/discovery.md)
|
||||
- works with external service discovery：In addition to the built-in etcd, it also supports `Consul` and `Nacos` [DNS discovery mode](https://github.com/apache/apisix/issues/1731#issuecomment-646392129), and [Eureka](doc/discovery.md)
|
||||
- Monitoring And Metrics: [Prometheus](doc/plugins/prometheus.md)
|
||||
- Clustering: APISIX nodes are stateless, creates clustering of the configuration center, please refer to [etcd Clustering Guide](https://github.com/etcd-io/etcd/blob/master/Documentation/op-guide/clustering.md).
|
||||
- High availability: support to configure multiple etcd addresses in the same cluster.
|
||||
@ -149,7 +149,7 @@ There are several ways to install the Apache Release version of APISIX:
|
||||
docker pull apache/apisix
|
||||
```
|
||||
|
||||
The Docker image does not include `etcd`, you can refer to [docker compose example](https://github.com/apache/incubator-apisix-docker/tree/master/example) to start a test cluster.
|
||||
The Docker image does not include `etcd`, you can refer to [docker compose example](https://github.com/apache/apisix-docker/tree/master/example) to start a test cluster.
|
||||
|
||||
3. RPM package（only for CentOS 7）
|
||||
- Installation runtime dependencies: OpenResty and etcd, refer to [install dependencies documentation](doc/install-dependencies.md#centos-7)
|
||||
@ -178,15 +178,15 @@ etcd --enable-v2=true &
|
||||
|
||||
- build from source code
|
||||
```shell
|
||||
git clone git@github.com:apache/incubator-apisix.git
|
||||
cd incubator-apisix
|
||||
git clone git@github.com:apache/apisix.git
|
||||
cd apisix
|
||||
make deps
|
||||
```
|
||||
|
||||
- Docker image
|
||||
```shell
|
||||
git clone https://github.com/apache/incubator-apisix-docker.git
|
||||
cd incubator-apisix-docker
|
||||
git clone https://github.com/apache/apisix-docker.git
|
||||
cd apisix-docker
|
||||
sudo docker build -f alpine-dev/Dockerfile .
|
||||
```
|
||||
|
||||
|
||||
18
README_CN.md
18
README_CN.md
@ -20,8 +20,8 @@
|
||||
[English](README.md)
|
||||
## APISIX
|
||||
|
||||
[](https://travis-ci.org/apache/incubator-apisix)
|
||||
[](https://github.com/apache/incubator-apisix/blob/master/LICENSE)
|
||||
[](https://travis-ci.org/apache/apisix)
|
||||
[](https://github.com/apache/apisix/blob/master/LICENSE)
|
||||
|
||||
- **QQ 交流群**: 552030619
|
||||
- 邮件列表: 发邮件到 dev-subscribe@apisix.apache.org, 然后跟着回复邮件操作即可。
|
||||
@ -94,7 +94,7 @@ A/B 测试、金丝雀发布(灰度发布)、蓝绿部署、限流限速、抵
|
||||
|
||||
- **运维友好**
|
||||
- OpenTracing 可观测性: 支持 [Apache Skywalking](doc/zh-cn/plugins/skywalking.md) 和 [Zipkin](doc/zh-cn/plugins/zipkin.md)。
|
||||
- 对接外部服务发现：除了内置的 etcd 外，还支持 `Consul` 和 `Nacos` 的 [DNS 发现模式](https://github.com/apache/incubator-apisix/issues/1731#issuecomment-646392129)，以及 [Eureka](doc/zh-cn/discovery.md)。
|
||||
- 对接外部服务发现：除了内置的 etcd 外，还支持 `Consul` 和 `Nacos` 的 [DNS 发现模式](https://github.com/apache/apisix/issues/1731#issuecomment-646392129)，以及 [Eureka](doc/zh-cn/discovery.md)。
|
||||
- 监控和指标: [Prometheus](doc/zh-cn/plugins/prometheus.md)
|
||||
- 集群：APISIX 节点是无状态的，创建配置中心集群请参考 [etcd Clustering Guide](https://github.com/etcd-io/etcd/blob/master/Documentation/op-guide/clustering.md)。
|
||||
- 高可用：支持配置同一个集群内的多个 etcd 地址。
|
||||
@ -148,7 +148,7 @@ CentOS 7, Ubuntu 16.04, Ubuntu 18.04, Debian 9, Debian 10, macOS, **ARM64** Ubun
|
||||
docker pull apache/apisix
|
||||
```
|
||||
|
||||
Docker 镜像中并不包含 etcd，你可以参考 [docker compose 的示例](https://github.com/apache/incubator-apisix-docker/tree/master/example)来启动一个测试集群。
|
||||
Docker 镜像中并不包含 etcd，你可以参考 [docker compose 的示例](https://github.com/apache/apisix-docker/tree/master/example)来启动一个测试集群。
|
||||
|
||||
3. RPM 包（只适用于 CentOS 7）
|
||||
- 安装依赖：OpenResty 和 etcd，参考[依赖安装文档](doc/zh-cn/install-dependencies.md#centos-7)
|
||||
@ -177,15 +177,15 @@ etcd --enable-v2=true &
|
||||
|
||||
- 源码编译
|
||||
```shell
|
||||
git clone git@github.com:apache/incubator-apisix.git
|
||||
cd incubator-apisix
|
||||
git clone git@github.com:apache/apisix.git
|
||||
cd apisix
|
||||
make deps
|
||||
```
|
||||
|
||||
- Docker 镜像
|
||||
```shell
|
||||
git clone https://github.com/apache/incubator-apisix-docker.git
|
||||
cd incubator-apisix-docker
|
||||
git clone https://github.com/apache/apisix-docker.git
|
||||
cd apisix-docker
|
||||
sudo docker build -f alpine-dev/Dockerfile .
|
||||
```
|
||||
|
||||
@ -209,7 +209,7 @@ etcd --enable-v2=true &
|
||||
|
||||
## 控制台
|
||||
|
||||
APISIX 提供了 [Dashboard 项目](https://github.com/apache/incubator-apisix-dashboard)，
|
||||
APISIX 提供了 [Dashboard 项目](https://github.com/apache/apisix-dashboard)，
|
||||
可以使用 docker compose 直接部署和体验。
|
||||
|
||||
Dashboard 默认只允许 127.0.0.1 访问。你可以自行修改 `conf/config.yaml` 中的 `allow_admin` 字段，指定允许访问 dashboard 的 IP 列表。
|
||||
|
||||
@ -131,7 +131,7 @@ function _M.rewrite(conf, ctx)
|
||||
|
||||
if conf.http_to_https and ctx.var.scheme == "http" then
|
||||
-- TODO： add test case
|
||||
-- PR: https://github.com/apache/incubator-apisix/pull/1958
|
||||
-- PR: https://github.com/apache/apisix/pull/1958
|
||||
uri = "https://$host$request_uri"
|
||||
ret_code = 301
|
||||
end
|
||||
|
||||
@ -58,7 +58,7 @@ Execute the following command in the terminal to complete the installation of AP
|
||||
> Install the code for the master branch via a script
|
||||
|
||||
```shell
|
||||
sudo sh -c "$(curl -fsSL https://raw.githubusercontent.com/apache/incubator-apisix/master/utils/install-apisix.sh)"
|
||||
sudo sh -c "$(curl -fsSL https://raw.githubusercontent.com/apache/apisix/master/utils/install-apisix.sh)"
|
||||
```
|
||||
|
||||
> Install the specified version via Luarocks:
|
||||
@ -118,7 +118,7 @@ Makefile rules:
|
||||
### Troubleshoot Testing
|
||||
|
||||
**Set Nginx Path**
|
||||
- If you run in to an issue `Error unknown directive "lua_package_path" in /API_ASPIX/incubator-apisix/t/servroot/conf/nginx.conf`
|
||||
- If you run in to an issue `Error unknown directive "lua_package_path" in /API_ASPIX/apisix/t/servroot/conf/nginx.conf`
|
||||
make sure to set openresty as default nginx. And export the path as below.
|
||||
* export PATH=/usr/local/openresty/nginx/sbin:$PATH
|
||||
- Linux default installation path:
|
||||
|
||||
@ -40,9 +40,9 @@
|
||||
maxLevel: 4,
|
||||
subMaxLevel: 2,
|
||||
name: '',
|
||||
repo: 'https://github.com/apache/incubator-apisix/',
|
||||
repo: 'https://github.com/apache/apisix/',
|
||||
plugins: [
|
||||
EditOnGithubPlugin.create("https://github.com/apache/incubator-apisix/tree/master/doc/", null, "Edit of Github")
|
||||
EditOnGithubPlugin.create("https://github.com/apache/apisix/tree/master/doc/", null, "Edit of Github")
|
||||
]
|
||||
}
|
||||
</script>
|
||||
|
||||
@ -22,7 +22,7 @@
|
||||
This page documents an alphabetical list of institutions that are using APISIX for research and production,
|
||||
or providing commercial products including APISIX.
|
||||
|
||||
Users are encouraged to add themselves to this page, [issue](https://github.com/apache/incubator-apisix/issues/487) and PR are welcomed.
|
||||
Users are encouraged to add themselves to this page, [issue](https://github.com/apache/apisix/issues/487) and PR are welcomed.
|
||||
|
||||
1. <a href="https://www.360.cn/" rel="nofollow">360 奇虎</a>
|
||||
1. <a href="https://www.chaolian360.com/" rel="nofollow">chaolian 超链云商</a>
|
||||
|
||||
@ -57,7 +57,7 @@ sudo yum install -y https://github.com/apache/apisix/releases/download/1.5/apisi
|
||||
> 通过脚本安装 master 分支的代码
|
||||
|
||||
```shell
|
||||
sudo sh -c "$(curl -fsSL https://raw.githubusercontent.com/apache/incubator-apisix/master/utils/install-apisix.sh)"
|
||||
sudo sh -c "$(curl -fsSL https://raw.githubusercontent.com/apache/apisix/master/utils/install-apisix.sh)"
|
||||
```
|
||||
|
||||
> 通过 Luarocks 安装指定的版本:
|
||||
@ -117,7 +117,7 @@ Makefile rules:
|
||||
|
||||
**配置 Nginx 路径**
|
||||
|
||||
如果遇到问题 `Error unknown directive "lua_package_path" in /API_ASPIX/incubator-apisix/t/servroot/conf/nginx.conf`
|
||||
如果遇到问题 `Error unknown directive "lua_package_path" in /API_ASPIX/apisix/t/servroot/conf/nginx.conf`
|
||||
确保将openresty设置为默认的nginx并按如下所示导出路径。
|
||||
|
||||
* export PATH=/usr/local/openresty/nginx/sbin:$PATH
|
||||
|
||||
@ -55,7 +55,7 @@ etcd:
|
||||
|
||||
### Usage
|
||||
|
||||
#### Create configmap for apache incubator-apisix
|
||||
#### Create configmap for apache apisix
|
||||
|
||||
```
|
||||
$ kubectl apply -f apisix-gw-config-cm.yaml
|
||||
@ -73,19 +73,19 @@ etcd:
|
||||
- "http://127.0.0.1:2379" # multiple etcd address
|
||||
```
|
||||
|
||||
#### Create deployment for apache incubator-apisix
|
||||
#### Create deployment for apache apisix
|
||||
|
||||
```
|
||||
$ kubectl apply -f deployment.yaml
|
||||
```
|
||||
|
||||
#### Create service for apache incubator-apisix
|
||||
#### Create service for apache apisix
|
||||
|
||||
```
|
||||
$ kubectl apply -f service.yaml
|
||||
```
|
||||
|
||||
#### Scale apache incubator-apisix
|
||||
#### Scale apache apisix
|
||||
|
||||
```
|
||||
$ kubectl scale deployment apisix-gw-deployment --replicas=4
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
export etcd_url='http://$ETCD_IP_ADDRESS:2379'
|
||||
|
||||
wget https://raw.githubusercontent.com/apache/incubator-apisix/master/conf/config.yaml
|
||||
wget https://raw.githubusercontent.com/apache/apisix/master/conf/config.yaml
|
||||
|
||||
sed -i -e ':a' -e 'N' -e '$!ba' -e "s/allow_admin[a-z: #\/._]*\n\( *- [0-9a-zA-Z: #\/._',]*\n*\)*//g" config.yaml
|
||||
|
||||
|
||||
@ -20,13 +20,13 @@ version = "master-0"
|
||||
supported_platforms = {"linux", "macosx"}
|
||||
|
||||
source = {
|
||||
url = "git://github.com/apache/incubator-apisix",
|
||||
url = "git://github.com/apache/apisix",
|
||||
branch = "master",
|
||||
}
|
||||
|
||||
description = {
|
||||
summary = "Apache APISIX is a cloud-native microservices API gateway, delivering the ultimate performance, security, open source and scalable platform for all your APIs and microservices.",
|
||||
homepage = "https://github.com/apache/incubator-apisix",
|
||||
homepage = "https://github.com/apache/apisix",
|
||||
license = "Apache License 2.0",
|
||||
}
|
||||
|
||||
|
||||
@ -21,7 +21,7 @@ set -ex
|
||||
|
||||
OR_EXEC=`which openresty 2>&1`
|
||||
echo $OR_EXEC
|
||||
APISIX_VER="https://raw.githubusercontent.com/apache/incubator-apisix/master/rockspec/apisix-master-0.rockspec"
|
||||
APISIX_VER="https://raw.githubusercontent.com/apache/apisix/master/rockspec/apisix-master-0.rockspec"
|
||||
|
||||
# check the openresty exist
|
||||
CHECK_OR_EXIST=`echo $OR_EXEC | grep ": no openresty" | wc -l`
|
||||
|
||||
Loading…
Reference in New Issue
Block a user