diff --git a/README.md b/README.md index 53e64d6..5db34a1 100644 --- a/README.md +++ b/README.md @@ -1,31 +1,31 @@ -# octo-ns +# OCTONS ## 背景及概念 - octo-ns - 是美团octo服务治理体系中负责命名服务的系列模块，包括[c++ sdk](sdk/mns-sdk/docs/mns_sdk_api.md)、[java - sdk](sdk/mns-invoker)、 - [基础代理sgagent](sg_agent)、[命名服务缓存nsc](nsc)、[健康检查服务scanner](scanner)、[zookeeper](https://zookeeper.apache.org/) - ，搭配管理平台 [octo-portal](https://github.com/Meituan-Dianping/octo-portal) 用户能够便捷的进行服务运营交互。 + OCTONS + 是美团OCTO服务治理体系中负责命名服务的系列模块，包括[C++ SDK](sdk/mns-sdk/docs/mns_sdk_api.md)、[Java + SDK](sdk/mns-invoker)、 + [基础代理SGAgent](sg_agent)、[命名服务缓存NSC](nsc)、[健康检查服务Scanner](scanner)、[ZooKeeper](https://zookeeper.apache.org/) + ，搭配管理平台 [OCTOPortal](https://github.com/Meituan-Dianping/octo-portal) 用户能够便捷的进行服务运营交互。 - octo-ns - 基于服务描述信息（tags+weight）实现服务注册/发现、路由分组、负载均衡、健康检测等功能，利用这些服务治理功能用户可以专注于业务逻辑开发、能够追踪线上服务状态、快速处置异常风险。octo-ns提升了业务对于服务的运营能力，其总体架构图如下: + OCTONS + 基于服务描述信息（tags+weight）实现服务注册/发现、路由分组、负载均衡、健康检测等功能，利用这些服务治理功能用户可以专注于业务逻辑开发、能够追踪线上服务状态、快速处置异常风险。OCTONS提升了业务对于服务的运营能力，其总体架构图如下: -
+
-* 服务service +* 服务Service - 通过自定义接口提供给消费端的软件功能，octo目前支持rpc、http服务。 + 通过自定义接口提供给消费端的软件功能，OCTO目前支持RPC、HTTP服务。 -* 服务名 servicename +* 服务名 ServiceName - 服务标识，可映射到指定服务；octo体系中通过appkey字段表示服务名。 + 服务标识，可映射到指定服务；OCTO体系中通过AppKey字段表示服务名。 -* 服务提供者 service provider +* 服务提供者 Service Provider 是指提供服务的被调用一方。 -* 服务消费者 service consumer +* 服务消费者 Service Consumer 是指发起对某个服务调用的一方。 @@ -33,11 +33,11 @@ 注册中心存储服务描述信息用以实现命名服务整个功能。服务在启动时将服务信息上报到注册中心，服务消费者从注册中心获取对应的服务提供者信息。健康检查组件会根据对服务节点的检测结果更新注册中心服务状态信息。 -* 服务注册(service registry) +* 服务注册(Service Registry) 服务提供者启用后向注册中心上报服务信息的流程。 -* 服务发现(service discovery) +* 服务发现(Service Discovery) 服务消费者获取服务提供者信息的流程。 @@ -45,53 +45,53 @@ 浮点数，是负载均衡抉择服务端流量配比的重要指标；业务和路由规则会对权重进行调整。 -* 服务分组(service group) +* 服务分组(Service Group) 是业务自定义的服务提供者和服务消费者之间的调用约束关系。 -* 健康检查(health check) +* 健康检查(Health Check) - 服务节点的端口/进程存活状态的检查。octo-ns体系中通过scanner执行健康扫描，并更新服务描述信息到注册中心。 + 服务节点的端口/进程存活状态的检查。OCTONS体系中通过Scanner执行健康扫描，并更新服务描述信息到注册中心。 ## 架构特点 * 模块解耦功能拆分 - 通信框架(c++版本whale、java版本dorado)、服务治理代理(sgagent)、健康检查服务(scanner)、服务治理平台(octo-portal)。 + 通信框架(C++版本whale、Java版本Dorado)、服务治理代理(SGAgent)、健康检查服务(Scanner)、服务治理平台(OCTOPortal)。 * 代理模式轻量化框架 - 服务治理策略实现下移到代理组件sgagent，精简框架功能，提升框架稳定性。 + 服务治理策略实现下移到代理组件SGAgent，精简框架功能，提升框架稳定性。 -
+
-* 水平扩展的代理模块(sgagent) - 如上所述，sgagent实现了服务治理如注册、发现、路由、策略等重要功能，简化服务消费者和服务提供者使用的通信框架。 +* 水平扩展的代理模块(SGAgent) + 如上所述，SGAgent实现了服务治理如注册、发现、路由、策略等重要功能，简化服务消费者和服务提供者使用的通信框架。 - 服务治理代理从部署上分为本地和哨兵模式两种，当本地sdk到sgagent不可用时可切换到哨兵集群，保证服务平滑扩展。 + 服务治理代理从部署上分为本地和哨兵模式两种，当本地SDK到SGAgent不可用时可切换到哨兵集群，保证服务平滑扩展。 -* 统一服务状态检查服务(scanner) +* 统一服务状态检查服务(Scanner) - scanner以周期扫描形式对服务进行探活检测，并更新服务状态到注册中心。 + Scanner以周期扫描形式对服务进行探活检测，并更新服务状态到注册中心。 * 高可用 - 调用链容灾：octo-ns各组件的本地缓存机制，提升了整体系统的容灾能力。链路中后台的某个组件发生故障时，可以使用缓存正常提供服务治理功能。 + 调用链容灾：OCTONS各组件的本地缓存机制，提升了整体系统的容灾能力。链路中后台的某个组件发生故障时，可以使用缓存正常提供服务治理功能。 - 哨兵模式：本地sgagent不可用时，降级（fallback）到哨兵集群进行服务治理。 + 哨兵模式：本地SGAgent不可用时，降级（FallBack）到哨兵集群进行服务治理。 ## 架构介绍 -
- octo-ns由sdk、sgagent、nsc、scanner和zookeeper组成，使用octo-portal管理端实现可视化服务营运操作，例如更改服务提供者状态、调整权重。服务提供者启动后，通信框架主动发起注册操作，上报服务描述信息接入octo-ns。接下来分模块对octo-ns进行介绍。 +
+ OCTONS由sdk、SGAgent、NSC、Scanner和ZooKeeper组成，使用OCTOPortal管理端实现可视化服务营运操作，例如更改服务提供者状态、调整权重。服务提供者启动后，通信框架主动发起注册操作，上报服务描述信息接入OCTONS。接下来分模块对OCTONS进行介绍。 -### 服务治理代理sgagent +### 服务治理代理SGAgent - **服务注册/发现**：这是命名服务的基本功能，注册是提供者上报服务描述信息；发现是消费者根据appkey获取对应服务描述信息。分为增量和通用两种方式，通用方式是指添加provider的服务描述信息到对应appkey下面，为服务列表增加新的成员；增量方式是指一个包含多种servicename接口类型的apppkey，通过在注册中心建立servicename和appkey的双向映射，可实现servicename粒度的服务注册/发现功能。 + **服务注册/发现**：这是命名服务的基本功能，注册是提供者上报服务描述信息；发现是消费者根据AppKey获取对应服务描述信息。分为增量和通用两种方式，通用方式是指添加Provider的服务描述信息到对应AppKey下面，为服务列表增加新的成员；增量方式是指一个包含多种ServiceName接口类型的AppKey，通过在注册中心建立ServiceName和AppKey的双向映射，可实现ServiceName粒度的服务注册/发现功能。 - **服务分组**：根据分组信息，sgagent调整服务节点权重，定制化流量负载。用户可根据需求自定义分组规则，服务分组需要进行事先配置，启动后方能生效。不同分组规则根据优先级排序，优先级高者生效。执行服务分组规则时，对于服务列表中匹配失败的节点进行降权处理，流量极低概率进入降权后的节点（未来管理页面将提供可选按钮，决定降权还是删除规则外服务节点）。目前支持的服务分组策略如下： + **服务分组**：根据分组信息，SGAgent调整服务节点权重，定制化流量负载。用户可根据需求自定义分组规则，服务分组需要进行事先配置，启动后方能生效。不同分组规则根据优先级排序，优先级高者生效。执行服务分组规则时，对于服务列表中匹配失败的节点进行降权处理，流量极低概率进入降权后的节点（未来管理页面将提供可选按钮，决定降权还是删除规则外服务节点）。目前支持的服务分组策略如下： a.自定义路由分组：在服务端配置该策略后，可定向指定上游打入下游规则范围内的服务节点 @@ -103,30 +103,30 @@ **标签隔离**：依据服务节点中标识的不同标签，实现灵活的流量和链路隔离。服务注册时在服务描述信息中携带标签信息，服务发现时过滤服务列表中持有标签的服务提供者。例如：用以隔离测试的泳道标签，用以单元化部署和灰度链路的单元化标签。 -### 缓存服务nsc +### 缓存服务NSC - 缓存注册到octo-ns的服务描述信息，一方面提供批量服务数据缓存与预处理功能，提升服务发现性能；另一方面增强服务治理链路的容灾能力，本地sgagent不可用的场景下该模块通过http形式提供远程哨兵服务列表。 -### 服务健康scanner + 缓存注册到OCTONS的服务描述信息，一方面提供批量服务数据缓存与预处理功能，提升服务发现性能；另一方面增强服务治理链路的容灾能力，本地SGAgent不可用的场景下该模块通过HTTP形式提供远程哨兵服务列表。 +### 服务健康Scanner - 健康检查模块负责实时检查注册中心的服务提供者健康状况，一旦发现服务提供者不可用就将其置为未启动状态，及时摘除流量；当服务提供者恢复正常时，scanner会及时将服务提供者的状态置为正常状态，恢复流量。服务整个生命周期内，octo-ns利用scanner实现自动化的流量摘除和恢复，无需业务手动介入。为了提高检查的准确性，scanner支持octo自定义的心跳协议来进行应用层检查，octo体系内的通信框架默认支持，无需额外配置。 + 健康检查模块负责实时检查注册中心的服务提供者健康状况，一旦发现服务提供者不可用就将其置为未启动状态，及时摘除流量；当服务提供者恢复正常时，Scanner会及时将服务提供者的状态置为正常状态，恢复流量。服务整个生命周期内，OCTO-NS利用Scanner实现自动化的流量摘除和恢复，无需业务手动介入。为了提高检查的准确性，Scanner支持OCTO自定义的心跳协议来进行应用层检查，OCTO体系内的通信框架默认支持，无需额外配置。 ### 功能流程 * 服务注册 - 业务进程启动后，通信框架发起服务注册，依赖sgagent上报服务描述信息到注册中心。本地sgagent失效时，sdk通过nsc服务获取远程sgagent哨兵机器列表信息，注册请求fallback到哨兵集群完成整个流程。服务提供者服务描述信息数据存入注册中心后，可从octo-portal管理页面进行查阅和修改。 + 业务进程启动后，通信框架发起服务注册，依赖SGAgent上报服务描述信息到注册中心。本地SGAgent失效时，SDK通过NSC服务获取远程SGAgent哨兵机器列表信息，注册请求FallBack到哨兵集群完成整个流程。服务提供者服务描述信息数据存入注册中心后，可从OCTOPortal管理页面进行查阅和修改。
* 服务发现 - octo-ns支持基于http和rpc的服务发现，服务消费者可通过调用sgagent服务发现接口获取服务提供者列表。sgagent会优先从nsc - 进行服务发现，从nsc服务发现失败时会降级从zookeeper获取服务提供者数据。 + OCTONS支持基于HTTP和RPC的服务发现，服务消费者可通过调用SGAgent服务发现接口获取服务提供者列表。SGAgent会优先从NSC + 进行服务发现，从NSC服务发现失败时会降级从ZooKeeper获取服务提供者数据。 * 健康检查 - scanner运行时会不断扫描注册中心的服务节点，依次检查每个服务提供者状态情况，按需修改服务描述信息。 + Scanner运行时会不断扫描注册中心的服务节点，依次检查每个服务提供者状态情况，按需修改服务描述信息。
@@ -137,8 +137,8 @@ ## 未来规划 -* 注册中心ap化：将注册中心从目前基于zookeeper的cp系统演进为ap系统，在保证最终一致性的前提下以可用性为优先目标。 -* service mesh：sgagent借鉴时下盛行的mesh理念，进一步简化通信框架和SDK功能逻辑。 +* 注册中心AP化：将注册中心从目前基于ZooKeeper的CP系统演进为AP系统，在保证最终一致性的前提下以可用性为优先目标。 +* Service Mesh：SGAgent借鉴时下盛行的Mesh理念，进一步简化通信框架和SDK功能逻辑。 diff --git a/docs/image/ns.png b/docs/image/ns.png new file mode 100644 index 0000000..62e015a Binary files /dev/null and b/docs/image/ns.png differ diff --git a/docs/image/ns.svg b/docs/image/ns.svg deleted file mode 100644 index ab93faa..0000000 --- a/docs/image/ns.svg +++ /dev/null @@ -1 +0,0 @@ -
health check(scanner)
   local/sentinel(sgagent)
naming service cache(nsc)
zookeeper
openapi(rpc/http)
 \ No newline at end of file diff --git a/docs/image/ns_components.png b/docs/image/ns_components.png new file mode 100644 index 0000000..d35b63a Binary files /dev/null and b/docs/image/ns_components.png differ diff --git a/docs/image/ns_components.svg b/docs/image/ns_components.svg deleted file mode 100644 index ea9fd29..0000000 --- a/docs/image/ns_components.svg +++ /dev/null @@ -1 +0,0 @@ -
service provider instance
transport
sdk
service
service consumer instance
transport
sdk
service
sgagent
sgagent
nsc
scanner
管理端
sentienl
local
Zookeeper
zookeeper
rpc call
 \ No newline at end of file diff --git a/docs/image/ns_trait.png b/docs/image/ns_trait.png new file mode 100644 index 0000000..5d9f74a Binary files /dev/null and b/docs/image/ns_trait.png differ diff --git a/docs/image/ns_trait.svg b/docs/image/ns_trait.svg deleted file mode 100644 index 6c086b8..0000000 --- a/docs/image/ns_trait.svg +++ /dev/null @@ -1,2 +0,0 @@ - -
  octo/thrift
[Not supported by viewer]
octo/http
[Not supported by viewer]
     ......
[Not supported by viewer]
服务治理代理sgagent
<font style="font-size: 20px">服务治理代理sgagent</font>
服务发现
[Not supported by viewer]
服务注册
[Not supported by viewer]
节点标签
[Not supported by viewer]
服务分组
[Not supported by viewer]
哨兵模式
[Not supported by viewer]
......
[Not supported by viewer]
服务
注册
[Not supported by viewer]
service provider
service provider
service provider
service provider
service provider
service provider
octo/thrift
[Not supported by viewer]
octo/http
[Not supported by viewer]
     ......
[Not supported by viewer]
service consumer
service&nbsp;consumer
service consumer
service&nbsp;consumer
service consumer
service&nbsp;consumer
服务
发现
[Not supported by viewer] \ No newline at end of file diff --git a/docs/zookeeper_data_build.md b/docs/zookeeper_data_build.md index d6998b0..1624b57 100644 --- a/docs/zookeeper_data_build.md +++ b/docs/zookeeper_data_build.md @@ -1,11 +1,11 @@ -## zookeeper数据初始化 +## ZooKeeper数据初始化 - 由于NSC服务启用依赖zookeeper数据的path路径，快速构建可使用zookeeper自带的zkCli.sh脚本进入zookeeper操作控制台操作,也可使用第三方脚本自行创建如python，其自带了zkclient包，便于操作. + 由于NSC服务启用依赖ZooKeeper数据的path路径，快速构建可使用ZooKeeper自带的zkCli.sh脚本进入ZooKeeper操作控制台操作,也可使用第三方脚本自行创建如Python，其自带了ZkClient包，便于操作. 以下给出第一种简单操作方式. -### 使用zkClie.sh创建数据 +### 使用zkCli.sh创建数据 --- -切换至zookeeper安装的bin文件目录 +切换至ZooKeeper安装的bin文件目录 ~~~ cd [dirName] //dirName为zookeeper的bin目录 @@ -23,7 +23,7 @@ create /octo/nameservice/stage "stage dir" create /octo/nameservice/prod "prod dir" ~~~ -创建servicename环境test、stage、prod路径 +创建ServiceName环境test、stage、prod路径 ~~~ cd [dirName] //dirName为zookeeper的bin目录 @@ -36,7 +36,7 @@ create /octo/service/prod "prod dir" ~~~ ### 数据导入 -将项目中自带的快照数据导入到安装的zookeeper数据路径 +将项目中自带的快照数据导入到安装的ZooKeeper数据路径 ~~~ scp octo-ns/conf/snapshot [dirName] diff --git a/nsc/README.md b/nsc/README.md index f7570e9..6743deb 100644 --- a/nsc/README.md +++ b/nsc/README.md @@ -1,29 +1,29 @@ -# nsc 介绍 +# NSC 介绍 ## 背景描述 -nsc 是 octo 服务治理体系内的缓存服务数据子系统. +NSC 是 OCTO 服务治理体系内的缓存服务数据子系统. 开发语言: Java -运行环境要求: JDK 1.8及以上、maven3、zookeeper +运行环境要求: JDK 1.8及以上、Maven3、ZooKeeper 组件依赖: [Dorado](https://github.com/Meituan-Dianping/octo-rpc/tree/master/dorado) 主要功能点: -1. 缓存服务注册信息，为octo组件提供批量获取服务列表功能 -2. 提供sgagent哨兵列表，本地sg不可用时，业务服务fallback到哨兵服务，保证octo健壮性 +1. 缓存服务注册信息，为OCTO组件提供批量获取服务列表功能 +2. 提供SGAgent哨兵列表，本地SGAgent不可用时，业务服务FallBack到哨兵服务，保证OCTO健壮性 ## 实现细节 ### 数据同步机制 -被动notify + push的机制保障数据实效性；周期性的pull同步模式，确保数据完整性。 +被动Notify + Push的机制保障数据实效性；周期性的Pull同步模式，确保数据完整性。 ### 异步模式 -采用异步模式处理watcher触发后的逻辑，避免同步模式下大量watcher阻塞执行，排队耗费大量等待时间。 +采用异步模式处理Watcher触发后的逻辑，避免同步模式下大量Watcher阻塞执行，排队耗费大量等待时间。 ### 过滤zk事件 -网络抖动时，产生的网络事件会导致zk-client进行watcher实例重复注册；频繁网络抖动可能导致进程OOM。 +网络抖动时，产生的网络事件会导致ZkClient进行Watcher实例重复注册；频繁网络抖动可能导致进程OOM。 ### 队列分离 分队列处理不同优先级任务，保证核心任务快速响应 @@ -38,7 +38,7 @@ nsc 是 octo 服务治理体系内的缓存服务数据子系统. -### 打包运行nsc +### 打包运行NSC ```bash diff --git a/scanner/README.md b/scanner/README.md index e673822..8ee5400 100644 --- a/scanner/README.md +++ b/scanner/README.md @@ -1,11 +1,11 @@ -# OCTO Scanner 介绍 +# OCTOScanner 介绍 ## 背景描述 Scaner 是 OCTO 服务治理体系内的一个独立的服务健康检查子系统. 开发语言: Java -运行环境要求: JDK 1.8及以上、maven3、zookeeper +运行环境要求: JDK 1.8及以上、Maven3、ZooKeeper 组件依赖: [Dorado](https://github.com/Meituan-Dianping/octo-rpc/tree/master/dorado) @@ -36,7 +36,7 @@ Scanner的扫描线程分为两类，正常节点和异常节点分为两个线 ![状态转换图](./docs/img/providerstatus.png) ## 快速上手 -### 编译安装dorado到本地maven仓库 +### 编译安装Dorado到本地Maven仓库 参考[Dorado 源码编译说明](https://github.com/Meituan-Dianping/octo-rpc/blob/master/dorado/dorado-doc/manual-developer/Compile.md) ### 打包运行Scanner diff --git a/sdk/mns-invoker/README.md b/sdk/mns-invoker/README.md index b6826c0..e4e2274 100644 --- a/sdk/mns-invoker/README.md +++ b/sdk/mns-invoker/README.md @@ -1,10 +1,10 @@ # 1 概述说明 -Mns-Invoker是OCTO-NS的轻量级SDK，提供服务注册与注销，服务发现，基础工具类等功能。 +MnsInvoker是OCTONS的轻量级SDK，提供服务注册与注销，服务发现，基础工具类等功能。 # 2 服务注册和发现 ## 2.1 服务注册 ### 描述 -用于注册thrift和http协议的服务节点 +用于注册Thrift和HTTP协议的服务节点 ``` public static void registServiceWithCmd(int uptCmd, SGService sgService) throws TException @@ -49,7 +49,7 @@ private static SGService getDefaultSGService(final String appkey, final int port ``` ## 2.2 服务注销 ### 描述 -用于注销thrift和http协议的服务节点 +用于注销Thrift和HTTP协议的服务节点 ``` public static void unRegisterService(SGService sgService) throws TException @@ -152,7 +152,7 @@ int | 成功返回0，失败返回-1 【NOTE】 * SGService里面的appkey，ip，envir，port，protocol字段一般不会有改变，以下字段的变更会触发modifiedList：status,weight,fweight,version,role,serviceInfo -* mns-invoker对于所有的服务列表监听器只起了一个线程去触发回调callback，因此，强烈建议用户不要在监听器的chaned()方法中做有阻塞的操作，否则会阻塞所有的监听器。 +* MnsInvoker对于所有的服务列表监听器只起了一个线程去触发回调callback，因此，强烈建议用户不要在监听器的chaned()方法中做有阻塞的操作，否则会阻塞所有的监听器。 * 可以对同一份服务列表添加多个监听器，但监听器必须是不同的（hashCode不同）。 * 强烈建议用户不要自行修改ProtocolRequest和IServiceListChangeListener的hashCode和equals方法。 @@ -259,7 +259,7 @@ public static boolean isLocalHostOnline() 参数类型 | 描述 ------------- | ------------ boolean | true为线上环境，即prod或stage，其他dev、ppe、test均为线下环境 -## 4.6 查询Mns的zookeeper地址 +## 4.6 查询MNS的ZooKeeper地址 ### 描述 查询本机octo.cfg配置文件里面记录的服务注册中心mns的zookeeper地址 @@ -271,7 +271,7 @@ public static String getMnsZKUrl() 参数类型 | 描述 ------------- | ------------ String | ip:port连接的字符串，如配置文件不存在返回null。 -## 4.7 查询Mnsc服务的域名 +## 4.7 查询MNSC服务的域名 ### 描述 查询本机octo.cfg配置文件记录的mnsc服务域名 @@ -283,7 +283,7 @@ public static String getMnsZKUrl() ------------- | ------------ String | 以http://开头的域名，如配置文件不存在返回null。 -## 4.8 查询idc文件的存储目录 +## 4.8 查询IDC文件的存储目录 ### 描述 查询本机octo.cfg配置文件记录的idc文件位置 @@ -295,7 +295,7 @@ public static String getIdcPath() ------------- | ------------ String | idc文件所在位置，如配置文件不存在返回null。 -## 4.9 查询sg_agent代理的端口号 +## 4.9 查询SGAgent代理的端口号 ### 描述 查询本机octo.cfg配置文件记录的sg_agent端口号 @@ -306,7 +306,7 @@ public static int getSgagentPort() 参数类型 | 描述 ------------- | ------------ int | 端口号 -## 4.10 查询sg_agent代理的appkey +## 4.10 查询SGAgent代理的AppKey ### 描述 查询本机octo.cfg配置文件记录的sg_agent的appkey diff --git a/sdk/mns-invoker/docs/Compile.md b/sdk/mns-invoker/docs/Compile.md index 185df78..effd2ba 100644 --- a/sdk/mns-invoker/docs/Compile.md +++ b/sdk/mns-invoker/docs/Compile.md @@ -1,5 +1,5 @@ -# mns-invoker 源码编译说明 +# MnsInvoker 源码编译说明 ## 1.下载工程 ``` diff --git a/sdk/mns-sdk/ReadMe.md b/sdk/mns-sdk/ReadMe.md index 14cd4e7..9fc9d6c 100644 --- a/sdk/mns-sdk/ReadMe.md +++ b/sdk/mns-sdk/ReadMe.md @@ -1,8 +1,8 @@ # 构建 -mns-sdk 以静态链接方式编译 +MnsSDK 以静态链接方式编译 -mns-sdk 依赖下列组件: +MnsSDK 依赖下列组件: * [muduo](https://github.com/chenshuo/muduo): 网络工具库 * [boost](https://github.com/boostorg/boost): 基础的C++工具库 @@ -53,11 +53,11 @@ CentOS通常需要安装EPEL，否则许多软件包默认不可用： thrift一般很少有yum源，请自行参照官方使用文档安装 ``` -安装 [octo-mns](): -[参照octo-mns文档安装环境](./../../docs/ns-quick-start.md) +安装 [OCTONS](): +[参照OCTONS文档安装环境](./../../docs/ns-quick-start.md) -### 使用 build.sh 编译 mns-sdk +### 使用 build.sh 编译 MnsSDK ```bash > git clone https://github.com/Meituan-Dianping/octo-ns.git ``` diff --git a/sdk/mns-sdk/docs/mns_sdk_api.md b/sdk/mns-sdk/docs/mns_sdk_api.md index db1a644..1fa5112 100644 --- a/sdk/mns-sdk/docs/mns_sdk_api.md +++ b/sdk/mns-sdk/docs/mns_sdk_api.md @@ -1,8 +1,8 @@ # 1 概述说明 -mns-sdk是octo-ns的c++侧轻量级sdk，提供服务注册与注销，服务发现，基础工具类等功能。 +MnsSDK是OCTONS的C++侧轻量级SDK，提供服务注册与注销，服务发现，基础工具类等功能。 # 2 服务注册和发现 ## 2.1 初始化 -进行sdk的初始化。 +进行SDK的初始化。 ``` ／* @@ -16,7 +16,7 @@ int InitMNS(const std::string &mns_path, const double &sec, ``` ## 2.2 服务注册 ### 描述 -用于注册thrift 或 http协议的服务节点。 +用于注册Thrift 或 HTTP协议的服务节点。 ``` ／* @@ -50,7 +50,7 @@ int8_t StartSvr(const std::string &str_appkey, ``` ### 请求示例 -注册一个appkey名称为"com.test.appkey"，端口号是16888，server type是0（thrift），协议类型为thrift。 +注册一个AppKey名称为"com.test.appkey"，端口号是16888，server type是0（thrift），协议类型为thrift。 ``` const std::string appkey = "com.test.appkey"； @@ -149,7 +149,7 @@ int8_t AddUpdateSvrListCallback(const std::string &str_svr_appkey, std::string *p_err_info); ~~~ ### 请求示例 -注册一个appkey名称为"com.test.appkey"，端口号是16888，server type是0（thrift），协议类型为thrift。 +注册一个AppKey名称为"com.test.appkey"，端口号是16888，server type是0（thrift），协议类型为thrift。 ``` void JobList(const vector &vec_add, @@ -179,7 +179,7 @@ int8_t AddUpdateSvrListCallback(const std::string &str_svr_appkey, ### NOTE > - SGService里面的appkey，ip，envir，port，protocol字段一般不会有改变，以下字段的变更会触发modifiedList：status，weight，fweight，version，role，serviceInfo。 -> - mns-sdk对于所有的服务列表监听器只起了一个线程去触发回调callback，因此，强烈建议用户不要在监听器的chaned()方法中做有阻塞的操作，否则会阻塞所有的监听器。 +> - MnsSDK对于所有的服务列表监听器只起了一个线程去触发回调CallBack，因此，强烈建议用户不要在监听器的chaned()方法中做有阻塞的操作，否则会阻塞所有的监听器。 > - 可以对同一份服务列表添加多个监听器。 diff --git a/sg_agent/conf/README.md b/sg_agent/conf/README.md index 45244df..12ade9c 100644 --- a/sg_agent/conf/README.md +++ b/sg_agent/conf/README.md @@ -2,7 +2,7 @@ #### conf.json - * SG_Agent使用Cthrift作为rpc server，该配置型定义了使用Cthrift Server时的配置. + * SGAgent使用Cthrift作为rpc server，该配置型定义了使用Cthrift Server时的配置. * 参数介绍 参数名 | 参数类型 | 描述