docs:更新文档中的错误描述信息 (#382)

polarismesh · Jan 11, 2024 · 06065a7 · 06065a7
1 parent f0fdff7
commit 06065a7
Show file tree

Hide file tree

Showing 5 changed files with 71 additions and 27 deletions.
diff --git a/content/zh-cn/docs/使用指南/k8s和网格代理/Envoy网格接入.md b/content/zh-cn/docs/使用指南/k8s和网格代理/Envoy网格接入.md
@@ -10,7 +10,7 @@ weight: 4
 
 - 服务数据同步：`polaris-controller` 安装在用户的Kubernetes集群中，可以同步集群上的 Namespace，Service，Endpoints 等资源到 `polaris` 中，同时 `polaris-controller` 提供了 `Envoy Sidecar` 注入器功能，可以轻松地将 `Envoy Sidecar` 注入到您的 Kubernetes Pod 中，Envoy Sidecar 会自动去 Polaris 同步服务信息。
 
-- 规则数据下发：```polaris```控制面通过XDS v3标准协议与envoy进行交互，支持官方开源的envoy直接接入，当前支持的envoy版本为1.18
+- 规则数据下发：```polaris```控制面通过XDS v3标准协议与 envoy 进行交互，支持官方开源的 envoy 直接接入，当前支持的 envoy 版本为 1.26.2
 
 ## 环境准备
 
@@ -82,9 +82,9 @@ metadata:
 
 - 查看容器注入是否注入成功
 
-启动自动注入后，`polaris-controller` 会将 `Envoy Sidecar` 容器注入到在此命名空间下创建的 pod 中。
+启动自动注入后，`polaris-controller` 会将 `Envoy Sidecar`、`Polaris Sidecar` 容器注入到在此命名空间下创建的 pod 中。
 
-可以看到运行起来的 pod 均包含两个容器，其中第一个容器是用户的业务容器，第二个容器是由 Polaris Controller 注入器注入的 Envoy Sidecar 容器。您可以通过下面的命令来获取有关 pod 的更多信息：
+可以看到运行起来的 pod 均包含三个容器，其中第一个容器是用户的业务容器，另外两个容器是由 Polaris Controller 注入器注入的 Envoy Sidecar 容器和 Polaris Sidecar 容器。您可以通过下面的命令来获取有关 pod 的更多信息：
 
 ```
 kubectl describe pods -l app=productpage --namespace=bookinfo
@@ -152,7 +152,7 @@ demo 项目中，productpage 会访问 reviews 服务，reviews 服务共有三
 
 ![](../images/envoy/分布式限流.png)
 
-1. 使用场景: demo项目中，为details服务设置流量限制，对于jason用户的请求，设置访问的频率为5/m，其余请求不做限制。
+1. 使用场景: demo项目中，为 detail 服务设置流量限制，对于jason用户的请求，设置访问的频率为5/m，其余请求不做限制。
 
 2. 设置限流规则: 指定请求中 header 包含字段 end-user=jason 的请求，设置限流规则为5/m，限流类型为分布式限流。
 
@@ -162,7 +162,7 @@ demo 项目中，productpage 会访问 reviews 服务，reviews 服务共有三
     详细的限流规则匹配及使用指南可参考：[访问限流](/docs/使用指南/控制台使用/服务网格/访问限流/)
     {{< /note >}}
 
-3. 验证限流是否生效: 未登陆时，多次刷新界面，不会出现错误。以jason用户身份登陆，一分钟刷新超过5次，details界面出现限流的错误信息。
+3. 验证限流是否生效: 未登陆时，多次刷新界面，不会出现错误。以jason用户身份登陆，一分钟刷新超过5次，detail 界面出现限流的错误信息。
 
 
 ## mTLS
@@ -203,12 +203,12 @@ mTLS版bookinfo在配置文件中使用`polarismesh.cn/tls-mode`的`label`为不
 由于`Reviews V3`服务使用了None模式，它将向`Ratings`服务发起纯文本请求，而`Ratings`服务使用了Strict模式，仅接受mTLS服务调用，因此`Reviews V3`到`Ratings`之间的服务调用总会失败。  
 因此，使用浏览器访问部署好的`ProductPage`，无论怎么刷新都无法看到红色的星星评级。
 
-2. mTLS验证
-使用Wireshark抓包验证mTLS启用,如下图：
+2. mTLS 验证
+使用 Wireshark 抓包验证 mTLS 启用,如下图：
 
 ![](../images/envoy/wireshark.png)
 
-可以看到Server向Client提供证书后，要求Client提供自身证书，验证通过后方可开始加密数据通信。
+可以看到 Server 向 Client 提供证书后，要求 Client 提供自身证书，验证通过后方可开始加密数据通信。
 
 
 ## 相关链接

diff --git a/content/zh-cn/docs/使用指南/服务端安装/单机版安装.md b/content/zh-cn/docs/使用指南/服务端安装/单机版安装.md
@@ -17,10 +17,20 @@ weight: 1
 
 单机版默认占用以下端口：
 
-- polaris-console：8080(http/tcp)
-- polaris-server：8090(http/tcp，注册中心端口)、8091(grpc/tcp，注册中心端口)、8093(grpc/tcp，配置中心端口)
-- polaris-limiter：8101(grpc/tcp)、8100(http/tcp)
-- prometheus：9090(http/tcp)、9091(http/tcp)
+## 服务端监听端口信息
+
+| 进程名          | 端口号 | 协议类型 | 用途                                     |
+|:----------------|:-------|:---------|:---------------------------------------|
+| polaris-console | 8080   | http     | 北极星控制台页面端口                     |
+| polaris-limiter | 8100   | http     | 限流可用配额下发客户端数据通信           |
+| polaris-limiter | 8101   | grpc     | 限流可用配额下发客户端数据通信           |
+| polaris-server  | 8090   | http     | OpenAPI，可以调用注册、配置、治理规则的接口 |
+| polaris-server  | 8761   | http     | eureka 协议通信                          |
+| polaris-server  | 8848   | http     | nacos1.x 协议通信                        |
+| polaris-server  | 9848   | grpc     | nacos2.x 协议通信                        |
+| polaris-server  | 8091   | grpc     | 注册发现/服务治理规则下发客户端数据通信  |
+| polaris-server  | 8093   | grpc     | 配置中心客户端数据通信                   |
+| polaris-server  | 15010  | grpc     | xds 数据通信端口                         |
 
 ## 下载软件包
 
@@ -31,7 +41,6 @@ weight: 1
 执行所有安装之前，需要下载软件包，可以从以下2个地址下载单机版软件包，请选择最新的release版本：
 
 - Github下载：[polaris standalone releases](https://github.com/polarismesh/polaris/releases)
-- Gitee下载：[polaris standalone releases](https://gitee.com/polarismesh/polaris/releases)
 
 下载后需要进行解压，如果有需要自定义单机版相关组件的监听端口，需修改压缩包内的**port.properties**文件。
 
@@ -47,6 +56,7 @@ polaris_xdsv3_port=15010
 polaris_console_port=8080
 prometheus_port=9090
 pushgateway_port=9091
+nacos_http_port=8848
 ```
 
 ## 使用 Linux 安装
@@ -117,6 +127,8 @@ docker run -d --privileged=true \
 -p 8091:8091 \
 -p 8093:8093 \
 -p 8761:8761 \
+-p 8848:8848 \
+-p 9848:9848 \
 -p 9090:9090 \
 -p 9091:9091 polarismesh/polaris-standalone:latest
 ```

diff --git a/content/zh-cn/docs/使用指南/服务端安装/集群版安装.md b/content/zh-cn/docs/使用指南/服务端安装/集群版安装.md
@@ -17,16 +17,18 @@ weight: 2
 
 ## 服务端监听端口信息
 
-| 进程名          | 端口号 | 协议类型 | 用途                                    |
-|:----------------|:-------|:---------|:----------------------------------------|
-| polaris-console | 8080   | http     | 北极星控制台页面端口                    |
-| polaris-limiter | 8100   | http     | 限流可用配额下发客户端数据通信          |
-| polaris-limiter | 8101   | grpc     | 限流可用配额下发客户端数据通信          |
-| polaris-server  | 8090   | http     | OpenAPI                                 |
-| polaris-server  | 8761   | http     | eureka 协议通信                         |
-| polaris-server  | 8091   | grpc     | 注册发现/服务治理规则下发客户端数据通信 |
-| polaris-server  | 8093   | grpc     | 配置中心客户端数据通信                  |
-| polaris-server  | 15010  | grpc     | xds 数据通信端口                        |
+| 进程名          | 端口号 | 协议类型 | 用途                                     |
+|:----------------|:-------|:---------|:---------------------------------------|
+| polaris-console | 8080   | http     | 北极星控制台页面端口                     |
+| polaris-limiter | 8100   | http     | 限流可用配额下发客户端数据通信           |
+| polaris-limiter | 8101   | grpc     | 限流可用配额下发客户端数据通信           |
+| polaris-server  | 8090   | http     | OpenAPI，可以调用注册、配置、治理规则的接口 |
+| polaris-server  | 8761   | http     | eureka 协议通信                          |
+| polaris-server  | 8848   | http     | nacos1.x 协议通信                        |
+| polaris-server  | 9848   | grpc     | nacos2.x 协议通信                        |
+| polaris-server  | 8091   | grpc     | 注册发现/服务治理规则下发客户端数据通信  |
+| polaris-server  | 8093   | grpc     | 配置中心客户端数据通信                   |
+| polaris-server  | 15010  | grpc     | xds 数据通信端口                         |
 
 ## 下载软件包
 
@@ -36,10 +38,6 @@ weight: 2
   - [polaris releases](https://github.com/polarismesh/polaris/releases)
   - [polaris-console releases](https://github.com/polarismesh/polaris-console/releases)
   - [polaris-limiter releases](https://github.com/polarismesh/polaris-limiter/releases)
-- Gitee下载：
-  - [polaris release](https://gitee.com/polarismesh/polaris/releases)
-  - [polaris-console releases](https://gitee.com/polarismesh/polaris-console/releases)
-  - [polaris-limiter releases](https://gitee.com/polarismesh/polaris-limiter/releases)
 
 ![下载软件包](../图片/安装集群版/下载软件包.png)
 

diff --git a/content/zh-cn/docs/参考文档/版本信息/release_1_18.0.md b/content/zh-cn/docs/参考文档/版本信息/release_1_18.0.md
@@ -26,6 +26,7 @@ weight: 1
     - [x] 配置查询
     - [x] 配置监听
 - nacos2.x
+  - 注册发现
     - [x] 实例注册
     - [x] 服务发现
     - [x] 基于 gRPC 长连接的实例信息维护

diff --git a/content/zh-cn/docs/最佳实践/存量服务迁移/nacos/协议兼容.md b/content/zh-cn/docs/最佳实践/存量服务迁移/nacos/协议兼容.md
@@ -0,0 +1,33 @@
+---
+title: "协议兼容（推荐）"
+linkTitle: "协议兼容（推荐）"
+weight: 1
+---
+
+## 概述
+
+如果你希望使用 Polaris 代替 Nacos 作为新的注册中心，Polaris 提供了协议兼容的方式，用户仅需要更改程序中的 nacos-client 的服务端接入地址即可。
+
+## 准备Polaris服务端
+
+需要预先安装好Polaris服务端，安装方式可参考：[集群版安装](/docs/使用指南/服务端安装/集群版安装/)
+
+## 注册发现
+
+### 原生 Nacos-Client
+
+```java
+```
+
+### Spring Cloud Alibaba
+
+### Dubbo 
+
+## 配置管理
+
+### 原生 Nacos-Client
+
+### Spring Cloud Alibaba
+
+### Dubbo 
+