This is an automated email from the ASF dual-hosted git repository.
jianbin pushed a commit to branch docusaurus
in repository https://gitbox.apache.org/repos/asf/incubator-seata-website.git
The following commit(s) were added to refs/heads/docusaurus by this push:
new d11ebbb2bd3 add docs for the new version of namingserver (#954)
d11ebbb2bd3 is described below
commit d11ebbb2bd3e4b0f2a0db4c4517fe3be4ac19106
Author: funkye <jian...@apache.org>
AuthorDate: Mon Mar 24 10:56:37 2025 +0800
add docs for the new version of namingserver (#954)
---
.../current/user/registry/namingserver.md | 160 +++++++++++++++------
.../version-v2.2/user/registry/namingserver.md | 7 +-
.../version-v2.3/user/registry/namingserver.md | 7 +-
.../current/user/registry/namingserver.md | 90 ++++++++++--
.../version-v2.2/user/registry/namingserver.md | 14 +-
.../version-v2.3/user/registry/namingserver.md | 15 +-
6 files changed, 226 insertions(+), 67 deletions(-)
diff --git
a/i18n/en/docusaurus-plugin-content-docs/current/user/registry/namingserver.md
b/i18n/en/docusaurus-plugin-content-docs/current/user/registry/namingserver.md
index a3a0d84a895..7e65146fedc 100644
---
a/i18n/en/docusaurus-plugin-content-docs/current/user/registry/namingserver.md
+++
b/i18n/en/docusaurus-plugin-content-docs/current/user/registry/namingserver.md
@@ -1,82 +1,158 @@
---
-Title: Seata Namingserver Registration Center
-Keywords: [ Seata, Namingserver ]
-Description: Namingserver registration center.
+title: Seata Namingserver Registry
+keywords: [ Seata, Namingserver ]
+description: Namingserver registry.
---
+# Namingserver Registry (beta)
-# Namingserver Registration Center
-Namingserver is the native registration center of Seata.
+Namingserver is Seata's native registry center.
-## Preparations
-You can choose to run the naming server in the compiler or after packaging it.
+## Prerequisites
-### Running the naming server in the compiler
-Go to the namingserver directory, set the port number for the naming server in
resources/application.yml, and start the naming server.
+Download the Seata binary package from [this
link](https://seata.apache.org/download/seata-server/)
-### Running Naming Server
-Download the Seata 2.2.0 binary package from the
[link](https://seata.apache.org/download/seata-server/) and unzip it. Then,
enter the seata-namingserver directory.
+### Running Namingserver in IDE
-In the conf/application.yml file, configure the port number for starting the
naming server.
+If you need to debug or develop namingserver locally, import Seata source
code, locate the `namingserver` module, set the port number for namingserver in
`resources/application.yml`, then start namingserver.
-For Mac or Linux, run:
+### Running Namingserver
+
+After extracting, navigate to the seata-namingserver directory. Open the
conf/application.yml file and configure the port for namingserver.
+For Mac or Linux, run:
```shell
-bin/seata-namingserver.sh
+bin\seata-namingserver.sh
```
-For Windows, run:
+For Windows, run:
```shell
-bin/seata-namingserver.bat
+bin\seata-namingserver.bat
+```
+
+## Quick Start
+
+Setting up Seata with namingserver as the registry is straightforward,
involving configurations on both client and server sides.
+
+### Namingserver Configuration Description
+
+```yaml
+server:
+ port: 8081 ## namingserver port
+spring:
+ application:
+ name: seata-namingserver
+logging:
+ config: classpath:logback-spring.xml
+ file:
+ path: ${log.home:${user.home}/logs/seata}
+console: ## As of version 2.4, the console has been moved from Seata-server to
Namingserver
+ user:
+ username: seata ## Account for console interface and open-api
authentication, strongly recommended to change from default
+ password: seata ## Password for console interface and open-api
authentication, strongly recommended to change from default
+heartbeat:
+ threshold: 90000 ## Time to remove Seata-server nodes when they go down
ungracefully
+ period: 60000 ## Check node heartbeats every 60 seconds, remove nodes if
they exceed the threshold
+seata:
+ security:
+ secretKey: SeataSecretKey0c382ef121d778043159209298fd40bf3850a017 ## Token
signing key, strongly recommended to change from default
+ tokenValidityInMilliseconds: 1800000 ## Token expiration time
+ csrf-ignore-urls: /naming/v1/**,/api/v1/naming/** ## URLs that don't
require CSRF protection, use default values as these are for client open-api
+ ignore:
+ urls:
/,/**/*.css,/**/*.js,/**/*.html,/**/*.map,/**/*.svg,/**/*.png,/**/*.jpeg,/**/*.ico,/api/v1/auth/login,/version.json,/naming/v1/health,/error
## URLs that don't require authentication
```
-## Getting Started Quickly
-The process to use the naming server as Seata's registration center is very
simple and involves configuring both the client and server sides.
+### Client Registry Configuration
-### Client-side Configuration for the Registration Center
-Add the corresponding registration center in the application.yml:
+Add the following registry configuration to
[**application.yml**](https://github.com/apache/incubator-seata/blob/2.x/script/client/spring/application.yml):
```yaml
seata:
registry:
type: seata
- seata:
- server-addr: 127.0.0.1:8081 ## IP + port of the naming server configured
in the first step. Use commas to separate multiple naming server nodes.
- namespace: public ## Namespace
- heartbeat-period: 5000 ## Heartbeat interval
+ seata:
+ server-addr: 127.0.0.1:8081 ## IP and port of configured namingserver,
use commas to separate multiple nodes
+ namespace: public ## Namespace
+ heartbeat-period: 5000 ## Heartbeat interval
+ username: seata
+ password: seata
```
-### Server-side Configuration for the Registration Center
-Add the following configuration to `conf/application.yaml`, with the rest of
the configuration referring to configuration options:
+
+### Server Registry Configuration
+
+Add the following configuration to `conf/application.yaml`.
+For other configurations, refer to [configuration
options](https://github.com/apache/incubator-seata/blob/2.x/server/src/main/resources/application.example.yml):
```yaml
seata:
registry:
type: seata
- seata:
- server-addr: 127.0.0.1:8081 ## IP + port of the naming server configured
in the first step. Use commas to separate multiple naming server nodes.
- cluster: default ## Cluster name
- namespace: public ## Namespace
- heartbeat-period: 5000 ## Heartbeat interval
+ seata:
+ server-addr: 127.0.0.1:8081 ## IP and port of configured namingserver,
use commas to separate multiple nodes
+ cluster: default ## Cluster name
+ namespace: public ## Namespace
+ heartbeat-period: 5000 ## Heartbeat interval
+ username: seata
+ password: seata
+```
+
+### Getting a Token
+
+If you're using IntelliJ IDEA's built-in HTTP client, you can get a token like
this:
+
+```
+POST http://localhost:8081/api/v1/auth/login
+Content-Type: application/json
+
+{
+ "username": "username",
+ "password": "password"
+}
+```
+
+If you're using curl, you can do:
+
+```shell
+curl -X POST http://localhost:8081/api/v1/auth/login \
+ -H "Content-Type: application/json" \
+ -d '{"username": "username", "password": "password"}'
```
-### Create a Mapping Between the Client's Transaction Group and the Seata
Cluster
-Send an HTTP request to one naming server node to create a transaction
group-to-cluster mapping (the naming server node will automatically synchronize
with other nodes):
+
+You'll receive a response like this. Copy the data field for use in the
`authorization` header in subsequent requests:
+
+```
+{
+ "code": "200",
+ "message": "success",
+ "data": "Bearer xxxxxxxxxx",
+ "success": true
+}
+```
+
+### Creating a Transaction Group to Seata Cluster Mapping
+
+Send an HTTP request to a namingserver node to create a transaction group
mapping relationship (the namingserver node will automatically synchronize with
other nodes):
```shell
-http://127.0.0.1:8081/naming/v1/addGroup?clusterName=cluster2&namespace=public&unitName&vGroup=my_test_tx_group
+curl -X POST -H "authorization: Bearer xxxxxxx"
http://127.0.0.1:8081/naming/v1/addGroup?clusterName=cluster2&namespace=public&unitName&vGroup=my_test_tx_group
```
-(In this, namespace is the namespace configured on the client side, vGroup is
the transaction group configured on the client side, and clusterName is the
cluster name on the server side that needs to be mapped.)
+(Where namespace is the namespace configured on the client, vGroup is the
transaction group configured on the client, and clusterName is the cluster name
of the server to map to)
-### Change the Mapping Between the Client's Transaction Group and the Seata
Cluster
-Send an HTTP request to one naming server node to change the transaction
group-to-cluster mapping (the naming server node will automatically synchronize
with other nodes):
+### Switching Transaction Group to Seata Cluster Mapping (Traffic Switching)
+
+Send an HTTP request to a namingserver node to modify the transaction group
mapping relationship:
```shell
-http://127.0.0.1:8081/naming/v1/changeGroup?clusterName=cluster2&namespace=public&unitName&vGroup=my_test_tx_group
+curl -X POST -H "authorization: Bearer xxxxxxx"
http://127.0.0.1:8081/naming/v1/changeGroup?clusterName=cluster2&namespace=public&unitName&vGroup=my_test_tx_group
```
-(In this, namespace is the namespace configured on the client side, vGroup is
the transaction group configured on the client side, and clusterName is the
cluster name on the server side that needs to be mapped.)
-Afterward, once Seata-Server is started and the client configuration is
complete, you can begin to experience Seata services.
+(Where namespace is the namespace configured on the client, vGroup is the
transaction group configured on the client, and clusterName is the cluster name
of the server to map to)
+
+After starting Seata-Server and configuring the client, you can start your
application and begin using Seata services.
Tips:
-- 1.Please ensure that the client and server are registered under the same
namespace; otherwise, the service will not be found.
-- 2.Note that the naming server is only allowed to be used in a private
network; do not expose it to the public environment.
+- 1. Ensure the client and server registries are in the same namespace,
otherwise services won't be found.
+- 2. Namingserver should only be used on internal networks, never expose it to
public networks.
+- 3. Namingserver is an experimental feature and may change in future
versions. Please evaluate and test thoroughly before using in production.
+- 4. Adding, deleting, or modifying transaction groups must be done through
namingserver's open-api. Bypassing this may cause data inconsistency, resulting
in service discovery failures or exceptions.
diff --git
a/i18n/en/docusaurus-plugin-content-docs/version-v2.2/user/registry/namingserver.md
b/i18n/en/docusaurus-plugin-content-docs/version-v2.2/user/registry/namingserver.md
index fe64318df56..041dd27065a 100644
---
a/i18n/en/docusaurus-plugin-content-docs/version-v2.2/user/registry/namingserver.md
+++
b/i18n/en/docusaurus-plugin-content-docs/version-v2.2/user/registry/namingserver.md
@@ -80,5 +80,8 @@
http://127.0.0.1:8081/naming/v1/changeGroup?clusterName=cluster2&namespace=publi
Afterward, once Seata-Server is started and the client configuration is
complete, you can begin to experience Seata services.
Tips:
-- 1.Please ensure that the client and server are registered under the same
namespace; otherwise, the service will not be found.
-- 2.Note that the naming server is only allowed to be used in a private
network; do not expose it to the public environment.
+- 1. Ensure the client and server registries are in the same namespace,
otherwise services won't be found.
+- 2. Namingserver should only be used on internal networks, never expose it to
public networks.
+- 3. Namingserver is an experimental feature and may change in future
versions. Please evaluate and test thoroughly before using in production.
+- 4. Adding, deleting, or modifying transaction groups must be done through
namingserver's open-api. Bypassing this may cause data inconsistency, resulting
in service discovery failures or exceptions.
+
diff --git
a/i18n/en/docusaurus-plugin-content-docs/version-v2.3/user/registry/namingserver.md
b/i18n/en/docusaurus-plugin-content-docs/version-v2.3/user/registry/namingserver.md
index a3a0d84a895..994ae697e8a 100644
---
a/i18n/en/docusaurus-plugin-content-docs/version-v2.3/user/registry/namingserver.md
+++
b/i18n/en/docusaurus-plugin-content-docs/version-v2.3/user/registry/namingserver.md
@@ -78,5 +78,8 @@
http://127.0.0.1:8081/naming/v1/changeGroup?clusterName=cluster2&namespace=publi
Afterward, once Seata-Server is started and the client configuration is
complete, you can begin to experience Seata services.
Tips:
-- 1.Please ensure that the client and server are registered under the same
namespace; otherwise, the service will not be found.
-- 2.Note that the naming server is only allowed to be used in a private
network; do not expose it to the public environment.
+- 1. Ensure the client and server registries are in the same namespace,
otherwise services won't be found.
+- 2. Namingserver should only be used on internal networks, never expose it to
public networks.
+- 3. Namingserver is an experimental feature and may change in future
versions. Please evaluate and test thoroughly before using in production.
+- 4. Adding, deleting, or modifying transaction groups must be done through
namingserver's open-api. Bypassing this may cause data inconsistency, resulting
in service discovery failures or exceptions.
+
diff --git
a/i18n/zh-cn/docusaurus-plugin-content-docs/current/user/registry/namingserver.md
b/i18n/zh-cn/docusaurus-plugin-content-docs/current/user/registry/namingserver.md
index b9814d91abb..6111ab0ac31 100644
---
a/i18n/zh-cn/docusaurus-plugin-content-docs/current/user/registry/namingserver.md
+++
b/i18n/zh-cn/docusaurus-plugin-content-docs/current/user/registry/namingserver.md
@@ -4,21 +4,21 @@ keywords: [ Seata, Namingserver ]
description: namingserver 注册中心。
---
-# Namingserver 注册中心
+# Namingserver 注册中心（beta）
Namingserver 是 Seata 原生的注册中心.
## 预备工作
-可以选择在编译器中运行namingserver或者打包后运行namingserver
+
+从[链接](https://seata.apache.org/download/seata-server/）下载namingserver的发行包)下载seata的二进制压缩包
+
### 编译器运行namingserver
-进入`namingsever`目录，在`resources/application.yml`下设置namingserver启动的端口号，启动namingserver
+如果您需要本地调试或开发namingserver，请导入Seata源码，并找到`namingserver`模块，在`resources/application.yml`下设置namingserver启动的端口号，启动namingserver
### 运行namingserver
-从[链接](https://seata.apache.org/download/seata-server/）下载namingserver的发行包)下载seata2.2.0的二进制压缩包，解压后进入seata-namingserver目录
-
-目录下的conf/application.yml中配置namingserver启动的端口号，
+解压后进入seata-namingserver目录，打开目录下的conf/application.yml中配置namingserver启动的端口号，
mac或linux运行
```shell
bin\seata-namingserver.sh
@@ -31,6 +31,34 @@ bin\seata-namingserver.bat
Seata 使用 namingserver 作为注册中心的操作步骤非常简单，分为在client端的配置以及在server端的配置
+### Namingserver 配置说明
+
+```yaml
+server:
+ port: 8081 ## namingserver的端口
+spring:
+ application:
+ name: seata-namingserver
+logging:
+ config: classpath:logback-spring.xml
+ file:
+ path: ${log.home:${user.home}/logs/seata}
+console: ## 2.4开始控制台从Seata-server迁移至Namingserver，故此配置为控制台相关配置
+ user:
+ username: seata ## 控制台界面，和open-api鉴权所需账号，强烈建议修改不要采用默认值
+ password: seata ## 控制台界面，和open-api鉴权所需密码，强烈建议修改不要采用默认值
+heartbeat:
+ threshold: 90000 ## 当Seata-server节点非优雅下线时，摘除时间
+ period: 60000 ## 每60秒检查节点心跳是否正常，如果超过threshold的配置，将进行摘除
+seata:
+ security:
+ secretKey: SeataSecretKey0c382ef121d778043159209298fd40bf3850a017 ##
签发token秘钥，强烈建议修改，不要采用默认值
+ tokenValidityInMilliseconds: 1800000 ## token过期时间
+ csrf-ignore-urls: /naming/v1/**,/api/v1/naming/** ##
无需csrf防护接口，采用默认值即可，因为此默认值是提供给client的open-api，不通过控制台。
+ ignore:
+ urls:
/,/**/*.css,/**/*.js,/**/*.html,/**/*.map,/**/*.svg,/**/*.png,/**/*.jpeg,/**/*.ico,/api/v1/auth/login,/version.json,/naming/v1/health,/error
## 无需鉴权的相关接口
+```
+
### Client端配置注册中心
在
[**application.yml**](https://github.com/apache/incubator-seata/blob/2.x/script/client/spring/application.yml)
@@ -44,6 +72,8 @@ seata:
server-addr: 127.0.0.1:8081
##第一步配置的namingserver的ip+端口，若有多个namingserver节点则用逗号分割
namespace: public ##命名空间
heartbeat-period: 5000 ##心跳时间
+ username: seata
+ password: seata
```
### Server端配置注册中心
@@ -60,25 +90,67 @@ seata:
cluster: default ##集群名称
namespace: public ##命名空间
heartbeat-period: 5000 ##心跳时间
+ username: seata
+ password: seata
+```
+
+### 获取token
+
+如果你使用idea自带的httpclient，可参考以下方式获取token
+
+```
+POST http://localhost:8081/api/v1/auth/login
+Content-Type: application/json
+
+{
+ "username": "username",
+ "password": "password"
+}
+```
+
+如果你使用curl，可参考以下方式获取token
+
+```shell
+curl -X POST http://localhost:8081/api/v1/auth/login \
+ -H "Content-Type: application/json" \
+ -d '{"username": "username", "password": "password"}'
+```
+
+将会得到如下响应，请复制其中的data放入后续的`authorization`请求头中
+
+```
+{
+ "code": "200",
+ "message": "success",
+ "data": "Bearer xxxxxxxxxx",
+ "success": true
+}
```
### 创建client端的事务分组->seata集群的映射关系
+
向一个namingserver节点发起创建事务分组映射关系的http请求（namingserver节点会自动同步给其它节点）
+
```shell
-http://127.0.0.1:8081/naming/v1/addGroup?clusterName=cluster2&namespace=public&unitName&vGroup=my_test_tx_group
+curl -X POST -H "authorization: Bearer xxxxxxx"
http://127.0.0.1:8081/naming/v1/addGroup?clusterName=cluster2&namespace=public&unitName&vGroup=my_test_tx_group
```
+
（其中namespace是client端配置的命名空间，vGroup是client端配置的事务分组，clusterName是需要映射到的server端的集群名称）
### 切换client端的事务分组->seata集群的映射关系（切流）
+
向一个namingserver节点发起修改事务分组映射关系的http请求（namingserver节点会自动同步给其它节点）
+
```shell
-http://127.0.0.1:8081/naming/v1/changeGroup?clusterName=cluster2&namespace=public&unitName&vGroup=my_test_tx_group
+curl -X POST -H "authorization: Bearer xxxxxxx"
http://127.0.0.1:8081/naming/v1/changeGroup?clusterName=cluster2&namespace=public&unitName&vGroup=my_test_tx_group
```
-（其中namespace是client端配置的命名空间，vGroup是client端配置的事务分组，clusterName是需要映射到的server端的集群名称）
+（其中namespace是client端配置的命名空间，vGroup是client端配置的事务分组，clusterName是需要映射到的server端的集群名称）
随后,启动 Seata-Server 后，Client 配置完成后启动应用就可以正式体验 Seata 服务。
Tips：
- 1.请确保client与server的注册处于同一个namespace，不然会找不到服务。
- 2.注意namingserver只允许在内网使用,切勿暴露到公网环境
+- 3.namingserver处于实验性feature，故后续可能有一定改动，请评估和测试到位后再投入使用
+- 4.针对事务分组的增删改必须通过namingserver的open-api，如果绕过可能会导致数据不一致，造成服务发现失败或者异常
diff --git
a/i18n/zh-cn/docusaurus-plugin-content-docs/version-v2.2/user/registry/namingserver.md
b/i18n/zh-cn/docusaurus-plugin-content-docs/version-v2.2/user/registry/namingserver.md
index 0d67e4a9b1b..862b87c6d21 100644
---
a/i18n/zh-cn/docusaurus-plugin-content-docs/version-v2.2/user/registry/namingserver.md
+++
b/i18n/zh-cn/docusaurus-plugin-content-docs/version-v2.2/user/registry/namingserver.md
@@ -4,21 +4,21 @@ keywords: [ Seata, Namingserver ]
description: namingserver 注册中心。
---
-# Namingserver 注册中心
+# Namingserver 注册中心（beta）
Namingserver 是 Seata 原生的注册中心.
## 预备工作
-可以选择在编译器中运行namingserver或者打包后运行namingserver
+
+从[链接](https://seata.apache.org/download/seata-server/）下载namingserver的发行包)下载seata的二进制压缩包
+
### 编译器运行namingserver
-进入`namingsever`目录，在`resources/application.yml`下设置namingserver启动的端口号，启动namingserver
+如果您需要本地调试或开发namingserver，请导入Seata源码，并找到`namingserver`模块，在`resources/application.yml`下设置namingserver启动的端口号，启动namingserver
### 运行namingserver
-从[链接](https://seata.apache.org/download/seata-server/）下载namingserver的发行包)下载seata2.2.0的二进制压缩包，解压后进入seata-namingserver目录
-
-目录下的`conf/application.yml`中配置namingserver启动的端口号，
+解压后进入seata-namingserver目录，打开目录下的conf/application.yml中配置namingserver启动的端口号，
mac或linux运行
``` shell
bin\seata-namingserver.sh
@@ -83,3 +83,5 @@
http://127.0.0.1:8081/naming/v1/changeGroup?clusterName=cluster2&namespace=publi
Tips：
- 1.请确保client与server的注册处于同一个namespace，不然会找不到服务。
- 2.注意namingserver只允许在内网使用,切勿暴露到公网环境
+- 3.namingserver处于实验性feature，故后续可能有一定改动，请评估和测试到位后再投入使用
+- 4.针对事务分组的增删改必须通过namingserver的open-api，如果绕过可能会导致数据不一致，造成服务发现失败或者异常
diff --git
a/i18n/zh-cn/docusaurus-plugin-content-docs/version-v2.3/user/registry/namingserver.md
b/i18n/zh-cn/docusaurus-plugin-content-docs/version-v2.3/user/registry/namingserver.md
index b9814d91abb..985bb68c166 100644
---
a/i18n/zh-cn/docusaurus-plugin-content-docs/version-v2.3/user/registry/namingserver.md
+++
b/i18n/zh-cn/docusaurus-plugin-content-docs/version-v2.3/user/registry/namingserver.md
@@ -4,21 +4,21 @@ keywords: [ Seata, Namingserver ]
description: namingserver 注册中心。
---
-# Namingserver 注册中心
+# Namingserver 注册中心（beta）
Namingserver 是 Seata 原生的注册中心.
## 预备工作
-可以选择在编译器中运行namingserver或者打包后运行namingserver
+
+从[链接](https://seata.apache.org/download/seata-server/）下载namingserver的发行包)下载seata的二进制压缩包
+
### 编译器运行namingserver
-进入`namingsever`目录，在`resources/application.yml`下设置namingserver启动的端口号，启动namingserver
+如果您需要本地调试或开发namingserver，请导入Seata源码，并找到`namingserver`模块，在`resources/application.yml`下设置namingserver启动的端口号，启动namingserver
### 运行namingserver
-从[链接](https://seata.apache.org/download/seata-server/）下载namingserver的发行包)下载seata2.2.0的二进制压缩包，解压后进入seata-namingserver目录
-
-目录下的conf/application.yml中配置namingserver启动的端口号，
+解压后进入seata-namingserver目录，打开目录下的conf/application.yml中配置namingserver启动的端口号，
mac或linux运行
```shell
bin\seata-namingserver.sh
@@ -79,6 +79,9 @@
http://127.0.0.1:8081/naming/v1/changeGroup?clusterName=cluster2&namespace=publi
随后,启动 Seata-Server 后，Client 配置完成后启动应用就可以正式体验 Seata 服务。
+Tips：
Tips：
- 1.请确保client与server的注册处于同一个namespace，不然会找不到服务。
- 2.注意namingserver只允许在内网使用,切勿暴露到公网环境
+- 3.namingserver处于实验性feature，故后续可能有一定改动，请评估和测试到位后再投入使用
+- 4.针对事务分组的增删改必须通过namingserver的open-api，如果绕过可能会导致数据不一致，造成服务发现失败或者异常
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscr...@seata.apache.org
For additional commands, e-mail: notifications-h...@seata.apache.org
