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 <dagang...@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-subscr...@servicecomb.incubator.apache.org)
[dev](https://lists.apache.org/list.html?d...@servicecomb.apache.org)
+## Contact Us
+* [issues](https://issues.apache.org/jira/browse/SCB)
+* [gitter](https://gitter.im/ServiceCombUsers/Lobby)
+* mailing list:
[subscribe](mailto:dev-subscr...@servicecomb.incubator.apache.org)
[view](https://lists.apache.org/list.html?d...@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-subscr...@servicecomb.incubator.apache.org)
[dev](https://lists.apache.org/list.html?d...@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
ningji...@apache.org.
