apisix docker鏡像構建及插件化開發

2020 年 9 月 18 日
筆記
apisix, lua, OpenResty

高能勸退：lua開發，適合小白看！！！

前段時間有個項目，用的java程序做網關，壓測tps只有1k多點，慘不忍睹。

後來公司有個大佬改用apisix做網關，tps飆升到1w多。

於是對神奇的apisix產生了濃厚的崇敬之情。感興趣之餘，便學習了一點apisix的插件開發。

當然，只是一些入門基本的開發。源碼什麼的肯定看不懂。

docker構建

為了開發方便，這裡用了docker。可以選擇自己構建，也可以從dockerhub拉取我構建好的

docker pull xshower/apisix:centos8

自己構建一個apisix的docker鏡像，Dockerfile內容如下

FROM centos:8

MAINTAINER xShower<//gitee.com/syher>

ARG APISIX_VERSION=1.5
LABEL apisix_version="${APISIX_VERSION}"

RUN yum -y install yum-utils gcc automake autoconf libtool make \
	&& yum-config-manager --add-repo //openresty.org/package/centos/openresty.repo \
	&& yum install -y openresty \
	&& yum install -y //github.com/apache/apisix/releases/download/$APISIX_VERSION/apisix-$APISIX_VERSION-0.el7.noarch.rpm \
	&& yum clean all \
	&& sed -i 's/PASS_MAX_DAYS\t99999/PASS_MAX_DAYS\t60/g' /etc/login.defs

ADD entrypoint.sh .
ADD apisix-dashboard.tar /usr/local/apisix/

WORKDIR /usr/local/apisix

ENTRYPOINT sh /entrypoint.sh && /bin/bash

基於centos8構建了最基礎的apisix鏡像，apisix-dashboard.tar是apisix的webui。需要自己解壓到apisix的安裝目錄。

鏡像構建完以後會執行entrypoint.sh腳本。

#! /bin/sh
INIT_DIR=/prepare-init.d
LUAROCKS_DIR=/usr/local/apisix/third
function run_script() {
    sh script_file
}

# 執行$INIT_DIR中的shell腳本
function init() {
    run_script 
}

# 加載luarocks
function init_luarocks() {
}

# 啟動apisix
function start() {
}

init
init_luarocks
start

腳本內容很簡單，在啟動apisix之前加載$INIT_DIR目錄下的shell腳本及構建$LUAROCKS_DIR目錄下的luarocks依賴。

為了方便開發，我在$INIT_DIR目錄下放了安裝lua和luarocks的腳本。就是簡單的wget/tar/make。腳本內容就不貼代碼了，可以在git上面看。

這樣一個簡單的apisix鏡像就構建好了，因為apisix依賴etcd。所以這裡採用docker-compose容器編排

version: '3.1'
services:
  apisix:
    #build:
    #  context: ./docker
    #  dockerfile: Dockerfile
    image: xshower/apisix:centos8
    restart: always
    depends_on:
      - etcd
    ports:
      - 9080:9080
      - 9443:9443
      - 9180:9180
    volumes:
      - ./docker/prepare-init.d:/prepare-init.d
      - ./conf/config.yaml:/usr/local/apisix/conf/config.yaml:ro
      - ./third:/usr/local/apisix/third
      - ./logs:/usr/local/apisix/logs
      - ./docker/entrypoint.sh:/entrypoint.sh
  etcd:
    image: bitnami/etcd:3.4.9
    user: root
    restart: always
    volumes:
      - ./etcd_data:/etcd_data
    environment:
      ETCD_DATA_DIR: /etcd_data
      ETCD_ENABLE_V2: "true"
      ALLOW_NONE_AUTHENTICATION: "yes"
      ETCD_ADVERTISE_CLIENT_URLS: "//0.0.0.0:2379"
      ETCD_LISTEN_CLIENT_URLS: "//0.0.0.0:2379"
    ports:
      - "2379:2379/tcp"

指定了apisix依賴以及文件路徑映射和端口映射。這樣，一個簡單的apisix開發環境就搭建好了。

插件開發

接下來說apisix插件化開發。

apisix本身自帶了甚多插件。limit-req限流；proxy-rewrite地址匹配；jwt-auth授權認證；kafka-logger日誌等。

但是，有時候apisix自帶插件不滿足我們應用需求時，這時候就只能我們自己開發。

apisix默認讀取的插件目錄是$APISIX_HOME/apisix/plugins，apisix自帶那些插件也都在這個目錄底下。

當然也可以添加自定義的插件目錄，需要修改/usr/bin/apisix

# 第二行內容修改前
package.path = "/usr/local/apisix/?.lua;" .. package.path

#修改後
package.path = "/usr/local/apisix/?.lua;/usr/local/apisix/third/?.lua;/usr/local/apisix/third/deps/share/lua/5.1/?.lua;" .. package.path

其中，/usr/local/apisix/third就是我們自定義的插件目錄，這樣apisix既會讀取默認的插件目錄，又會讀取我們定義的插件目錄。

目錄定義好以後，記得把自定義的插件放在third/plugins目錄下,不能直接放在third目錄中。

接下來，我們寫一個lua插件，內容很簡單，每次請求的時候。打印日誌。

local core = require("apisix.core")

local plugin_name = "third-plugin"

local schema = {
    type = "object",
    properties = {
        content = {
            type = "string"
        }
    }
}

local _M = {
    version = 0.2,
    priority = 5000,
    name = plugin_name,
    schema = schema,
}

function _M.access(conf, ctx)
    // 打印日誌
    core.log.warn(conf.content)
end

return _M

然後修改$APISIX_HOME/conf/config.yaml

　　#allow_admin:
　　　　# - 127.0.0.0/24　　　　#開啟dashboard遠程訪問
　　　　　　#- "::/64"
　　port_admin: 9180　　　　　　#開啟dashboard web端口
etcd:
  host:                          
    - "//主機IP:2379"     # 修改成主機的ip,不能直接用127.0.0.1

plugins:
  - ...省略自帶插件
  - third-plugin

啟動docker。這裡我用了idea自帶的docker-compose插件。大家也可以再docker-compose.yml所在目錄下執行docker-compose up -d命令