docc-lab
diff --git a/‎CHANGELOG-1.0.md
+159 b/‎CHANGELOG-1.0.md
+159
diff --git a/‎Makefile
+19-1 b/‎Makefile
+19-1
diff --git a/‎README.md
+48-30 b/‎README.md
+48-30
@@ -0,0 +1,159 @@
+
+
+   * [v1.0.0](#v100-beta0)
+      * [Deploy v1.0.0](#deploy-v1.0.0)
+         * [For Quick Start](#for-quick-start)
+         * [Deploy Mysql Clusters For Each Services](#deploy-mysql-clusters-for-each-services)
+         * [With Moinitorig](#with-moinitorig)
+         * [With Distributed Tracing](#with-distributed-tracing)
+         * [Deploy All](#deploy-all)
+         * [Customise Deployment](#customise-deployment)
+         * [Reset Deployment](#reset-deployment)
+
+      * [Changelog since 0.2.1](#changelog-since-v021)
+         * [Features Added](#features-added)
+         * [Notable Changes](#notable-changes)
+         * [Test Support](#test-support)
+         * [Bug fix](#bug-fix)
+         
+         
+# v1.0.0
+
+## Deploy v1.0.0
+
+### For Quick Start
+```bash
+git clone https://github.com/FudanSELab/train-ticket.git release-1.0.0
+cd train-ticket
+make deploy
+
+```
+
+Note: if you want specify namespace, set Namespace paramter:
+
+```bash
+make deploy Namespace=yournamespace
+```
+
+### Deploy Mysql Clusters For Each Services
+
+```bash
+git clone https://github.com/FudanSELab/train-ticket.git release-1.0.0
+cd train-ticket
+make deploy DeployArgs="--independent-db"
+```
+
+### With Moinitorig
+```bash
+git clone https://github.com/FudanSELab/train-ticket.git release-1.0.0
+cd train-ticket
+make deploy DeployArgs="--with-monitoring"
+```
+
+### With Distributed Tracing
+```bash
+git clone https://github.com/FudanSELab/train-ticket.git release-1.0.0
+cd train-ticket
+make deploy DeployArgs="--with-tracing"
+```
+
+### Deploy All 
+```bash
+git clone https://github.com/FudanSELab/train-ticket.git release-1.0.0
+cd train-ticket
+make deploy DeployArgs="--all"
+```
+
+### Customise Deployment
+You can freely combine parameters for custom deployment， for example, deploy with monitoring and tracing:
+
+```bash
+git clone https://github.com/FudanSELab/train-ticket.git release-1.0.0
+cd train-ticket
+make deploy DeployArgs="--with-tracing --with-monitoring"
+```
+
+### Reset Deployment
+
+```
+make reset-deploy
+# if you specify namespace when deploy, set namespace as well when reset
+# make reset-deploy Namespace=yournamespace
+```
+
+## Changelog since v0.2.1
+
+### Features Added 
+
+**Service Discovery: Nacos**
+
+Use nacos as service register and discovery component.
+
+Nacos use mysql cluster to store config information. 
+
+We use nacos 2.0.1 version, for more infromation of nacos, to see: [https://nacos.io/zh-cn/docs/what-is-nacos.html
+](https://nacos.io/zh-cn/docs/what-is-nacos.html)
+
+**Gateway**
+
+Using gateway as the only entry point for all service calls. A series of cross-cutting functions can be completed in the service gateway, such as permission verification, current limiting and monitoring, etc., which can be completed through filters.
+
+We use spring-cloud-gateway to implement the gateway function.
+
+**Flow Control: Sentinel**
+
+We use Sentinel to implement the flow control for gateway.  For now, the flow control rule is simply defined in route level. We simply limited the QPS towards admin-basic-info-service to no more than 20.
+
+To customize the flow control rule, update the configuration for Sentinel in `GatewayConfiguration.java` file.
+
+**Monitoring: Promethues+Grafana Deployment**
+
+We support prometheus + grafana solution in k8s deployment.
+
+The deployment manifests of prometheus are located at：deployment/kubernetes-manifests/prometheus
+
+**Distributed Tracing: Skywalking+ES Supoort**
+
+We support skywalking + es solution in k8s deployment.
+
+The deployment manifests of prometheus are located at：deployment/kubernetes-manifests/skywalking
+
+
+### Notable Changes
+
+**Log Format Unification**
+
+Unified log format for all services
+
+**Framework Upgrade**
+
+Upgrade spring-boot version from 1.5.0 to 2.3.12.RELEASE.
+
+Upgrade related dependency of services.
+
+**Data Structrue Redesign**
+
+Extract the common data structure of the service and put it in ts-common, instead of redefining them each service once. And data field naming is normalized.
+
+**Dynamic Service Configuration**
+
+Each service can dynamically configure its own database information, service discovery information, message queue information etc., (k8s deployment through configmap and secret, docker-compose deployment through environment variables) without the need to repackage the image.
+
+**Mysql Cluster Mode Support**
+
+Because the relational nature of the train ticket business is complex, we use a relational database, ie mysql. To support clustered deployment of mysql, we use randondb's solution for mysql deployment. For more details, see: [https://radondb.io/](https://radondb.io/)
+
+### Test Support
+
+We provide test scripts for functional and performance testing of train-tickets. The script provides some scenarios, such as administrator_operations, normal_query_and_booking, rebooking, rebooking_failure, search_failure, and consign_preserve.
+At the same time, the script supports qos parameter setting, which can easily implement performance testing.
+Access test scripts at: [https://github.com/FudanSELab/train-ticket-auto-query ](https://github.com/FudanSELab/train-ticket-auto-query)
+
+
+### Bug Fix
+
+* update order failed by the administrator.
+* delete order failed by the administrator.
+* delete user failed by the administrator. 
+* delete price failed by the administrator.
+* delete station failed by the administrator.
@@ -2,14 +2,17 @@
 
 Repo=codewisdom
 Tag=latest
+Namespace="default"
+DeployArgs=""
+
 
 # build image
 .PHONY: build
 build: clean-image package build-image
 
 .PHONY: package
 package:
-	@mvn clean package -DskipTests
+	@mvn clean package -Dmaven.test.skip=true
 
 .PHONY: build-image
 build-image:
@@ -24,6 +27,21 @@ push-image:
 publish-image:
 	@script/publish-docker-images.sh $(Repo) $(Tag)
 
+# deploy
+# DeployArgs ""                    : deploy train-ticket with all-in-one mysql cluster
+# DeployArgs "--independent-db"    : deploy train-ticket with mysql cluster each service
+# DeployArgs "--with-monitoring"   : deploy train-ticket with prometheus
+# DeployArgs "--with-tracing"      : deploy train-ticket with skywalking
+# DeployArgs "--all"               : deploy train-ticket with mysql cluster each service
+.PHONY: deploy
+deploy:
+	@hack/deploy/deploy.sh $(Namespace) "$(DeployArgs)"
+
+# deploy
+.PHONY: reset-deploy
+reset-deploy:
+	@hack/deploy/reset.sh $(Namespace)
+
 .PHONY: clean
 clean:
 	@mvn clean
 
@@ -14,66 +14,84 @@ You can get more details at [Wiki Pages](https://github.com/FudanSELab/train-tic
 ![architecture](./image/2.png)
 
 ## Quick Start
-We provide two options to quickly deploy our application: [Using Docker Compose](#Using-Docker-Compose) and [Using Kubernetes](#Using-Kubernetes).
+We provide k8s deployment to quickly deploy our application:  [Using Kubernetes](#Using-Kubernetes).
 
-### Using Docker Compose
-The easiest way to get start with the Train Ticket application is by using [Docker](https://www.docker.com/) and [Docker Compose](https://docs.docker.com/compose/).
-
-> If you don't have Docker and Docker Compose installed, you can refer to [the Docker website](https://www.docker.com/) to install them.
+### Using Kubernetes
+Here is the steps to deploy the Train Ticket onto any existing Kubernetes cluster.
 
 #### Presequisite
-* Docker
-* Docker Compose
+* An existing Kubernetes cluster
+* Helm supported, you can see https://helm.sh/docs/helm/helm_install/ for helm install
+* PVC supported, you can see https://openebs.io/docs/2.12.x/user-guides/installation for localPV support.
 
 #### 1. Clone the Repository
 ```bash
-git clone --depth=1 https://github.com/FudanSELab/train-ticket.git
+git clone --depth=1 https://github.com/FudanSELab/train-ticket.git 
 cd train-ticket/
 ```
 
-#### 2. Start the Application
+#### 2. Deploy the application
+### For Quick Start
 ```bash
-docker-compose -f deployment/docker-compose-manifests/quickstart-docker-compose.yml up
+make deploy
+
 ```
-Once the application starts, you can visit the Train Ticket web page at [http://localhost:8080](http://localhost:8080).
 
-### Using Kubernetes
-Here is the steps to deploy the Train Ticket onto any existing Kubernetes cluster.
+Note: if you want specify namespace, set Namespace paramter:
 
-#### Presequisite
-* An existing Kubernetes cluster
+```bash
+make deploy Namespace=yournamespace
+```
+
+### Deploy Mysql Clusters For Each Services
 
-#### 1. Clone the Repository
 ```bash
-git clone --depth=1 https://github.com/FudanSELab/train-ticket.git
-cd train-ticket/
+make deploy DeployArgs="--independent-db"
 ```
 
-#### 2. Deploy the application
+### With Moinitorig
 ```bash
-cd deployment/kubernetes-manifests/quickstart-k8s
-
-# Deploy the databases
-kubectl apply -f quickstart-ts-deployment-part1.yml
-# Deploy the services
-kubectl apply -f quickstart-ts-deployment-part2.yml
-# Deploy the UI Dashboard
-kubectl apply -f quickstart-ts-deployment-part3.yml
+make deploy DeployArgs="--with-monitoring"
+```
+
+### With Distributed Tracing
+```bash
+make deploy DeployArgs="--with-tracing"
+```
+
+### Deploy All 
+```bash
+make deploy DeployArgs="--all"
+```
+
+### Customise Deployment
+You can freely combine parameters for custom deployment， for example, deploy with monitoring and tracing:
+
+```bash
+make deploy DeployArgs="--with-tracing --with-monitoring"
+```
+
+### Reset Deployment
+
+```
+make reset-deploy
+# if you specify namespace when deploy, set namespace as well when reset
+# make reset-deploy Namespace=yournamespace
 ```
 
 #### 3. Run `kubectl get pods` to see pods are in a ready state
 
 #### 4. Visit the Train Ticket web page at [http://[Node-IP]:32677](http://[Node-IP]:32677).
 
-### More Deployment Ways
-
-There are many other quick deployment ways in [deployment folder](<https://github.com/FudanSELab/train-ticket/tree/master/deployment>).  For example, you can deploy this system [with Jaeger](<https://github.com/FudanSELab/train-ticket/tree/master/deployment/kubernetes-manifests/k8s-with-jaeger>), and then visit the Jaeger Webpage to view traces.
 
 ## Build From Source
 In the above, We use pre-built images to quickly deploy the application.
 
 If you want to build the application from source, you can refer to [the Installation Guide](https://github.com/FudanSELab/train-ticket/wiki/Installation-Guide).
 
+## test scripts
+Use scripts to test train-ticket: [https://github.com/FudanSELab/train-ticket-auto-query](https://github.com/FudanSELab/train-ticket-auto-query)
+
 ## Screenshot
 ![screenshot](./image/main_interface.png)
 In order to know how to use the application, you can refer to [the User Guide](https://github.com/FudanSELab/train-ticket/wiki/User-Guide).