mirror of
https://gitee.com/iresty/apisix.git
synced 2024-12-15 01:11:58 +08:00
576 lines
17 KiB
Lua
576 lines
17 KiB
Lua
--
|
|
-- Licensed to the Apache Software Foundation (ASF) under one or more
|
|
-- contributor license agreements. See the NOTICE file distributed with
|
|
-- this work for additional information regarding copyright ownership.
|
|
-- The ASF licenses this file to You under the Apache License, Version 2.0
|
|
-- (the "License"); you may not use this file except in compliance with
|
|
-- the License. You may obtain a copy of the License at
|
|
--
|
|
-- http://www.apache.org/licenses/LICENSE-2.0
|
|
--
|
|
-- Unless required by applicable law or agreed to in writing, software
|
|
-- distributed under the License is distributed on an "AS IS" BASIS,
|
|
-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
-- See the License for the specific language governing permissions and
|
|
-- limitations under the License.
|
|
--
|
|
local schema = require('apisix.core.schema')
|
|
local setmetatable = setmetatable
|
|
local error = error
|
|
|
|
local _M = {version = 0.5}
|
|
|
|
|
|
local plugins_schema = {
|
|
type = "object"
|
|
}
|
|
|
|
|
|
local id_schema = {
|
|
anyOf = {
|
|
{
|
|
type = "string", minLength = 1, maxLength = 64,
|
|
pattern = [[^[a-zA-Z0-9-_]+$]]
|
|
},
|
|
{type = "integer", minimum = 1}
|
|
}
|
|
}
|
|
|
|
|
|
local host_def_pat = "^\\*?[0-9a-zA-Z-.]+$"
|
|
local host_def = {
|
|
type = "string",
|
|
pattern = host_def_pat,
|
|
}
|
|
_M.host_def = host_def
|
|
|
|
|
|
local ipv4_def = "[0-9]{1,3}.[0-9]{1,3}.[0-9]{1,3}.[0-9]{1,3}"
|
|
local ipv6_def = "([a-fA-F0-9]{0,4}:){0,8}(:[a-fA-F0-9]{0,4}){0,8}"
|
|
.. "([a-fA-F0-9]{0,4})?"
|
|
local ip_def = {
|
|
{pattern = "^" .. ipv4_def .. "$"},
|
|
{pattern = "^" .. ipv4_def .. "/[0-9]{1,2}$"},
|
|
{pattern = "^" .. ipv6_def .. "$"},
|
|
{pattern = "^" .. ipv6_def .. "/[0-9]{1,3}$"},
|
|
}
|
|
_M.ip_def = ip_def
|
|
|
|
|
|
local remote_addr_def = {
|
|
description = "client IP",
|
|
type = "string",
|
|
anyOf = ip_def,
|
|
}
|
|
|
|
|
|
local health_checker = {
|
|
type = "object",
|
|
properties = {
|
|
active = {
|
|
type = "object",
|
|
properties = {
|
|
type = {
|
|
type = "string",
|
|
enum = {"http", "https", "tcp"},
|
|
default = "http"
|
|
},
|
|
timeout = {type = "integer", default = 1},
|
|
concurrency = {type = "integer", default = 10},
|
|
host = host_def,
|
|
http_path = {type = "string", default = "/"},
|
|
https_verify_certificate = {type = "boolean", default = true},
|
|
healthy = {
|
|
type = "object",
|
|
properties = {
|
|
interval = {type = "integer", minimum = 1, default = 0},
|
|
http_statuses = {
|
|
type = "array",
|
|
minItems = 1,
|
|
items = {
|
|
type = "integer",
|
|
minimum = 200,
|
|
maximum = 599
|
|
},
|
|
uniqueItems = true,
|
|
default = {200, 302}
|
|
},
|
|
successes = {
|
|
type = "integer",
|
|
minimum = 1,
|
|
maximum = 254,
|
|
default = 2
|
|
}
|
|
}
|
|
},
|
|
unhealthy = {
|
|
type = "object",
|
|
properties = {
|
|
interval = {type = "integer", minimum = 1, default = 0},
|
|
http_statuses = {
|
|
type = "array",
|
|
minItems = 1,
|
|
items = {
|
|
type = "integer",
|
|
minimum = 200,
|
|
maximum = 599
|
|
},
|
|
uniqueItems = true,
|
|
default = {429, 404, 500, 501, 502, 503, 504, 505}
|
|
},
|
|
http_failures = {
|
|
type = "integer",
|
|
minimum = 1,
|
|
maximum = 254,
|
|
default = 5
|
|
},
|
|
tcp_failures = {
|
|
type = "integer",
|
|
minimum = 1,
|
|
maximum = 254,
|
|
default = 2
|
|
},
|
|
timeouts = {
|
|
type = "integer",
|
|
minimum = 1,
|
|
maximum = 254,
|
|
default = 3
|
|
}
|
|
}
|
|
},
|
|
req_headers = {
|
|
type = "array",
|
|
minItems = 1,
|
|
items = {
|
|
type = "string",
|
|
uniqueItems = true,
|
|
},
|
|
}
|
|
}
|
|
},
|
|
passive = {
|
|
type = "object",
|
|
properties = {
|
|
type = {
|
|
type = "string",
|
|
enum = {"http", "https", "tcp"},
|
|
default = "http"
|
|
},
|
|
healthy = {
|
|
type = "object",
|
|
properties = {
|
|
http_statuses = {
|
|
type = "array",
|
|
minItems = 1,
|
|
items = {
|
|
type = "integer",
|
|
minimum = 200,
|
|
maximum = 599,
|
|
},
|
|
uniqueItems = true,
|
|
default = {200, 201, 202, 203, 204, 205, 206, 207,
|
|
208, 226, 300, 301, 302, 303, 304, 305,
|
|
306, 307, 308}
|
|
},
|
|
successes = {
|
|
type = "integer",
|
|
minimum = 1,
|
|
maximum = 254,
|
|
default = 5
|
|
}
|
|
}
|
|
},
|
|
unhealthy = {
|
|
type = "object",
|
|
properties = {
|
|
http_statuses = {
|
|
type = "array",
|
|
minItems = 1,
|
|
items = {
|
|
type = "integer",
|
|
minimum = 200,
|
|
maximum = 599,
|
|
},
|
|
uniqueItems = true,
|
|
default = {429, 500, 503}
|
|
},
|
|
tcp_failures = {
|
|
type = "integer",
|
|
minimum = 1,
|
|
maximum = 254,
|
|
default = 2
|
|
},
|
|
timeouts = {
|
|
type = "integer",
|
|
minimum = 1,
|
|
maximum = 254,
|
|
default = 7
|
|
},
|
|
http_failures = {
|
|
type = "integer",
|
|
minimum = 1,
|
|
maximum = 254,
|
|
default = 5
|
|
},
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
additionalProperties = false,
|
|
anyOf = {
|
|
{required = {"active"}},
|
|
{required = {"active", "passive"}},
|
|
},
|
|
}
|
|
|
|
|
|
local nodes_schema = {
|
|
anyOf = {
|
|
{
|
|
type = "object",
|
|
patternProperties = {
|
|
[".*"] = {
|
|
description = "weight of node",
|
|
type = "integer",
|
|
minimum = 0,
|
|
}
|
|
},
|
|
minProperties = 1,
|
|
},
|
|
{
|
|
type = "array",
|
|
minItems = 1,
|
|
items = {
|
|
type = "object",
|
|
properties = {
|
|
host = host_def,
|
|
port = {
|
|
description = "port of node",
|
|
type = "integer",
|
|
minimum = 1,
|
|
},
|
|
weight = {
|
|
description = "weight of node",
|
|
type = "integer",
|
|
minimum = 0,
|
|
},
|
|
metadata = {
|
|
description = "metadata of node",
|
|
type = "object",
|
|
}
|
|
},
|
|
required = {"host", "port", "weight"},
|
|
},
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
local upstream_schema = {
|
|
type = "object",
|
|
properties = {
|
|
nodes = nodes_schema,
|
|
retries = {
|
|
type = "integer",
|
|
minimum = 1,
|
|
},
|
|
timeout = {
|
|
type = "object",
|
|
properties = {
|
|
connect = {type = "number", minimum = 0},
|
|
send = {type = "number", minimum = 0},
|
|
read = {type = "number", minimum = 0},
|
|
},
|
|
required = {"connect", "send", "read"},
|
|
},
|
|
k8s_deployment_info = {
|
|
type = "object",
|
|
properties = {
|
|
namespace = {type = "string", description = "k8s namespace"},
|
|
deploy_name = {type = "string", description = "k8s deployment name"},
|
|
service_name = {type = "string", description = "k8s service name"},
|
|
port = {type = "number", minimum = 0},
|
|
backend_type = {
|
|
type = "string",
|
|
default = "pod",
|
|
description = "k8s service name",
|
|
enum = {"svc", "pod"}
|
|
},
|
|
},
|
|
anyOf = {
|
|
{required = {"namespace", "deploy_name", "port"}},
|
|
{required = {"namespace", "service_name", "port"}},
|
|
},
|
|
},
|
|
type = {
|
|
description = "algorithms of load balancing",
|
|
type = "string",
|
|
enum = {"chash", "roundrobin"}
|
|
},
|
|
checks = health_checker,
|
|
hash_on = {
|
|
type = "string",
|
|
default = "vars",
|
|
enum = {
|
|
"vars",
|
|
"header",
|
|
"cookie",
|
|
"consumer",
|
|
},
|
|
},
|
|
key = {
|
|
description = "the key of chash for dynamic load balancing",
|
|
type = "string",
|
|
},
|
|
enable_websocket = {
|
|
description = "enable websocket for request",
|
|
type = "boolean"
|
|
},
|
|
name = {type = "string", maxLength = 50},
|
|
desc = {type = "string", maxLength = 256},
|
|
service_name = {type = "string", maxLength = 50},
|
|
id = id_schema
|
|
},
|
|
anyOf = {
|
|
{required = {"type", "nodes"}},
|
|
{required = {"type", "k8s_deployment_info"}},
|
|
{required = {"type", "service_name"}},
|
|
},
|
|
additionalProperties = false,
|
|
}
|
|
|
|
-- TODO: add more nginx variable support
|
|
_M.upstream_hash_vars_schema = {
|
|
type = "string",
|
|
pattern = [[^((uri|server_name|server_addr|request_uri|remote_port]]
|
|
.. [[|remote_addr|query_string|host|hostname)]]
|
|
.. [[|arg_[0-9a-zA-z_-]+)$]],
|
|
}
|
|
|
|
-- validates header name, cookie name.
|
|
-- a-z, A-Z, 0-9, '_' and '-' are allowed.
|
|
-- when "underscores_in_headers on", header name allow '_'.
|
|
-- http://nginx.org/en/docs/http/ngx_http_core_module.html#underscores_in_headers
|
|
_M.upstream_hash_header_schema = {
|
|
type = "string",
|
|
pattern = [[^[a-zA-Z0-9-_]+$]]
|
|
}
|
|
|
|
|
|
_M.route = {
|
|
type = "object",
|
|
properties = {
|
|
uri = {type = "string", minLength = 1, maxLength = 4096},
|
|
uris = {
|
|
type = "array",
|
|
items = {
|
|
description = "HTTP uri",
|
|
type = "string",
|
|
},
|
|
uniqueItems = true,
|
|
},
|
|
name = {type = "string", maxLength = 50},
|
|
desc = {type = "string", maxLength = 256},
|
|
priority = {type = "integer", default = 0},
|
|
|
|
methods = {
|
|
type = "array",
|
|
items = {
|
|
description = "HTTP method",
|
|
type = "string",
|
|
enum = {"GET", "POST", "PUT", "DELETE", "PATCH", "HEAD",
|
|
"OPTIONS", "CONNECT", "TRACE"}
|
|
},
|
|
uniqueItems = true,
|
|
},
|
|
host = host_def,
|
|
hosts = {
|
|
type = "array",
|
|
items = host_def,
|
|
uniqueItems = true,
|
|
},
|
|
remote_addr = remote_addr_def,
|
|
remote_addrs = {
|
|
type = "array",
|
|
items = remote_addr_def,
|
|
uniqueItems = true,
|
|
},
|
|
vars = {
|
|
type = "array",
|
|
items = {
|
|
description = "Nginx builtin variable name and value",
|
|
type = "array",
|
|
items = {
|
|
maxItems = 3,
|
|
minItems = 2,
|
|
anyOf = {
|
|
{type = "string",},
|
|
{type = "number",},
|
|
}
|
|
}
|
|
}
|
|
},
|
|
filter_func = {
|
|
type = "string",
|
|
minLength = 10,
|
|
pattern = [[^function]],
|
|
},
|
|
|
|
plugins = plugins_schema,
|
|
upstream = upstream_schema,
|
|
|
|
service_id = id_schema,
|
|
upstream_id = id_schema,
|
|
service_protocol = {
|
|
enum = {"grpc", "http"}
|
|
},
|
|
id = id_schema,
|
|
},
|
|
anyOf = {
|
|
{required = {"plugins", "uri"}},
|
|
{required = {"upstream", "uri"}},
|
|
{required = {"upstream_id", "uri"}},
|
|
{required = {"service_id", "uri"}},
|
|
{required = {"plugins", "uris"}},
|
|
{required = {"upstream", "uris"}},
|
|
{required = {"upstream_id", "uris"}},
|
|
{required = {"service_id", "uris"}},
|
|
},
|
|
additionalProperties = false,
|
|
}
|
|
|
|
|
|
_M.service = {
|
|
type = "object",
|
|
properties = {
|
|
id = id_schema,
|
|
plugins = plugins_schema,
|
|
upstream = upstream_schema,
|
|
upstream_id = id_schema,
|
|
name = {type = "string", maxLength = 50},
|
|
desc = {type = "string", maxLength = 256},
|
|
},
|
|
anyOf = {
|
|
{required = {"upstream"}},
|
|
{required = {"upstream_id"}},
|
|
{required = {"plugins"}},
|
|
},
|
|
additionalProperties = false,
|
|
}
|
|
|
|
|
|
_M.consumer = {
|
|
type = "object",
|
|
properties = {
|
|
username = {
|
|
type = "string", minLength = 1, maxLength = 32,
|
|
pattern = [[^[a-zA-Z0-9_]+$]]
|
|
},
|
|
plugins = plugins_schema,
|
|
desc = {type = "string", maxLength = 256}
|
|
},
|
|
required = {"username"},
|
|
additionalProperties = false,
|
|
}
|
|
|
|
|
|
_M.upstream = upstream_schema
|
|
|
|
|
|
_M.ssl = {
|
|
type = "object",
|
|
properties = {
|
|
id = id_schema,
|
|
cert = {
|
|
type = "string", minLength = 128, maxLength = 64*1024
|
|
},
|
|
key = {
|
|
type = "string", minLength = 128, maxLength = 64*1024
|
|
},
|
|
sni = {
|
|
type = "string",
|
|
pattern = [[^\*?[0-9a-zA-Z-.]+$]],
|
|
},
|
|
snis = {
|
|
type = "array",
|
|
items = {
|
|
type = "string",
|
|
pattern = [[^\*?[0-9a-zA-Z-.]+$]],
|
|
}
|
|
},
|
|
exptime = {
|
|
type = "integer",
|
|
minimum = 1588262400, -- 2020/5/1 0:0:0
|
|
},
|
|
status = {
|
|
description = "ssl status, 1 to enable, 0 to disable",
|
|
type = "integer",
|
|
enum = {1, 0},
|
|
default = 1
|
|
}
|
|
},
|
|
oneOf = {
|
|
{required = {"sni", "key", "cert"}},
|
|
{required = {"snis", "key", "cert"}}
|
|
},
|
|
additionalProperties = false,
|
|
}
|
|
|
|
|
|
|
|
_M.proto = {
|
|
type = "object",
|
|
properties = {
|
|
content = {
|
|
type = "string", minLength = 1, maxLength = 1024*1024
|
|
}
|
|
},
|
|
required = {"content"},
|
|
additionalProperties = false,
|
|
}
|
|
|
|
|
|
_M.global_rule = {
|
|
type = "object",
|
|
properties = {
|
|
id = id_schema,
|
|
plugins = plugins_schema
|
|
},
|
|
required = {"plugins"},
|
|
additionalProperties = false,
|
|
}
|
|
|
|
|
|
_M.stream_route = {
|
|
type = "object",
|
|
properties = {
|
|
id = id_schema,
|
|
remote_addr = remote_addr_def,
|
|
server_addr = {
|
|
description = "server IP",
|
|
type = "string",
|
|
anyOf = ip_def,
|
|
},
|
|
server_port = {
|
|
description = "server port",
|
|
type = "integer",
|
|
},
|
|
upstream = upstream_schema,
|
|
upstream_id = id_schema,
|
|
plugins = plugins_schema,
|
|
}
|
|
}
|
|
|
|
|
|
_M.id_schema = id_schema
|
|
|
|
|
|
setmetatable(_M, {
|
|
__index = schema,
|
|
__newindex = function() error("no modification allowed") end,
|
|
})
|
|
|
|
|
|
return _M
|