APISIX 安装指南
本文将介绍如何在你的环境中安装并运行 APISIX。
关于如何快速运行 Apache APISIX,请参考入门指南。
安装 APISIX
你可以选择以下任意一种方式安装 APISIX:
- Docker
- Helm
- RPM
使用此方法安装 APISIX,你需要安装 Docker 和 Docker Compose。
首先下载 apisix-docker 仓库。
git clone https://github.com/apache/apisix-docker.git
cd apisix-docker/example
然后,使用 docker-compose
启用 APISIX。
- x86
- ARM/M1
docker-compose -p docker-apisix up -d
docker-compose -p docker-apisix -f docker-compose-arm64.yml up -d
通过 Helm 安装 APISIX,请执行以下命令:
helm repo add apisix https://charts.apiseven.com
helm repo update
helm install apisix apisix/apisix --create-namespace --namespace apisix
你可以从 apisix-helm-chart 仓库找到其他组件。
该安装方法适用于 CentOS 7 和 CentOS 8。如果你选择该方法安装 APISIX,需要先安装 etcd。具体安装方法请参考安装 etcd。
通过 RPM 仓库安装
如果当前系统没有安装 OpenResty,请使用以下命令来安装 OpenResty 和 APISIX 仓库:
sudo yum install -y https://repos.apiseven.com/packages/centos/apache-apisix-repo-1.0-1.noarch.rpm
如果已安装 OpenResty 的官方 RPM 仓库,请使用以下命令安装 APISIX 的 RPM 仓库:
sudo yum-config-manager --add-repo https://repos.apiseven.com/packages/centos/apache-apisix.repo
完成上述操作后使用以下命令安装 APISIX:
sudo yum install apisix
tip
你也可以安装指定版本的 APISIX(本示例为 APISIX v2.13.1 LTS 版本):
sudo yum install apisix-2.13.1
通过 RPM 包离线安装:
将 APISIX 离线 RPM 包下载到 apisix
文件夹:
sudo mkdir -p apisix
sudo yum install -y https://repos.apiseven.com/packages/centos/apache-apisix-repo-1.0-1.noarch.rpm
sudo yum clean all && yum makecache
sudo yum install -y --downloadonly --downloaddir=./apisix apisix
然后将 apisix
文件夹复制到目标主机并运行以下命令:
sudo yum install ./apisix/*.rpm
管理 APISIX 服务
APISIX 安装完成后,你可以运行以下命令初始化 NGINX 配置文件和 etcd:
apisix init
使用以下命令启动 APISIX:
apisix start
tip
你可以运行 apisix help
命令,通过查看返回结果,获取其他操作的命令及描述。
安装 etcd
APISIX 使用 etcd 作为配置中心进行保存和同步配置。在安装 APISIX 之前,需要在你的主机上安装 etcd。
如果你在安装 APISIX 时选择了 Docker 或 Helm 安装,那么 etcd 将会自动安装;如果你选择其他方法或者需要手动安装 APISIX,请参考以下步骤安装 etcd:
- Linux
- macOS
ETCD_VERSION='3.4.18'
wget https://github.com/etcd-io/etcd/releases/download/v${ETCD_VERSION}/etcd-v${ETCD_VERSION}-linux-amd64.tar.gz
tar -xvf etcd-v${ETCD_VERSION}-linux-amd64.tar.gz && \
cd etcd-v${ETCD_VERSION}-linux-amd64 && \
sudo cp -a etcd etcdctl /usr/bin/
nohup etcd >/tmp/etcd.log 2>&1 &
brew install etcd
brew services start etcd
后续操作
更新 Admin API key
建议修改 Admin API 的 key,保护 APISIX 的安全。
请参考如下信息更新配置文件:
conf/config.yaml
apisix:
admin_key
-
name: "admin"
key: newsupersecurekey # 请修改 key 的值
role: admin
更新完成后,你可以使用新的 key 访问 Admin API:
curl http://127.0.0.1:9080/apisix/admin/routes?api_key=newsupersecurekey -i
为 APISIX 添加 systemd 配置文件
如果你是通过 RPM 包安装 APISIX,配置文件已经自动安装,你可以直接使用以下命令:
systemctl start apisix
systemctl stop apisix
如果你是通过其他方法安装的 APISIX,可以参考配置文件模板进行修改,并将其添加在 /usr/lib/systemd/system/apisix.service
路径下。
如需了解 APISIX 后续使用,请参考入门指南获取更多信息。