From f261d9ea9cc7d3460d30dbbed5ebf856a6d97edf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E9=9B=B7=E5=8D=81=E4=B8=80?= Date: Fri, 7 Nov 2025 10:28:47 +0800 Subject: [PATCH 1/2] change1 --- docs/deploy/deploy_processes/parameters.md | 2 +- docs/deploy/deploy_processes/production/deploy.md | 6 +++--- docs/deploy/deploy_processes/production/security.md | 4 ++-- .../api/yr_command_line_tool/yr_status.md | 2 +- docs/multi_language_function_programming_interface/index.md | 2 +- 5 files changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/deploy/deploy_processes/parameters.md b/docs/deploy/deploy_processes/parameters.md index 4574736..1483e36 100644 --- a/docs/deploy/deploy_processes/parameters.md +++ b/docs/deploy/deploy_processes/parameters.md @@ -14,7 +14,7 @@ | `-o,--master_info_output` | 控制面组件启动 IP、端口信息输出文件路径。 | ``""`` | 选填。默认输出在部署目录下，yr_agent 不需要配置。 | | `-w,--ds_worker_unique_enable` | 是否打开 ds-worker 节点唯一。 | 无参 | 选填。 | | `-p,--services_path` | 函数包 services.yaml 路径。 | ``""`` | 选填。建议配置绝对路径，并确保文件存在，否则可能无法正确加载函数元数据。 | -| `-f,--function_proxy_unique_enable` | 是否打开 function-proxy 节点唯一。 | 无参参 | 选填。 | +| `-f,--function_proxy_unique_enable` | 是否打开 function-proxy 节点唯一。 | 无参 | 选填。 | | `--master` | 启动 master 节点。 | 无参 | 必填。yr_master 启动默认加此参数。 | | `--master_info` | 控制面组件启动 IP、端口信息。 | ``""`` | 部署从节点时**必填**，部署主节点时**不填**。优先级高于直接配置 etcd_ip、master_ip 等。 | | `--master_ip` | 控制面组件 IP。 | ``""`` | 选填。若配置了 `--master`，该参数配置忽略。 | diff --git a/docs/deploy/deploy_processes/production/deploy.md b/docs/deploy/deploy_processes/production/deploy.md index 63a48c6..6592f17 100644 --- a/docs/deploy/deploy_processes/production/deploy.md +++ b/docs/deploy/deploy_processes/production/deploy.md @@ -79,7 +79,7 @@ yr start --gpu_collection_enable true --master_info "local_ip:x.x.x.x,master_ip: ```bash # master_ip 替换为每台主机的 ip，并指定每台主机使用的 etcd 端口，请确保端口不冲突 -# 例如：yr start --master --etcd_addr_list 192.168.0.1:23279:23280,192.168.0.0.2:23279:23280,192.168.0.0.3:23279:23280 +# 例如：yr start --master --etcd_addr_list 192.168.0.1:23279:23280,192.168.0.2:23279:23280,192.168.0.0.3:23279:23280 yr start --master --etcd_addr_list={master-1_ip:etcd-1_port:etcd-1_peer_port,master-2_ip:etcd-2_port:etcd-2_peer_port,master-3_ip:etcd-3_port:etcd-3_peer_port} ``` @@ -87,7 +87,7 @@ yr start --master --etcd_addr_list={master-1_ip:etcd-1_port:etcd-1_peer_port,mas ```bash # etcd_addr_list 的配置和主节点保持一致 -# 例如：yr start --etcd_addr_list 192.168.0.1:23279:23280,192.168.0.0.2:23279:23280,192.168.0.0.3:23279:23280 +# 例如：yr start --etcd_addr_list 192.168.0.1:23279:23280,192.168.0.2:23279:23280,192.168.0.0.3:23279:23280 yr start --etcd_addr_list={master-1_ip:etcd-1_port:etcd-1_peer_port,master-2_ip:etcd-2_port:etcd-2_peer_port,master-3_ip:etcd-3_port:etcd-3_peer_port} ``` @@ -99,7 +99,7 @@ yr start --etcd_addr_list={master-1_ip:etcd-1_port:etcd-1_peer_port,master-2_ip: ### 部署时配置安全通信 -openYuanrong 支持内部组件间及内部组件同三方组件 ETCD 间的加密通信。当前只支持配置明文证书秘钥，因此存在证书秘钥泄露风险。如果您有高安全的秘钥管理需求，可基于 openYuanrong 开源代码自行实现秘钥解密算法，同时配置加密的证书秘钥，其他秘钥配置也可参考该方案。 +openYuanrong 支持内部组件间及内部组件同三方组件 ETCD 间的加密通信。当前只支持配置明文证书密钥，因此存在证书密钥泄露风险。如果您有高安全的密钥管理需求，可基于 openYuanrong 开源代码自行实现密钥解密算法，同时配置加密的证书密钥，其他密钥配置也可参考该方案。 openYuanrong 默认未开启安全通信选项，如需开启请参考[安全通信](./security.md)章节生成相关证书密钥。 diff --git a/docs/deploy/deploy_processes/production/security.md b/docs/deploy/deploy_processes/production/security.md index b488687..b78ef93 100644 --- a/docs/deploy/deploy_processes/production/security.md +++ b/docs/deploy/deploy_processes/production/security.md @@ -87,7 +87,7 @@ mkdir -p ${WorkSpace}/etcd cd ${WorkSpace}/etcd openssl genrsa -out ca.key 2048 -# 证书CN 可根据实际配置修改，默认 etcd-ca。days 为证书有限期（天数），证书过期后需要重新生成。 +# 证书CN 可根据实际配置修改，默认 etcd-ca。days 为证书有效期（天数），证书过期后需要重新生成。 openssl req -x509 -new -nodes -key ca.key -subj "/CN=etcd-ca" -days 10000 -out ca.crt ``` @@ -198,7 +198,7 @@ openssl genrsa -out ca.key 2048 # subj 可根据实际配置修改。 openssl req -new -key ca.key -out ca.csr -subj "/C=CN/ST=zhejiang/L=hangzhou/O=ha/OU=Personal/CN=rootCA" -# days 为证书有限期（天数），证书过期后需要重新生成。 +# days 为证书有效期（天数），证书过期后需要重新生成。 openssl x509 -req -days 10000 -extfile ./demoCA/v3.ext -extensions v3_ca -signkey ca.key -in ca.csr -out ca.crt ``` diff --git a/docs/multi_language_function_programming_interface/api/yr_command_line_tool/yr_status.md b/docs/multi_language_function_programming_interface/api/yr_command_line_tool/yr_status.md index 9d0f441..b585964 100644 --- a/docs/multi_language_function_programming_interface/api/yr_command_line_tool/yr_status.md +++ b/docs/multi_language_function_programming_interface/api/yr_command_line_tool/yr_status.md @@ -14,7 +14,7 @@ yr status [flags] * `--etcd_endpoint`：ETCD 服务地址。使用`yr start`命令输出的`Cluster master info`信息，拼接 `{etcd_ip}:{etcd_port}`字段为"IP:Port"的形式。 * `--etcd_tls_enable`：ETCD 服务启用 TLS。若`yr start`命令参数`etcd_auth_type`不为`Noauth`，需要使用该参数。该参数无需传入值。 * `--etcd_ca_file`：ETCD 服务 CA 文件路径。启用`etcd_tls_enable`时该参数必选，参考 [部署参数表](../../../deploy/deploy_processes/parameters.md) -* `--etcd_client_key_file`：ETCD 客户端秘钥文件路径。启用`etcd_tls_enable`时该参数必选，参考 [部署参数表](../../../deploy/deploy_processes/parameters.md) +* `--etcd_client_key_file`：ETCD 客户端密钥文件路径。启用`etcd_tls_enable`时该参数必选，参考 [部署参数表](../../../deploy/deploy_processes/parameters.md) * `--etcd_client_cert_file`：ETCD 客户端证书文件路径。启用`etcd_tls_enable`时该参数必选，参考 [部署参数表](../../../deploy/deploy_processes/parameters.md) ## Example diff --git a/docs/multi_language_function_programming_interface/index.md b/docs/multi_language_function_programming_interface/index.md index d5522c6..4de5f23 100644 --- a/docs/multi_language_function_programming_interface/index.md +++ b/docs/multi_language_function_programming_interface/index.md @@ -127,7 +127,7 @@ print(yr.get(next_result_ref)) data_ref = yr.put({"key": "value"}) # Get data from object store -print(yr.get(data_ref)) # output {"key", "value"} +print(yr.get(data_ref)) # output {"key": "value"} ``` ## 下一步 -- Gitee From c339a8a01c00872168fbd930c30273e6dc942873 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E9=9B=B7=E5=8D=81=E4=B8=80?= Date: Fri, 7 Nov 2025 15:55:49 +0800 Subject: [PATCH 2/2] change1 --- .../development_guide/data_object/KV.md | 2 +- .../development_guide/data_object/index.md | 4 ++-- .../development_guide/scheduling/index.md | 2 +- .../development_guide/scheduling/logical_resource.md | 2 +- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/multi_language_function_programming_interface/development_guide/data_object/KV.md b/docs/multi_language_function_programming_interface/development_guide/data_object/KV.md index 156c164..f96ee2f 100644 --- a/docs/multi_language_function_programming_interface/development_guide/data_object/KV.md +++ b/docs/multi_language_function_programming_interface/development_guide/data_object/KV.md @@ -4,7 +4,7 @@ openYuanrong 提供了近计算 KV 缓存能力，基于共享内存实现免拷 ## 使用场景 -openYuanrong KV 接口使用近计算共享内存实现，所以数据读写时延较低，对于 MB 级以上的数据尤为明显。因此需要在函数间共享传递大块数据的场景，使用 KV 接口能取的较好的效果。 +openYuanrong KV 接口使用近计算共享内存实现，所以数据读写时延较低，对于 MB 级以上的数据尤为明显。因此需要在函数间共享传递大块数据的场景，使用 KV 接口能取得较好的效果。 ## 使用限制 diff --git a/docs/multi_language_function_programming_interface/development_guide/data_object/index.md b/docs/multi_language_function_programming_interface/development_guide/data_object/index.md index 54691c0..3b66838 100644 --- a/docs/multi_language_function_programming_interface/development_guide/data_object/index.md +++ b/docs/multi_language_function_programming_interface/development_guide/data_object/index.md @@ -252,7 +252,7 @@ int main(int argc, char *argv[]) def dis_sum(args): # dis_sum 被调用时，传入的值为 [objref1， objref2， objref3] return sum(yr.get(args)) # 调用 get 时，objref1/objref2/objref3 的值才会传输到当前机器。 - objref1 = get_num.invoke(1) # 此处返回 object ref，发出调用请求后即可返回，无需等待 get_sum 执行完成 + objref1 = get_num.invoke(1) # 此处返回 object ref，发出调用请求后即可返回，无需等待 get_num 执行完成 objref2 = get_num.invoke(2) objref3 = get_num.invoke(3) objref = yr.put([objref1, objref2, objref3]) # 嵌套传递 object ref @@ -280,7 +280,7 @@ spillDirectory: "" spillSizeLimit: "0" # 指定向磁盘写数据时的最大并行度，当磁盘性能非常高时，可尝试将该值调高提升性能。 spillThreadNum: 8 -# 指定溢出到磁盘上的单个文件大小。单位为 MB，取值范围时 200-10240。 +# 指定溢出到磁盘上的单个文件大小。单位为 MB，取值范围：200-10240。 # 当对象较小时，多个对象合并写入到一个文件中。当对象很大且超出该值时，每个文件一个对象。 spillFileMaxSizeMb: 200 # 用于指定对象溢出最大打开的文件句柄数。当该值被调小时，可能会降低性能。 diff --git a/docs/multi_language_function_programming_interface/development_guide/scheduling/index.md b/docs/multi_language_function_programming_interface/development_guide/scheduling/index.md index 1ab5358..7b05a31 100644 --- a/docs/multi_language_function_programming_interface/development_guide/scheduling/index.md +++ b/docs/multi_language_function_programming_interface/development_guide/scheduling/index.md @@ -41,6 +41,6 @@ openYuanrong 会基于以下调度策略选择最佳的节点运行 openYuanrong ### 亲和 -您可通过在节点或者 openYuanrong 函数上设置标签，实现新调度的 openYuanrong 函数部署在特点标签的节点上，或者和特定标签的 openYuanrong 函数部署在相同的节点上。通过亲和，您可以自定义策略实现更灵活的调度满足业务需要。 +您可通过在节点或者 openYuanrong 函数上设置标签，实现新调度的 openYuanrong 函数部署在特定标签的节点上，或者和特定标签的 openYuanrong 函数部署在相同的节点上。通过亲和，您可以自定义策略实现更灵活的调度满足业务需要。 参考[亲和](./affinity.md)章节了解如何配置 openYuanrong 函数亲和属性。 diff --git a/docs/multi_language_function_programming_interface/development_guide/scheduling/logical_resource.md b/docs/multi_language_function_programming_interface/development_guide/scheduling/logical_resource.md index acccb56..081a03f 100644 --- a/docs/multi_language_function_programming_interface/development_guide/scheduling/logical_resource.md +++ b/docs/multi_language_function_programming_interface/development_guide/scheduling/logical_resource.md @@ -41,7 +41,7 @@ yr.init() # 配置运行无状态函数需要 1 核 CPU，1G 内存，1 个 ssd 自定义资源，1 张任意型号的 NPU 卡，1 张任意型号的 GPU 卡 opt = yr.InvokeOptions(cpu=1000, memory=1024) -opt.custom_resource={"ssd":1,"NPU/.+/count":1,"GPU/.+/count":1} +opt.custom_resources={"ssd":1,"NPU/.+/count":1,"GPU/.+/count":1} result = add.options(opt).invoke(1) print(yr.get(result)) -- Gitee