Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: add missing properties to schema #10339

Merged
merged 23 commits into from
Nov 20, 2023
Merged

fix: add missing properties to schema #10339

Changes from all commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
cd85c5d
fix: add missing properties to schema
pottekkat Oct 16, 2023
5e332dd
fix: add single integer
pottekkat Oct 16, 2023
5902e59
fix: use single schema instead of multiple schema
pottekkat Oct 16, 2023
2a0e751
fix: add properties to schema
pottekkat Oct 17, 2023
41182da
fix: CI errors
pottekkat Oct 17, 2023
f3ecf05
fix: CI errors
pottekkat Oct 17, 2023
d49d21b
Merge branch 'master' into fix/schema/1
pottekkat Oct 17, 2023
2eb47d9
fix CI error
pottekkat Oct 17, 2023
e4e5f56
fix: add number and string
pottekkat Oct 17, 2023
5f70eb1
remove prefix from required property
pottekkat Oct 24, 2023
ddae2a1
remove pattern
pottekkat Oct 24, 2023
ef3d8be
revert to working schema
pottekkat Nov 15, 2023
f22bc39
add newline
pottekkat Nov 15, 2023
bf8bdb8
revert to no change
pottekkat Nov 15, 2023
e15de73
test with minor changes
pottekkat Nov 15, 2023
0b8ad8d
change etcd schema
pottekkat Nov 15, 2023
6409be4
revert etcd schema change
pottekkat Nov 15, 2023
0608393
change validation logic
pottekkat Nov 15, 2023
fde02d8
merge schema
pottekkat Nov 16, 2023
6e42a89
remove deployment schema
pottekkat Nov 16, 2023
a7d2027
proper formatting
pottekkat Nov 16, 2023
3a3b72b
add properties
pottekkat Nov 16, 2023
c6595f3
fix deployment schema
pottekkat Nov 17, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
282 changes: 184 additions & 98 deletions apisix/cli/schema.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,14 +63,134 @@ local etcd_schema = {
description = "etcd connection timeout in seconds",
},
},
required = {"prefix", "host"}
required = { "prefix", "host" }
}

local admin_schema = {
type = "object",
properties = {
admin_key = {
type = "array",
properties = {
items = {
properties = {
name = { type = "string" },
key = { type = "string" },
role = { type = "string" },
}
}
}
},
admin_listen = {
properties = {
listen = { type = "string" },
port = { type = "integer" },
},
default = {
listen = "0.0.0.0",
port = 9180,
}
},
https_admin = {
type = "boolean",
},
admin_key_required = {
type = "boolean",
},
enable_admin_cors = {
type = "boolean"
},
allow_admin = {
type = "array",
items = {
type = "string"
}
},
admin_api_mtls = {
type = "object",
properties = {
admin_ssl_cert = {
type = "string"
},
admin_ssl_cert_key = {
type = "string"
},
admin_ssl_ca_cert = {
type = "string"
}
}
},
admin_api_version = {
type = "string"
}
}
}

local config_schema = {
type = "object",
properties = {
apisix = {
properties = {
node_listen = {
anyOf = {
{
type = "integer",
minimum = 1,
maximum = 65535
},
{
type = "array",
items = {
type = "integer",
minimum = 1,
maximum = 65535
}
},
{
type = "array",
items = {
type = "object",
properties = {
port = {
type = "integer",
minimum = 1,
maximum = 65535
},
ip = {
type = "string",
},
enable_http2 = {
type = "boolean",
},
}
},
}
},
},
enable_admin = {
type = "boolean",
},
enable_dev_mode = {
type = "boolean",
},
enable_reuseport = {
type = "boolean",
},
show_upstream_status_in_response_header = {
type = "boolean",
},
enable_ipv6 = {
type = "boolean",
},
enable_server_tokens = {
type = "boolean",
},
extra_lua_path = {
type = "string"
},
extra_lua_cpath = {
type = "string"
},
lua_module_hook = {
pattern = "^[a-zA-Z._-]+$",
},
Expand Down Expand Up @@ -118,12 +238,12 @@ local config_schema = {
},
oneOf = {
{
required = {"name", "memory_size"},
required = { "name", "memory_size" },
maxProperties = 2,
},
{
required = {"name", "memory_size", "disk_size",
"disk_path", "cache_levels"},
required = { "name", "memory_size", "disk_size",
"disk_path", "cache_levels" },
}
},
},
Expand All @@ -133,7 +253,7 @@ local config_schema = {
},
proxy_mode = {
type = "string",
enum = {"http", "stream", "http&stream"},
enum = { "http", "stream", "http&stream" },
},
stream_proxy = {
type = "object",
Expand Down Expand Up @@ -166,7 +286,7 @@ local config_schema = {
type = "boolean",
}
},
required = {"addr"}
required = { "addr" }
},
},
},
Expand Down Expand Up @@ -302,11 +422,11 @@ local config_schema = {
type = "integer"
},
http_request_phase = {
enum = {"access", "rewrite"},
enum = { "access", "rewrite" },
default = "access",
},
},
required = {"name", "file", "priority"}
required = { "name", "file", "priority" }
}
}
}
Expand All @@ -315,97 +435,71 @@ local config_schema = {
type = "object",
properties = {
role = {
enum = {"traditional", "control_plane", "data_plane", "standalone"},
enum = { "traditional", "control_plane", "data_plane", "standalone" },
default = "traditional"
}
},
},
},
},
required = {"apisix", "deployment"},
}

local admin_schema = {
type = "object",
properties = {
admin_key = {
type = "array",
properties = {
items = {
properties = {
name = {type = "string"},
key = {type = "string"},
role = {type = "string"},
dependencies = {
role = {
oneOf = {
{
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@pottekkat Will you make sure that this dependency schema fits right with this[1] yaml snippet here?

  1. https://github.com/apache/apisix/blob/88406dceab26ed7f25b663088b0b5e760bd45a38/t/cli/test_validate_config.sh#L210C1-L210C1

properties = {
role = { const = "traditional" },
etcd = etcd_schema,
admin = admin_schema,
role_traditional = {
type = "object",
properties = {
config_provider = {
enum = { "etcd" }
},
},
required = { "config_provider" }
},
},
required = { "role_traditional" },
},
{
properties = {
role = { const = "control_plane" },
etcd = etcd_schema,
admin = admin_schema,
role_control_plane = {
type = "object",
properties = {
config_provider = {
enum = { "etcd" }
},
},
required = { "config_provider" }
},
},
required = { "role_control_plane" },
},
{
properties = {
role = { const = "data_plane" },
etcd = etcd_schema,
role_data_plane = {
type = "object",
properties = {
config_provider = {
enum = { "etcd", "yaml", "xds" }
},
},
required = { "config_provider" }
},
},
required = { "role_data_plane" },
},
}
}
}
},
admin_listen = {
properties = {
listen = { type = "string" },
port = { type = "integer" },
},
default = {
listen = "0.0.0.0",
port = 9180,
}
},
https_admin = {
type = "boolean",
},
admin_key_required = {
type = "boolean",
},
}
}

local deployment_schema = {
traditional = {
properties = {
etcd = etcd_schema,
admin = admin_schema,
role_traditional = {
properties = {
config_provider = {
enum = {"etcd"}
},
},
required = {"config_provider"}
}
},
required = {"etcd"}
},
control_plane = {
properties = {
etcd = etcd_schema,
admin = admin_schema,
role_control_plane = {
properties = {
config_provider = {
enum = {"etcd"}
},
},
required = {"config_provider"}
},
},
required = {"etcd", "role_control_plane"}
},
data_plane = {
properties = {
etcd = etcd_schema,
role_data_plane = {
properties = {
config_provider = {
enum = {"etcd", "yaml", "xds"}
},
},
required = {"config_provider"}
},
},
required = {"role_data_plane"}
}
required = { "apisix", "deployment" },
}


function _M.validate(yaml_conf)
local validator = jsonschema.generate_validator(config_schema)
local ok, err = validator(yaml_conf)
Expand All @@ -426,15 +520,7 @@ function _M.validate(yaml_conf)
end
end

local role = yaml_conf.deployment.role
local validator = jsonschema.generate_validator(deployment_schema[role])
local ok, err = validator(yaml_conf.deployment)
if not ok then
return false, "invalid deployment " .. role .. " configuration: " .. err
end

return true
end


return _M