You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@servicecomb.apache.org by ni...@apache.org on 2018/03/09 12:17:40 UTC
[incubator-servicecomb-saga] 01/03: SCB-330 add guides to run
executable alpha server
This is an automated email from the ASF dual-hosted git repository.
ningjiang pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-servicecomb-saga.git
commit 99fabadda232b8c2095fe540ab6545be67c4f8ce
Author: Eric Lee <da...@huawei.com>
AuthorDate: Fri Mar 9 10:48:10 2018 +0800
SCB-330 add guides to run executable alpha server
Signed-off-by: Eric Lee <da...@huawei.com>
---
docs/user_guide.md | 24 ++++++++++++++----------
docs/user_guide_zh.md | 24 ++++++++++++++----------
2 files changed, 28 insertions(+), 20 deletions(-)
diff --git a/docs/user_guide.md b/docs/user_guide.md
index a0d9db5..97494ad 100644
--- a/docs/user_guide.md
+++ b/docs/user_guide.md
@@ -25,14 +25,15 @@ $ mvn clean install -DskipTests -Pdocker
<dependency>
<groupId>org.apache.servicecomb.saga</groupId>
<artifactId>omega-spring-starter</artifactId>
- <version>0.0.3-SNAPSHOT</version>
+ <version>${saga.version}</version>
</dependency>
<dependency>
<groupId>org.apache.servicecomb.saga</groupId>
<artifactId>omega-transport-resttemplate</artifactId>
- <version>0.0.3-SNAPSHOT</version>
+ <version>${saga.version}</version>
</dependency>
```
+**Note**: Please change the `${saga.version}` to the actual version.
### Add saga annotations and corresponding compensation methods
Take a transfer money application as an example:
@@ -80,13 +81,16 @@ Take a transfer money application as an example:
docker run -d -e "POSTGRES_DB=saga" -e "POSTGRES_USER=saga" -e "POSTGRES_PASSWORD=password" -p 5432:5432 postgres
```
-2. run alpha. Before running alpha, please make sure postgreSQL is already up.
- ```bash
- docker run -d -p 8090:8090 \
- -e "JAVA_OPTS=-Dspring.profiles.active=prd" \
- -e "spring.datasource.url=jdbc:postgresql://{docker.host.address}:5432/saga?useSSL=false" \
- alpha-server:0.0.3-SNAPSHOT
- ```
+2. run alpha. Before running alpha, please make sure postgreSQL is already up. You can run alpha through docker or executable file.
+ * Run alpha through docker.
+ ```bash
+ docker run -d -p 8090:8090 -e "JAVA_OPTS=-Dspring.profiles.active=prd -Dspring.datasource.url=jdbc:postgresql://${docker_host_address}:5432/saga?useSSL=false" alpha-server:${saga_version}
+ ```
+ * Run alpha through executable file.
+ ```bash
+ java -Dspring.profiles.active=prd -D"spring.datasource.url=jdbc:postgresql://${host_address}:5432/saga?useSSL=false" -jar alpha-server-${saga_version}-exec.jar
+ ```
+ **Note**: Please change `${saga_version}` and `${docker_host_address}`/`${host_address}` to the actual value before you execute the command.
3. setup omega. Configure the following values in `application.yaml`.
```yaml
@@ -98,4 +102,4 @@ Take a transfer money application as an example:
address: {alpha.cluster.addresses}
```
-Then you can start your micro-services.
+Then you can start your micro-services and access all saga events via http://${alpha-server:port}/events.
diff --git a/docs/user_guide_zh.md b/docs/user_guide_zh.md
index 6b8ce47..ac657f3 100644
--- a/docs/user_guide_zh.md
+++ b/docs/user_guide_zh.md
@@ -24,14 +24,15 @@ $ mvn clean install -DskipTests -Pdocker
<dependency>
<groupId>org.apache.servicecomb.saga</groupId>
<artifactId>omega-spring-starter</artifactId>
- <version>0.0.3-SNAPSHOT</version>
+ <version>${saga.version}</version>
</dependency>
<dependency>
<groupId>org.apache.servicecomb.saga</groupId>
<artifactId>omega-transport-resttemplate</artifactId>
- <version>0.0.3-SNAPSHOT</version>
+ <version>${saga.version}</version>
</dependency>
```
+**注意**: 请将`${saga.version}`更改为实际的版本号。
### 添加Saga的注解及相应的补偿方法
以一个转账应用为例：
@@ -79,13 +80,16 @@ $ mvn clean install -DskipTests -Pdocker
docker run -d -e "POSTGRES_DB=saga" -e "POSTGRES_USER=saga" -e "POSTGRES_PASSWORD=password" -p 5432:5432 postgres
```
-2. 运行alpha。在运行alpha前，请确保postgreSQL已正常启动。
- ```bash
- docker run -d -p 8090:8090 \
- -e "JAVA_OPTS=-Dspring.profiles.active=prd" \
- -e "spring.datasource.url=jdbc:postgresql://{docker.host.address}:5432/saga?useSSL=false" \
- alpha-server:0.0.3-SNAPSHOT
- ```
+2. 运行alpha。在运行alpha前，请确保postgreSQL已正常启动。可通过docker或可执行文件的方式来启动alpha。
+ * 通过docker运行：
+ ```bash
+ docker run -d -p 8090:8090 -e "JAVA_OPTS=-Dspring.profiles.active=prd -Dspring.datasource.url=jdbc:postgresql://${docker_host_address}:5432/saga?useSSL=false" alpha-server:${saga_version}
+ ```
+ * 通过可执行文件运行：
+ ```bash
+ java -Dspring.profiles.active=prd -D"spring.datasource.url=jdbc:postgresql://${host_address}:5432/saga?useSSL=false" -jar alpha-server-${saga_version}-exec.jar
+ ```
+ **注意**: 请在执行命令前将`${saga_version}`和`${docker_host_address}`/`${host_address}`更改为实际值。
3. 配置omega。在 `application.yaml` 添加下面的配置项：
```yaml
@@ -97,4 +101,4 @@ $ mvn clean install -DskipTests -Pdocker
address: {alpha.cluster.addresses}
```
-然后就可以运行相关的微服务了。
+然后就可以运行相关的微服务了，可通过访问http://${alpha-server:port}/events 来获取所有的saga事件信息。
--
To stop receiving notification emails like this one, please contact
ningjiang@apache.org.