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/02/08 08:58:54 UTC
[incubator-servicecomb-saga] branch master updated (bc3879f ->
099d347)
This is an automated email from the ASF dual-hosted git repository.
ningjiang pushed a change to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-servicecomb-saga.git.
from bc3879f SCB-239 handle timeout in EventScanner
new fd66424 SCB-330 add README for pack
new 099d347 SCB-330 add design document
The 2 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
README.md | 92 ++++++----------------
docs/design.md | 31 ++++++++
README.md => docs/old_saga.md | 27 +------
docs/static_files/exception_scenario.png | Bin 0 -> 49821 bytes
docs/static_files/inter-service_communication.png | Bin 0 -> 18719 bytes
docs/static_files/omega_internal.png | Bin 0 -> 22521 bytes
docs/static_files/pack.png | Bin 0 -> 10413 bytes
docs/static_files/successful_scenario.png | Bin 0 -> 47326 bytes
docs/static_files/timeout_scenario.png | Bin 0 -> 44045 bytes
saga-demo/pack-demo/README.md | 12 +++
10 files changed, 71 insertions(+), 91 deletions(-)
mode change 100755 => 100644 README.md
create mode 100644 docs/design.md
copy README.md => docs/old_saga.md (57%)
create mode 100644 docs/static_files/exception_scenario.png
create mode 100644 docs/static_files/inter-service_communication.png
create mode 100644 docs/static_files/omega_internal.png
create mode 100644 docs/static_files/pack.png
create mode 100644 docs/static_files/successful_scenario.png
create mode 100644 docs/static_files/timeout_scenario.png
--
To stop receiving notification emails like this one, please contact
ningjiang@apache.org.
[incubator-servicecomb-saga] 02/02: SCB-330 add design document
Posted by ni...@apache.org.
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 099d347d5103058638bee6c0dd16b8f3e95c1360
Author: Eric Lee <da...@huawei.com>
AuthorDate: Thu Feb 8 15:45:34 2018 +0800
SCB-330 add design document
Signed-off-by: Eric Lee <da...@huawei.com>
---
docs/design.md | 31 ++++++++++++++++++++++
docs/static_files/exception_scenario.png | Bin 0 -> 49821 bytes
docs/static_files/inter-service_communication.png | Bin 0 -> 18719 bytes
docs/static_files/omega_internal.png | Bin 0 -> 22521 bytes
docs/static_files/successful_scenario.png | Bin 0 -> 47326 bytes
docs/static_files/timeout_scenario.png | Bin 0 -> 44045 bytes
6 files changed, 31 insertions(+)
diff --git a/docs/design.md b/docs/design.md
new file mode 100644
index 0000000..625cb95
--- /dev/null
+++ b/docs/design.md
@@ -0,0 +1,31 @@
+# Saga Pack Design
+## Overview
+Pack contains two components: *alpha* and *omega*. Alpha is the pack leader and backed by database to make sure transaction events stored permanently while omega is the pack worker and embeded inside services to intercept incoming/outgoing requests and report events to alpha.
+
+
+
+## Omega Internal
+Omega plays as an embeded agent inside services. When a request arrives, omega intercepts its header and retrieve the global transaction id as its global transaction id and retrieve the local transaction id as its parent transaction id. In pre-process phase, a transaction started event will be recorded in alpha. In post-process phase, a transaction ended event will be recorded in alpha to mark the end of the sub-transaction.
+
+
+
+## Inter-Service Communication
+The process of Inter-Service Communication is similiar to [Zipkin](https://github.com/openzipkin/zipkin)'s. In the producer side, omega intercepts the transaction ids from request to retrieve the transaction context. In the consumer side, omega inject the transaction ids into request to pass the transaction context. Sub-transactions can chain as a single global transaction by co-operating producers and consumers.
+
+
+
+## Workflow
+### Successful Scenario
+In a successful scenario, all started events will have a corresponding ended event.
+
+
+
+### Exception Scenario
+In an exception scenario, omega inside the abnormal service will report an aborted event to alpha. Apha will then send compensate commands to the completed events within the global transaction to make suer all sub-transactions are either completed or rollbacked.
+
+
+
+### Timeout Scenario
+In timeout scenario, timeouted events will be detected by alpha's periodly scanner and abort the corresponding global transaction.
+
+
diff --git a/docs/static_files/exception_scenario.png b/docs/static_files/exception_scenario.png
new file mode 100644
index 0000000..a8738ba
Binary files /dev/null and b/docs/static_files/exception_scenario.png differ
diff --git a/docs/static_files/inter-service_communication.png b/docs/static_files/inter-service_communication.png
new file mode 100644
index 0000000..11d8dff
Binary files /dev/null and b/docs/static_files/inter-service_communication.png differ
diff --git a/docs/static_files/omega_internal.png b/docs/static_files/omega_internal.png
new file mode 100644
index 0000000..1f130a2
Binary files /dev/null and b/docs/static_files/omega_internal.png differ
diff --git a/docs/static_files/successful_scenario.png b/docs/static_files/successful_scenario.png
new file mode 100644
index 0000000..5dd8850
Binary files /dev/null and b/docs/static_files/successful_scenario.png differ
diff --git a/docs/static_files/timeout_scenario.png b/docs/static_files/timeout_scenario.png
new file mode 100644
index 0000000..998cfcf
Binary files /dev/null and b/docs/static_files/timeout_scenario.png differ
--
To stop receiving notification emails like this one, please contact
ningjiang@apache.org.
[incubator-servicecomb-saga] 01/02: SCB-330 add README for pack
Posted by ni...@apache.org.
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 fd66424b1247c0cff5a39ac09ed0b6974aa8dec0
Author: Eric Lee <da...@huawei.com>
AuthorDate: Thu Feb 8 14:28:01 2018 +0800
SCB-330 add README for pack
---
README.md | 92 ++++++++++++------------------------------
README.md => docs/old_saga.md | 27 +------------
docs/static_files/pack.png | Bin 0 -> 10413 bytes
saga-demo/pack-demo/README.md | 12 ++++++
4 files changed, 40 insertions(+), 91 deletions(-)
diff --git a/README.md b/README.md
old mode 100755
new mode 100644
index 9a7249f..fd569ea
--- a/README.md
+++ b/README.md
@@ -1,76 +1,36 @@
# Saga [](https://travis-ci.org/apache/incubator-servicecomb-saga?branch=master) [](https://coveralls.io/github/apache/incubator-servicecomb-saga?branch=master) [](https://www.apache.org/licenses/LICENSE-2.0.html)
-Apache ServiceComb (incubating) Saga is a type of Compensating Transaction pattern, which provides a simple way to help users solve the data consistency problems encountered in micro-service applications.
+Apache ServiceComb (incubating) Saga is an eventually data consistency solution for micro-service applications. Transactions are commited directly in the try phase and compensated in reverse order in the rollback phase comparing to [TCC](http://design.inf.usi.ch/sites/default/files/biblio/rest-tcc.pdf).
-## Documentation
-Reference documentation is available on the [ServiceComb website][servicecomb-website].
+## 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.
+* Supported micro-service frameworks:
+ + Spring Cloud
+* Support both forward(retry) and backward(compensate) recovery.
-[servicecomb-website]: http://servicecomb.incubator.apache.org/
+## Architecture
+Saga 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.
-## Major Architecture of Saga
-* saga-core(transaction and compensation handling logic)
-* saga-format(data serialization and deserialization)
-* saga-transports(communication protocol implementation such as rest or rpc in the future)
-* saga-discovery(service discovery)
-* saga-spring(restful service framework)
+The following diagram shows the relationships among alpha, omega and services.
+
-
+See [Saga Pack Design](docs/design.md) for details. If you are interested in our previous architecture, please move forward to [Old Saga's Documentation](docs/old_saga.md).
-## Prerequisites
-You will need:
-1. [Oracle JDK 1.8+][jdk]
-2. [Maven 3.x][maven]
-3. [Docker][docker]
-4. [PostgreSQL][postgres]
-5. [Service Center(optional)][service_center]
-6. [Docker compose(optional)][docker_compose]
-7. [Docker machine(optional)][docker_machine]
+## Get Started
+See [Booking Demo](saga-demo/pack-demo/README.md) for details.
-
-[jdk]: http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html
-[maven]: https://maven.apache.org/install.html
-[docker]: https://www.docker.com/get-docker
-[postgres]: https://www.postgresql.org/download/
-[service_center]: https://github.com/apache/incubator-servicecomb-service-center
-[docker_compose]: https://docs.docker.com/compose/install/
-[docker_machine]: https://docs.docker.com/machine/install-machine/
-
-
-
-## Building
-Download the source code.
-```
-git clone https://github.com/apache/incubator-servicecomb-saga.git
-```
-
-Enter the Saga root directory,build Saga project by maven command and generate a docker image named saga-spring in local.
-```
-mvn package -DskipTests -Pdocker
-```
-
-## Run Services
-A `docker-compose.yaml` file is provided to start Saga services and its dependencies(Service center and Mysql) as docker containers.
-User also can configure specified Service center or Mysql in `docker-compose.yaml`.
-
-Enter the Saga root directory, run all service images using command,
-```
-docker-compose up
-```
-
-
-## Reference API
-See [Saga API](docs/api/api.md) for details.
-
-
-## Example
-See [Saga demo](https://github.com/apache/incubator-servicecomb-saga/tree/master/saga-demo) for details.
-
-## Contact
-Bugs: [issues](https://issues.apache.org/jira/browse/SCB).
-
-Mailing lists: [subscribe](mailto:dev-subscribe@servicecomb.incubator.apache.org) [dev](https://lists.apache.org/list.html?dev@servicecomb.apache.org)
+## Contact Us
+* [issues](https://issues.apache.org/jira/browse/SCB)
+* [gitter](https://gitter.im/ServiceCombUsers/Lobby)
+* mailing list: [subscribe](mailto:dev-subscribe@servicecomb.incubator.apache.org) [view](https://lists.apache.org/list.html?dev@servicecomb.apache.org)
## Contributing
-See [Pull Request Guide](http://servicecomb.io/developers/submit-codes/) for details.
+See [Pull Request Guide](http://servicecomb.incubator.apache.org/developers/submit-codes/) for details.
-## Reporting Issues
-See reporting bugs for details about reporting any issues.
+## License
+Licensed under an [Apache 2.0](https://github.com/apache/incubator-servicecomb-saga/blob/master/LICENSE) license.
diff --git a/README.md b/docs/old_saga.md
similarity index 57%
copy from README.md
copy to docs/old_saga.md
index 9a7249f..2b79d22 100755
--- a/README.md
+++ b/docs/old_saga.md
@@ -1,11 +1,4 @@
-# Saga [](https://travis-ci.org/apache/incubator-servicecomb-saga?branch=master) [](https://coveralls.io/github/apache/incubator-servicecomb-saga?branch=master) [](https://www.apache.org/licenses/LICENSE-2.0.html)
-Apache ServiceComb (incubating) Saga is a type of Compensating Transaction pattern, which provides a simple way to help users solve the data consistency problems encountered in micro-service applications.
-
-## Documentation
-Reference documentation is available on the [ServiceComb website][servicecomb-website].
-
-[servicecomb-website]: http://servicecomb.incubator.apache.org/
-
+# Previous Saga's Documentation
## Major Architecture of Saga
* saga-core(transaction and compensation handling logic)
* saga-format(data serialization and deserialization)
@@ -13,7 +6,7 @@ Reference documentation is available on the [ServiceComb website][servicecomb-we
* saga-discovery(service discovery)
* saga-spring(restful service framework)
-
+
## Prerequisites
You will need:
@@ -25,7 +18,6 @@ You will need:
6. [Docker compose(optional)][docker_compose]
7. [Docker machine(optional)][docker_machine]
-
[jdk]: http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html
[maven]: https://maven.apache.org/install.html
[docker]: https://www.docker.com/get-docker
@@ -34,8 +26,6 @@ You will need:
[docker_compose]: https://docs.docker.com/compose/install/
[docker_machine]: https://docs.docker.com/machine/install-machine/
-
-
## Building
Download the source code.
```
@@ -56,21 +46,8 @@ Enter the Saga root directory, run all service images using command,
docker-compose up
```
-
## Reference API
See [Saga API](docs/api/api.md) for details.
-
## Example
See [Saga demo](https://github.com/apache/incubator-servicecomb-saga/tree/master/saga-demo) for details.
-
-## Contact
-Bugs: [issues](https://issues.apache.org/jira/browse/SCB).
-
-Mailing lists: [subscribe](mailto:dev-subscribe@servicecomb.incubator.apache.org) [dev](https://lists.apache.org/list.html?dev@servicecomb.apache.org)
-
-## Contributing
-See [Pull Request Guide](http://servicecomb.io/developers/submit-codes/) for details.
-
-## Reporting Issues
-See reporting bugs for details about reporting any issues.
diff --git a/docs/static_files/pack.png b/docs/static_files/pack.png
new file mode 100644
index 0000000..2c30c00
Binary files /dev/null and b/docs/static_files/pack.png differ
diff --git a/saga-demo/pack-demo/README.md b/saga-demo/pack-demo/README.md
index 1e8d700..9eecd62 100644
--- a/saga-demo/pack-demo/README.md
+++ b/saga-demo/pack-demo/README.md
@@ -4,6 +4,18 @@ This demo simulates a booking application including three services:
* pack-car
* pack-hotel
+## Prerequisites
+You will need:
+1. [JDK 1.8][jdk]
+2. [Maven 3.x][maven]
+3. [Docker][docker]
+4. [Docker compose][docker_compose]
+
+[jdk]: http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html
+[maven]: https://maven.apache.org/install.html
+[docker]: https://www.docker.com/get-docker
+[docker_compose]: https://docs.docker.com/compose/install/
+
## Running Demo
1. run the following command to create docker images in saga project root folder.
```
--
To stop receiving notification emails like this one, please contact
ningjiang@apache.org.