Cut 0.4.0 Release
60 files changed
tree: 39e05460841a6922e713c10c02fc645025d2d258
  1. .github/
  2. .gitignore
  3. .mvn/
  4. .travis.settings.xml
  5. .travis.yml
  6. CONTRIBUTING.md
  7. FAQ.md
  8. FAQ_ZH.md
  9. LICENSE
  10. NOTICE
  11. README.md
  12. README_ZH.md
  13. ROADMAP.md
  14. acceptance-tests/
  15. alpha/
  16. demo/
  17. distribution/
  18. docker-build-config/
  19. docs/
  20. integration-tests/
  21. mvnw
  22. mvnw.cmd
  23. omega/
  24. pack-common/
  25. pack-contracts/
  26. persistence/
  27. pom.xml
  28. scripts/
  29. web/
README.md

Pack | 中文 Build Status Coverage StatusMaven Central License Gitter

Apache ServiceComb Pack is an eventually data consistency solution for micro-service applications.

Features

  • High availability. The coordinator is stateless and thus can have multiple instances.
  • High reliability. All transaction events are stored in database permanently.
  • High performance. Transaction events are reported to coordinator via gRPC and transaction payloads are serialized/deserialized by Kyro.
  • Low invasion. All you need to do is add 2-3 annotations and the corresponding compensate methods.
  • Easy to deploy. All components can boot via docker.
  • Support both forward(retry) and backward(compensate) recovery.
  • Easy to extend other coordination protocol which is based on the Pack, now we have Saga and TCC support out of box.

Architecture

ServiceComb Pack is composed of alpha and omega.

  • The alpha plays as the coordinator. It is responsible for the management of transactions.
  • The omega plays as an agent inside the micro-service. It intercepts incoming/outgoing requests and reports transaction events to alpha.

The following diagram shows the relationships among alpha, omega and services. Pack Architecture

In this way, we can implement different coordination protocols, such as saga and TCC. See ServiceComb Pack Design for details.

Now we have different lanaguage implementation of Omega

Get Started

  • For ServiceComb Java Chassis application, please see Booking Demo for details.
  • For Spring applications, please see Booking Demo for details.
  • For Dubbo applications, please see Dubbo Demo for details.
  • For TCC with Spring application, please see Tcc Demo for details.
  • To debug the applications, please see Spring Demo Debugging for details.

Build and Run the tests from source

Current ServiceComb Pack code supports Spring Boot 1.x and Spring Boot 2.x at the same time, you can use -Pspring-boot-1, -Pspring-boot-1 to switch Spring Boot version. Since Spring Boot supports JDK9+ from 2.x, if you want to build and run tests of ServiceComb Pack with JDK9 or JDK10, please use the spring-boot-2 profile. Please run the flowing comment from the root directory of ServiceComb Pack.

  • Build the source code and run the tests
       $ mvn clean install -Pspring-boot-2
    
  • Build the source demo docker images and run the accept tests
       $ mvn clean install -Pdemo,spring-boot-2
    
  • Build the source code and docker images without running tests, the docker profile will be activated if the maven detects the docker installation.
       $ mvn clean install -DskipTests=true -Pdemo,spring-boot-2
    
  • Build the release kit for distribution without running the tests, then you can find the release kits in the distribution/target directory.
       $ mvn clean install -DskipTests=true -Prelease
    

User Guide

How to build and use can refer to User Guide.

Get The Latest Version

Get released version:

Get snapshot version:

  • We publish the snapshot version to Apache nexus repo, please add below repositories into your pom.xml.
            <repositories>
              <repository>
                <releases />
                <snapshots>
                  <enabled>true</enabled>
                </snapshots>
                <id>repo.apache.snapshot</id>
                <url>https://repository.apache.org/content/repositories/snapshots/</url>
              </repository>
            </repositories>
            <pluginRepositories>
              <pluginRepository>
                <releases />
                <snapshots>
                  <enabled>true</enabled>
                </snapshots>
                <id>repo.apache.snapshot</id>
                <url>https://repository.apache.org/content/repositories/snapshots/</url>
              </pluginRepository>
            </pluginRepositories>
    
    
    

FAQ

Contact Us

Contributing

See Pull Request Guide for details.

Stargazers over time

Stargazers over time

License

Licensed under an Apache 2.0 license.