Skip to content

服务参数 ​

ordo-server 的参数。每个参数也可以用表中的环境变量设置。ordo-server --help 会打印同样的列表。开发用的 ordo 命令行见命令行。

监听 ​

参数环境变量默认值作用
--http-addrORDO_HTTP_ADDR0.0.0.0:8080HTTP 地址
-p、--portORDO_PORT只设 HTTP 端口。两者都设时以 --http-addr 为准
--grpc-addrORDO_GRPC_ADDR0.0.0.0:50051gRPC 地址
--grpc-portORDO_GRPC_PORT只设 gRPC 端口
--uds-pathORDO_UDS_PATH关闭同时在这个 Unix Socket 上提供 gRPC
--disable-httpORDO_DISABLE_HTTP关闭 HTTP
--disable-grpcORDO_DISABLE_GRPC关闭 gRPC

规则文件 ​

参数环境变量默认值作用
--rules-dirORDO_RULES_DIR只在内存从这个目录加载规则,修改也保存到这里
--max-versionsORDO_MAX_VERSIONS10每条规则保留的旧版本数
--watch-rulesORDO_WATCH_RULES关闭磁盘上的文件变了就重新加载
--wal-dirORDO_WAL_DIR<rules-dir>/wal预写日志目录
--wal-disabledORDO_WAL_DISABLED关闭预写日志。写入在崩溃时不再安全
--wal-max-segment-bytesORDO_WAL_MAX_SEGMENT_BYTES67108864日志段达到这个大小就轮转
--wal-max-closed-segmentsORDO_WAL_MAX_CLOSED_SEGMENTS3保留的已关闭日志段数
--max-rules-per-tenantORDO_MAX_RULES_PER_TENANT不限超过后新建返回 422
--max-total-rulesORDO_MAX_TOTAL_RULES不限同上,所有租户合计

多实例 ​

见部署。

参数环境变量默认值作用
--roleORDO_ROLEstandalonestandalone、writer 或 reader。读节点对写请求返回 409
--writer-addrORDO_WRITER_ADDR写节点地址,读节点在 409 里返回它
--nats-urlORDO_NATS_URL关闭通过 NATS JetStream 同步规则变更
--nats-subject-prefixORDO_NATS_SUBJECT_PREFIXordo.rules同步事件的 subject 前缀
--instance-idORDO_INSTANCE_ID随机这个实例在 NATS 里的唯一名称

访问和限制 ​

参数环境变量默认值作用
--api-tokenORDO_API_TOKEN关闭HTTP 数据接口需要 Authorization: Bearer <token> 或 X-API-Token
--cors-allowed-originsORDO_CORS_ORIGINS无允许的浏览器来源,逗号分隔,或 *
--max-concurrent-executionsORDO_MAX_CONCURRENT_EXECUTIONS0(不限)同时处理的请求数,HTTP 和 gRPC 合计
--request-timeout-secsORDO_REQUEST_TIMEOUT_SECS30HTTP 请求超时后返回 408
--max-request-body-bytesORDO_MAX_REQUEST_BODY_BYTES10485760请求体上限,HTTP 和 gRPC
--shutdown-timeout-secsORDO_SHUTDOWN_TIMEOUT_SECS30关闭时等待进行中请求的时间
--grpc-tls-enabledORDO_GRPC_TLS_ENABLEDgRPC 的 TLS,配合下面两个参数
--grpc-tls-certORDO_GRPC_TLS_CERTPEM 证书
--grpc-tls-keyORDO_GRPC_TLS_KEYPEM 私钥(PKCS8)
--grpc-mtls-enabledORDO_GRPC_MTLS_ENABLED要求客户端证书,同时开启 TLS
--grpc-tls-client-caORDO_GRPC_TLS_CLIENT_CA签发客户端证书的 CA

租户 ​

参数环境变量默认值作用
--multi-tenancy-enabledORDO_MULTI_TENANCY_ENABLED关闭按 X-Tenant-ID 分开规则和限制
--default-tenantORDO_DEFAULT_TENANTdefault没带请求头时用的租户
--default-tenant-qpsORDO_DEFAULT_TENANT_QPS不限该租户每秒请求数
--default-tenant-burstORDO_DEFAULT_TENANT_BURST不限该租户的突发量
--default-tenant-timeout-msORDO_DEFAULT_TENANT_TIMEOUT_MS100该租户的执行超时
--tenants-dirORDO_TENANTS_DIR<rules-dir>/tenants/tenants.json保存租户设置的文件

签名规则 ​

见签名规则。

参数环境变量默认值作用
--signature-enabledORDO_SIGNATURE_ENABLED关闭校验签名
--signature-requireORDO_SIGNATURE_REQUIRE关闭拒绝未签名的规则,API 和文件都算
--signature-trusted-keysORDO_SIGNATURE_TRUSTED_KEYS受信任的公钥,base64,逗号分隔
--signature-trusted-keys-fileORDO_SIGNATURE_TRUSTED_KEYS_FILE同上,每行一个
--signature-allow-unsigned-localORDO_SIGNATURE_ALLOW_UNSIGNED_LOCALtrue加载未签名的本地文件。只能用环境变量关闭:ORDO_SIGNATURE_ALLOW_UNSIGNED_LOCAL=false

日志、审计和捕获 ​

参数环境变量默认值作用
--log-levelORDO_LOG_LEVELinfotrace、debug、info、warn 或 error
--log-formatORDO_LOG_FORMATtexttext 或 json
--audit-dirORDO_AUDIT_DIR只输出到 stdout同时把审计日志按天写到这个目录
--audit-sample-rateORDO_AUDIT_SAMPLE_RATE10写入审计日志的执行百分比
--capture-io-pathORDO_CAPTURE_IO_PATH关闭记录每次执行的输入和输出,供 ordo replay 和 ordo impact 使用
--capture-io-sample-rateORDO_CAPTURE_IO_SAMPLE_RATE100记录的执行百分比
--service-nameORDO_SERVICE_NAMEordo-server追踪里的服务名
--otlp-endpointORDO_OTLP_ENDPOINT关闭通过 OTLP HTTP 导出 OpenTelemetry 追踪,比如 http://otel-collector:4318
--debug-modeORDO_DEBUG_MODE关闭加上调试 API。不要用于生产

决策模型网关 ​

见决策模型网关。

参数环境变量默认值作用
--decide-upstreamORDO_DECIDE_UPSTREAM关闭要转发到的 System One 兼容 API。设置后网关开启
--decide-api-keyORDO_DECIDE_API_KEY发给上游的密钥。不设时转发调用方的 Authorization。开启 --api-token 时必须设置
--decide-log-dirORDO_DECIDE_LOG_DIR关闭决策日志写到这里
--decide-log-requestsORDO_DECIDE_LOG_REQUESTS关闭同时记录每个请求的 state 和 questions

平台 ​

见引擎。

参数环境变量默认值作用
--platform-urlORDO_PLATFORM_URL要注册到的平台
--server-tokenORDO_SERVER_TOKEN这个引擎唯一的令牌,注册时必需
--platform-connect-tokenORDO_CONNECT_TOKEN把引擎放进一个组织
--platform-registration-secretORDO_PLATFORM_REGISTRATION_SECRET不用连接令牌时的全平台密钥
--server-nameORDO_SERVER_NAMEordo-server平台里显示的名称
--server-urlORDO_SERVER_URLhttp://<http-addr>平台访问这个引擎的地址
--stats-interval-secsORDO_STATS_INTERVAL_SECS15向平台发送执行统计的间隔

签名工具 ​

cargo build --release 还会构建 ordo-keygen、ordo-sign 和 ordo-verify:

bash
ordo-keygen --output ./keys
ordo-sign --key ./keys/private.key --input rule.json [--output rule.signed.json]
ordo-verify --key ./keys/public.key --input rule.signed.json

基于 MIT 许可发布。