serverless

Description

There are two serverless Plugins in APISIX: serverless-pre-function and serverless-post-function. The former runs at the beginning of the specified phase, while the latter runs at the end of the specified phase.

Both Plugins have the same attributes.

Attributes

Name	Type	Required	Default	Valid values	Description
phase	string	False	["access"]	["rewrite", "access", "header_filter", "body_filter", "log", "before_proxy"]	Phase before or after which the serverless function is executed.
functions	array[string]	True			List of functions that are executed sequentially.

IMPORTANT

Only Lua functions are allowed here and not other Lua code.

For example, anonymous functions are legal:

return function()
    ngx.log(ngx.ERR, 'one')
end

Closures are also legal:

local count = 1
return function()
    count = count + 1
    ngx.say(count)
end

But code other than functions are illegal:

local count = 1
ngx.say(count)

note

From v2.6, conf and ctx are passed as the first two arguments to a serverless function like regular Plugins.

Prior to v2.12.0, the phase before_proxy was called balancer. This was updated considering that this method would run after access and before the request goes Upstream and is unrelated to balancer.

Enabling the Plugin

The example below enables the Plugin on a specific Route:

curl http://127.0.0.1:9180/apisix/admin/routes/1  -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
{
    "uri": "/index.html",
    "plugins": {
        "serverless-pre-function": {
            "phase": "rewrite",
            "functions" : ["return function() ngx.log(ngx.ERR, \"serverless pre function\"); end"]
        },
        "serverless-post-function": {
            "phase": "rewrite",
            "functions" : ["return function(conf, ctx) ngx.log(ngx.ERR, \"match uri \", ctx.curr_req_matched and ctx.curr_req_matched._path); end"]
        }
    },
    "upstream": {
        "type": "roundrobin",
        "nodes": {
            "127.0.0.1:1980": 1
        }
    }
}'

Example usage

Once you have configured the Plugin as shown above, you can make a request as shown below:

curl -i http://127.0.0.1:9080/index.html

You will find a message "serverless pre-function" and "match uri /index.html" in the error.log.

Disable Plugin

To disable the serverless Plugin, you can delete the corresponding JSON configuration from the Plugin configuration. APISIX will automatically reload and you do not have to restart for this to take effect.

curl http://127.0.0.1:9180/apisix/admin/routes/1  -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
{
    "methods": ["GET"],
    "uri": "/index.html",
    "upstream": {
        "type": "roundrobin",
        "nodes": {
            "127.0.0.1:1980": 1
        }
    }
}'