APISIX初探

.
├── apisix              # apisix lua源码
│   ├── admin               # apisix admin api
│   ├── balancer            # upstream 负载均衡
│   ├── cli                 # command line interface
│   ├── control             # control api
│   ├── core                # 一些配置，etcd交互，请求解析等
│   ├── discovery           # 服务发现
│   ├── http                # 路由匹配等
│   ├── plugins             # 自带的插件在该目录
│   ├── ssl                 # ssl sni 相关
│   ├── stream              # 流处理相关，包含了流处理的一些插件
│   └── utils
├── benchmark
├── bin                 # apisix 运行入口(develop)
├── ci
├── conf                # 配置文件
├── docs
├── example
├── kubernetes          # kubernetes 部署文件
├── logos
├── rockspec            # luarocks 依赖描述文件
├── t                   # test
├── utils
...
└── Makefile            # make

make deps

make run

#!/bin/bash
...
    # use the luajit of openresty
    echo "$LUAJIT_BIN $APISIX_LUA $*"
    exec $LUAJIT_BIN $APISIX_LUA $*
elif [[ "$LUA_VERSION" =~ "Lua 5.1" ]]; then
    # OpenResty version is not 1.19, use Lua 5.1 by default
    echo "lua $APISIX_LUA $*"
    exec lua $APISIX_LUA $*
...

# Configuration File - Nginx Server Configs
# This is a read-only file, do not try to modify it.

# https://github.com/apache/apisix/blob/master/conf/config-default.yaml#L158-L175
# config.yaml  该节中的配置会被设置至对应的位置
# 下面节是 nginx_config.main_configuration_snippet 中的内容。
# main configuration snippet starts

# main configuration snippet ends

http {
...
    # http configuration snippet starts


    # http configuration snippet ends

    # 参考：https://github.com/openresty/lua-resty-core/blob/master/lib/ngx/balancer.md#http-subsystem
    # 这里是 apisix 中对 ngx balancer 的实现。实现了 proxy bypass 的路由选择。对应apisix 中负载均衡 upstream 功能。
    # apisix 中的负载均衡实现在 https://github.com/apache/apisix/tree/master/apisix/balancer 中，目前提供了5 种算法。
    upstream apisix_backend {
        server 0.0.0.1; # 随便填一个无效的值

        balancer_by_lua_block {
            # https://github.com/apache/apisix/blob/e7d26dc4f0bd690c288867a248a69f0efeaea733/apisix/init.lua#L709
            apisix.http_balancer_phase()
        }
    ...
    }


    # https://openresty-reference.readthedocs.io/en/latest/Directives/#init_by_lua_block
    init_by_lua_block {
        require "resty.core"
        apisix = require("apisix")

        local dns_resolver = { "127.0.0.53", }
        local args = {
            dns_resolver = dns_resolver,
        }
        # https://github.com/apache/apisix/blob/e7d26dc4f0bd690c288867a248a69f0efeaea733/apisix/init.lua#L61
        apisix.http_init(args)
    }

    init_worker_by_lua_block {
        # https://github.com/apache/apisix/blob/e7d26dc4f0bd690c288867a248a69f0efeaea733/apisix/init.lua#L90
        apisix.http_init_worker()
    }

    exit_worker_by_lua_block {
        # https://github.com/apache/apisix/blob/e7d26dc4f0bd690c288867a248a69f0efeaea733/apisix/init.lua#L137
        apisix.http_exit_worker()
    }

    server {
        listen 127.0.0.1:9090;

        access_log off;

        location / {
            content_by_lua_block {
                # https://github.com/apache/apisix/blob/e7d26dc4f0bd690c288867a248a69f0efeaea733/apisix/init.lua#L773
                apisix.http_control()
            }
        }
    ...
    }

    server {
        listen 127.0.0.1:9091;

        access_log off;

        location / {
            content_by_lua_block {
                local prometheus = require("apisix.plugins.prometheus")
                prometheus.export_metrics()
            }
        }

        location = /apisix/nginx_status {
            allow 127.0.0.0/24;
            deny all;
            stub_status;
        }
    }


    server {
        listen 9080 default_server reuseport;
        listen 9443 ssl default_server http2 reuseport;

        listen [::]:9080 default_server reuseport;
        listen [::]:9443 ssl default_server http2 reuseport;

        server_name _;

        # apisix ssl 服务端证书配置
        ssl_certificate      cert/ssl_PLACE_HOLDER.crt;
        ssl_certificate_key  cert/ssl_PLACE_HOLDER.key;
...
        # http server configuration snippet starts


        # http server configuration snippet ends

        location = /apisix/nginx_status {
            allow 127.0.0.0/24;
            deny all;
            access_log off;
            stub_status;
        }

        location /apisix/admin {
            set $upstream_scheme             'http';
            set $upstream_host               $http_host;
            set $upstream_uri                '';

                allow 127.0.0.0/24;
                deny all;

            content_by_lua_block {
                # https://github.com/apache/apisix/blob/e7d26dc4f0bd690c288867a248a69f0efeaea733/apisix/init.lua#L752
                apisix.http_admin()
            }
        }

        ssl_certificate_by_lua_block {
            # https://github.com/apache/apisix/blob/e7d26dc4f0bd690c288867a248a69f0efeaea733/apisix/init.lua#L142
            apisix.http_ssl_phase()
        }

        proxy_ssl_name $upstream_host;
        proxy_ssl_server_name on;

        location / {
...
            access_by_lua_block {
                # https://github.com/apache/apisix/blob/e7d26dc4f0bd690c288867a248a69f0efeaea733/apisix/init.lua#L341
                apisix.http_access_phase()
            }
...

            # https://github.com/apache/apisix/blob/e7d26dc4f0bd690c288867a248a69f0efeaea733/apisix/init.lua#L709
            proxy_pass      $upstream_scheme://apisix_backend$upstream_uri;

            mirror          /proxy_mirror;

            header_filter_by_lua_block {
                # https://github.com/apache/apisix/blob/e7d26dc4f0bd690c288867a248a69f0efeaea733/apisix/init.lua#L575
                apisix.http_header_filter_phase()
            }

            body_filter_by_lua_block {
                # https://github.com/apache/apisix/blob/e7d26dc4f0bd690c288867a248a69f0efeaea733/apisix/init.lua#L612
                apisix.http_body_filter_phase()
            }

            log_by_lua_block {
                # https://github.com/apache/apisix/blob/e7d26dc4f0bd690c288867a248a69f0efeaea733/apisix/init.lua#L670
                apisix.http_log_phase()
            }
        }

        # 对于 grpc 类型的请求，会被跳转至此处执行
        location @grpc_pass {

            access_by_lua_block {
                # https://github.com/apache/apisix/blob/e7d26dc4f0bd690c288867a248a69f0efeaea733/apisix/init.lua#L553
                apisix.grpc_access_phase()
            }

            grpc_set_header   Content-Type application/grpc;
            grpc_socket_keepalive on;
            grpc_pass         $upstream_scheme://apisix_backend;

            header_filter_by_lua_block {
                apisix.http_header_filter_phase()
            }

            body_filter_by_lua_block {
                apisix.http_body_filter_phase()
            }

            log_by_lua_block {
                apisix.http_log_phase()
            }
        }
...
    }
    # http end configuration snippet starts


    # http end configuration snippet ends
}

        local discovery = require("apisix.discovery.init").discovery
        if discovery and discovery.init_worker then
            discovery.init_worker()
        end
        require("apisix.balancer").init_worker()
        load_balancer = require("apisix.balancer")
        require("apisix.admin.init").init_worker()

        require("apisix.timers").init_worker()

        plugin.init_worker()
        router.http_init_worker()
        require("apisix.http.service").init_worker()
        plugin_config.init_worker()
        require("apisix.consumer").init_worker()

        if core.config == require("apisix.core.config_yaml") then
            core.config.init_worker()
        end

        require("apisix.debug").init_worker()
        apisix_upstream.init_worker()
        require("apisix.plugins.ext-plugin.init").init_worker()

        local_conf = core.config.local_conf()

        if local_conf.apisix and local_conf.apisix.enable_server_tokens == false then
            ver_header = "APISIX"
        end

function _M.put(plugin_name, conf)
    local plugin_name, err = check_conf(plugin_name, conf)
    if not plugin_name then
        return 400, err
    end

    local key = "/plugin_metadata/" .. plugin_name
    core.log.info("key: ", key)
    local res, err = core.etcd.set(key, conf)
    if not res then
        core.log.error("failed to put plugin metadata[", key, "]: ", err)
        return 500, {error_msg = err}
    end

    return res.status, res.body
end

function _M.control_api()
    return {
        {
            methods = {"GET"},
            uris ={"/v1/server_info"},
            handler = get_server_info,
        }
    }
end