Pack User Guide

Prerequisites

You will need:

1. JDK 1.8
2. Maven 3.x
3. Docker

Build

Retrieve the source code:

$ git clone https://github.com/apache/servicecomb-pack.git
$ cd servicecomb-pack

Saga can be built in either of the following ways.

• Only build the executable files.

  $ mvn clean install -DskipTests -Pspring-boot-2
  

• build the executable files along with docker image.

  $ mvn clean install -DskipTests -Pdocker,spring-boot-2
  

• build the executable file and saga-distribution

     $ mvn clean install -DskipTests -Prelease,spring-boot-2
  

After executing either one of the above command, you will find alpha server's executable file in alpha/alpha-server/target/saga/alpha-server-${version}-exec.jar.

How to use

Add pack dependencies

    <dependency>
      <groupId>org.apache.servicecomb.pack</groupId>
      <artifactId>omega-spring-starter</artifactId>
      <version>${pack.version}</version>
    </dependency>
    <dependency>
      <groupId>org.apache.servicecomb.pack</groupId>
      <artifactId>omega-transport-resttemplate</artifactId>
      <version>${pack.version}</version>
    </dependency>

Note: Please change the ${pack.version} to the actual version.

Migration Note:Since 0.3.0 we rename the project repository name from saga to pack. Please update the group id and package name if you migrate your application from saga 0.2.x to pack 0.3.0.

name	0.2.x	0.3.x
groupId	org.apache.servicecomb.saga	org.apache.servicecomb.pack
Package Name	org.apache.servicecomb.saga	org.apache.servicecomb.pack

Saga Support

Add saga annotations and corresponding compensation methods Take a transfer money application as an example:

1. add @EnableOmega at application entry to initialize omega configurations and connect to alpha

   import org.apache.servicecomb.pack.omega.spring.EnableOmega;
   import org.springframework.boot.autoconfigure.SpringBootApplication;
   
   @SpringBootApplication
   @EnableOmega
   public class Application {
     public static void main(String[] args) {
       SpringApplication.run(Application.class, args);
     }
   }
   

2. add @SagaStart at the starting point of the global transaction

   import org.apache.servicecomb.pack.omega.context.annotations.SagaStart;
   
   @SagaStart(timeout=10)
   public boolean transferMoney(String from, String to, int amount) {
     transferOut(from, amount);
     transferIn(to, amount);
   }
   

   Note: By default, timeout is disable.

3. add @Compensable at the sub-transaction and specify its corresponding compensation method

   import javax.transaction.Transactional;
   import org.apache.servicecomb.pack.omega.transaction.annotations.Compensable;
   
   @Compensable(timeout=5, compensationMethod="cancel")
   @Transactional
   public boolean transferOut(String from, int amount) {
     repo.reduceBalanceByUsername(from, amount);
   }
   
   @Transactional
   public boolean cancel(String from, int amount) {
     repo.addBalanceByUsername(from, amount);
   }
   

   Note The transactions and compensations method should have same arguments. The transactions and compensations implemented by services must be idempotent. We highly recommend to use the Spring @Transactional to guarantee the local transaction.

   Note: By default, timeout is disable.

   Note: If the starting point of global transaction and local transaction overlaps, both @SagaStart and @Compensable are needed.

4. Repeat step 3 for the transferIn service.

5. Since pack-0.3.0, you can access the OmegaContext for the gloableTxId and localTxId in the @Compensable annotated method or the cancel method.

TCC support

Add TCC annotations and corresponding confirm and cancel methods Take a transfer money application as an example:

1. add @EnableOmega at application entry to initialize omega configurations and connect to alpha

   import org.apache.servicecomb.pack.omega.spring.EnableOmega;
   import org.springframework.boot.autoconfigure.SpringBootApplication;
   
   @SpringBootApplication
   @EnableOmega
   public class Application {
     public static void main(String[] args) {
       SpringApplication.run(Application.class, args);
     }
   }
   

2. add @TccStart at the starting point of the global transaction

   import org.apache.servicecomb.pack.omega.context.annotations.TccStart;
   
   @TccStart
   public boolean transferMoney(String from, String to, int amount) {
     transferOut(from, amount);
     transferIn(to, amount);
   }
   

   Note: By default, timeout is disable.

3. add @Participate at the sub-transaction and specify its corresponding compensation method

   import javax.transaction.Transactional;
   import org.apache.servicecomb.pack.omega.transaction.annotations.Participate;
   
   @Participate(confirmMethod = "confirm", cancelMethod = "cancel")
   @Transactional
   public void transferOut(String from, int amount) {
     // check banalance
   }
   
   @Transactional
   public void confirm(String from, int amount) {
     repo.reduceBalanceByUsername(from, amount);
   }
   
   @Transactional
   public void cancel(String from, int amount) {
     repo.addBalanceByUsername(from, amount);
   }
   

   Note: The confirm and cancel method should have same arguments with participate method, confirm and cancel method implemented by services must be idempotent. We highly recommend to use the Spring @Transactional to guarantee the local transaction.

   Note: Current TCC implementation doesn't support timeout.

   Note: If the starting point of global transaction and local transaction overlaps, both @TccStart and @Participate are needed.

4. Repeat step 3 for the transferIn service.

How to run

1. run postgreSQL.

   docker run -d -e "POSTGRES_DB=saga" -e "POSTGRES_USER=saga" -e "POSTGRES_PASSWORD=password" -p 5432:5432 postgres
   

   Please check out this document, if you want to use the MySQL instead of postgreSQL.

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.

     docker run -d -p 8080:8080 -p 8090:8090 -e "JAVA_OPTS=-Dspring.profiles.active=prd -Dspring.datasource.url=jdbc:postgresql://${host_address}:5432/saga?useSSL=false" alpha-server:${saga_version}
     

   • Run alpha through executable file.

     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 ${pack_version} and ${host_address} to the actual value before you execute the command.

   Note: By default, port 8080 is used to serve omega's request via gRPC while port 8090 is used to query the events stored in alpha.

3. setup omega. Configure the following values in application.yaml.

   spring:
     application:
       name: {application.name}
   alpha:
     cluster:
       address: {alpha.cluster.addresses}
   

Then you can start your micro-services and access all saga events via http://${alpha-server:port}/saga/events.

Enable SSL for Alpha and Omega

See Enabling SSL for details.

Service discovery support

Alpha instance can register to the discovery service, Omega obtains Alpha's instance list and gRPC address through discovery service

Consul

Uses Spring Cloud Consul 2.x by default, if you want to use Spring Cloud Consul 1.x, you can use -Pspring-boot-1 to switch Spring Cloud Consul 1.x

1. run alpha

   run with parameter spring.cloud.consul.enabled=true

   java -jar alpha-server-${saga_version}-exec.jar \ 
     --spring.datasource.url=jdbc:postgresql://${host_address}:5432/saga?useSSL=false \
     --spring.datasource.username=saga \
     --spring.datasource.password=saga \
     --spring.cloud.consul.enabled=true \
     --spring.cloud.consul.host=${consul_host} \
     --spring.cloud.consul.port=${consul_port} \
     --spring.profiles.active=prd 
   

   Note: ${consul_host} is consul host, ${consul_port} is consul port

   Note: Check out for more details Spring Cloud Consul 2.x Spring Cloud Consul 1.x

2. verify registration information

   request curl http://127.0.0.1:8500/v1/agent/services, It responds with the following JSON

   {
       "servicecomb-alpha-server-0-0-0-0-8090": {
           "ID": "servicecomb-alpha-server-0-0-0-0-8090",
           "Service": "servicecomb-alpha-server",
           "Tags": [
               "alpha-server-host=0.0.0.0",
               "alpha-server-port=8080",
               "secure=false"
           ],
           "Meta": {},
           "Port": 8090,
           "Address": "10.50.7.14",
           "Weights": {
               "Passing": 1,
               "Warning": 1
           },
           "EnableTagOverride": false
       }
   }
   

   Note: Tags property is alpha gRPC address

   Note: alpha instance name is servicecomb-alpha-server by default. You can set it by starting parameter  spring.application.name 

3. setup omega

   edit your pom.xml and add the omega-spring-cloud-consul-starter dependency

   <dependency>
    <groupId>org.apache.servicecomb.pack</groupId>
    <artifactId>omega-spring-cloud-consul-starter</artifactId>
    <version>${pack.version}</version>
   </dependency>
   

   edit your application.yaml , as shown in the following example:

   spring:
     cloud:
       consul:
         discovery:
         	register: false
         host: 127.0.0.1
         port: 8500
   
   alpha:
     cluster:
       register:
         type: consul
   

   • spring.cloud.consul.host property is set to the Consul server’s instance address, spring.cloud.consul.port property is set to the Consul server’s instance port, spring.cloud.consul.discovery.register=false property is not register yourself , check out Spring Boot’s  Spring Cloud Consul 2.x or Spring Cloud Consul 1.x for more details.
   • alpha.cluster.register.type=consul property is omega gets alpha gRPC address from Consul

   Note: If you define spring.application.name parameter when start alpha, You need to specify this service name in Omega via the parameter alpha.cluster.serviceId

Spring Cloud Eureka

Uses Spring Cloud Netflix 2.x by default, if you want to use Spring Cloud Netflix 1.x, you can use -Pspring-boot-1 to switch Spring Cloud Netflix 1.x

1. build version of eureka

   build the version support eureka with the -Pspring-cloud-eureka parameter

   git clone https://github.com/apache/servicecomb-pack.git
   cd servicecomb-pack
   mvn clean install -DskipTests=true -Pspring-boot-2,spring-cloud-eureka
   

2. run alpha

   run with parameter eureka.client.enabled=true

   java -jar alpha-server-${saga_version}-exec.jar \ 
     --spring.datasource.url=jdbc:postgresql://${host_address}:5432/saga?useSSL=false \
     --spring.datasource.username=saga \
     --spring.datasource.password=saga \
     --eureka.client.enabled=true \
     --eureka.client.service-url.defaultZone=http://127.0.0.1:8761/eureka \  
     --spring.profiles.active=prd 
   

   Note: Check out Spring Cloud Netflix 2.x Spring Cloud Netflix 1.x for more details

3. verify registration information

   request curl http://127.0.0.1:8761/eureka/apps/, It responds with the following XML

   <applications>
     <versions__delta>1</versions__delta>
     <apps__hashcode>UP_1_</apps__hashcode>
     <application>
       <name>SERVICECOMB-ALPHA-SERVER</name>
       <instance>
         <instanceId>0.0.0.0::servicecomb-alpha-server:8090</instanceId>
         <hostName>0.0.0.0</hostName>
         <app>SERVICECOMB-ALPHA-SERVER</app>
         <ipAddr>0.0.0.0</ipAddr>
         <status>UP</status>
      ...
         <metadata>
           <management.port>8090</management.port>
           <servicecomb-alpha-server>0.0.0.0:8080</servicecomb-alpha-server>
         </metadata>
         ...
       </instance>
     </application>
   </applications>
   

   Note: <servicecomb-alpha-server> property is alpha gRPC address

   Note: alpha instance name is SERVICECOMB-ALPHA-SERVER by default. You can set it by starting parameter  spring.application.name 

4. setup omega

   edit your pom.xml and add the omega-spring-cloud-eureka-starter dependency

   <dependency>
    <groupId>org.apache.servicecomb.pack</groupId>
    <artifactId>omega-spring-cloud-eureka-starter</artifactId>
    <version>${pack.version}</version>
   </dependency>
   

   edit your application.yaml , as shown in the following example:

   eureka:
     client:
       service-url:
         defaultZone: http://127.0.0.1:8761/eureka
   alpha:
     cluster:
       register:
         type: eureka
   

   • eureka.client.service-url.defaultZone property is set to the Eureka server’s instance address, check out Spring Boot’s  Spring Cloud Netflix 2.x or Spring Cloud Netflix 1.x for more details.
   • alpha.cluster.register.type=eureka property is omega gets alpha gRPC address from Eureka

   Note: If you define spring.application.name parameter when start alpha, You need to specify this service name in Omega via the parameter alpha.cluster.serviceId

Cluster

Alpha can be highly available by deploying multiple instances, enable cluster support with the alpha.cluster.master.enabled=true parameter.