Merge pull request #13 from cam-inc/feature/fix-README

Fix: README

README.md

@@ -2,6 +2,8 @@
 
 MxTransporter is a middleware that accurately carries change streams of MongoDB in real time. For infrastructure, you can easily use this middleware by creating a container image with Dockerfile on any platform and deploying it.
 
+With MxTransporter, real-time data can be reproduced and retained on the data utilization side, and data utilization will become even more active.
+
 :jp: Japanese version of the README is [here](/README_JP.md).
 
 [![MIT License](http://img.shields.io/badge/license-MIT-blue.svg?style=flat)](LICENSE)

README_JP.md

@@ -2,6 +2,8 @@
 
 MxTransporter は MongoDB の Change Streams を正確に、リアルタイムで送信先に運ぶミドルウェアです。MxTransporter は、用意された Dockerfile からコンテナイメージを作成し、お好きな環境へデプロイすることで簡単に利用することができます。
 
+MxTransporterにより、データ活用側でリアルタイムなデータを再現、保持でき、データ活用がより一層活発になるでしょう。
+
 [![MIT License](http://img.shields.io/badge/license-MIT-blue.svg?style=flat)](LICENSE)
 [![Coverage](https://sonarcloud.io/api/project_badges/measure?project=cam-inc_MxTransporter&metric=coverage)](https://sonarcloud.io/summary/new_code?id=cam-inc_MxTransporter)
 <br>

docs/aws/eks/.env.template

@@ -33,6 +33,9 @@ EKS_SUBNET_B=
 ##################################
 ## Helm variables
 ##################################
+## specify directory that saved resume token in
+PERSISTENT_VOLUME_DIR=
+
 ### target MongoDB collections (Uppercase)
 ## e.g.
 ## TARGET_MONGODB_COLLECTION_<DATABASE NAME>__<COLLECTION NAME>=<DATABASE NAME>__<COLLECTION NAME>

docs/aws/eks/secrets.env.template

@@ -33,11 +33,11 @@ LOG_LEVEL=
 ### Specify log format, json or console. default is json.
 ### e.g. LOG_FORMAT=console
 LOG_FORMAT=
-### Specify log output Directory.
+### Specify log output Directory. If not specified, it will be output to stdout.
 ### e.g. LOG_OUTPUT_PATH=/var/log/
 ### e.g. LOG_OUTPUT_PATH=../../var/log/
 LOG_OUTPUT_DIRECTORY=
-### Specify log output File.
+### Specify log output File. If not specified, it will be output to stdout.
 ### e.g. LOG_OUTPUT_FILE=mxt.log
 LOG_OUTPUT_FILE=
 

docs/gcp/gke/.env.template

@@ -25,6 +25,7 @@ GKE_CLUSTER_VERSION=
 GKE_NODE_LOCATION_1=
 GKE_NODE_LOCATION_2=
 GKE_NODE_LOCATION_3=
+GKE_NODE_MACHINE_TYPE=
 GKE_CLUSTER_MASTER_IP_CIDR_BLOCK=
 GKE_PODS_IP_CIDR_BLOCK=
 
@@ -35,6 +36,9 @@ KUBERNETES_SECRET_NAME=
 ##################################
 ## Helm variables
 ##################################
+## specify directory that saved resume token in
+PERSISTENT_VOLUME_DIR=
+
 ## target MongoDB collections (Uppercase and kebab-case)
 ## e.g.
 ## TARGET_MONGODB_COLLECTION_<DATABASE NAME>__<COLLECTION NAME>=<DATABASE NAME>__<COLLECTION NAME>

docs/gcp/gke/Makefile

@@ -86,6 +86,9 @@ attach-role-to-service-account:
 	gcloud projects add-iam-policy-binding $(PROJECT_NAME) \
 			--member="serviceAccount:mxtransporter@$(PROJECT_NAME).iam.gserviceaccount.com" \
 			--role="roles/logging.admin"
+	gcloud projects add-iam-policy-binding $(PROJECT_NAME) \
+			--member="serviceAccount:mxtransporter@$(PROJECT_NAME).iam.gserviceaccount.com" \
+			--role="roles/storage.admin"
 
 	@echo "attach role to service accountin $(PROJECT_NAME_TO_EXPORT_CHANGE_STREAMS) ..."
 	gcloud projects add-iam-policy-binding $(PROJECT_NAME_TO_EXPORT_CHANGE_STREAMS) \

docs/gcp/gke/README_JP.md

@@ -122,7 +122,7 @@ $ make secrets
 
 **3. Kubernetes リソースをデプロイする**
 
-もしオプションの環境変数を```.secrets.env```セットしたのであれば、```./templates/stateless.yaml```内の env パラメータを編集します。Kubernetes で実行されているコンテナに必要な環境変数のみを設定します。
+もしオプションの環境変数を```.secrets.env```にセットしたのであれば、```./templates/stateless.yaml```内の env パラメータを編集します。Kubernetes で実行されているコンテナに必要な環境変数のみを設定します。
 
 Kubernetes リソースは helm によって作成されます。
 
@@ -133,9 +133,7 @@ $ make deploy
 ```
 
 このコマンドでは、以下のような処理が行われます。<br>
-・Docker イメージビルド<br>
-・ECR リポジトリへのログイン<br>
-・ECR リポジトリへ Docker イメージを送信<br>
+・GCR リポジトリへ Docker イメージを送信<br>
 ・helm の variables を作成します<br>
 ・helm テンプレートをデプロイする<br>
 

docs/gcp/gke/deployment-manager/gke.sh

@@ -33,7 +33,7 @@ resources:
               autoUpgrade: False
               autoRepair: True
             config:
-              machineType: n1-standard-1
+              machineType: $GKE_NODE_MACHINE_TYPE
               localSsdCount: 0
               diskSizeGb: 100
               preemptible: False

docs/gcp/gke/secrets.env.template

@@ -37,11 +37,11 @@ LOG_LEVEL=
 ### Specify log format, json or console. default is json.
 ### e.g. LOG_FORMAT=console
 LOG_FORMAT=
-### Specify log output Directory.
+### Specify log output Directory. If not specified, it will be output to stdout.
 ### e.g. LOG_OUTPUT_PATH=/var/log/
 ### e.g. LOG_OUTPUT_PATH=../../var/log/
 LOG_OUTPUT_DIRECTORY=
-### Specify log output File.
+### Specify log output File. If not specified, it will be output to stdout.
 ### e.g. LOG_OUTPUT_FILE=mxt.log
 LOG_OUTPUT_FILE=