chore: installation scripts (#16)

1. remove 1.0.126 version from markdown guide
2. add environment variables support in installation scripts
3. mariadb1 -> mariadb
4. add set -e in installation scripts

cherry pick from: #11

Author: Wu Wenxiang

README.md

@@ -35,19 +35,19 @@ application scenarios, enabling autonomous driving and autonomous transportation
 
 ![](src/images/v2x-arch-details.svg)
 
-- [OpenV2X 1.0.126 Architectural Design](src/v2x-1.0.126-architectural-design.md)
+- [OpenV2X Architectural Design](src/v2x-architectural-design.md)
 
 ## Quick Install
 
-- [OpenV2X 1.0.126 QuickInstall Guide](src/v2x-1.0.126-quick-install.md)
+- [OpenV2X QuickInstall Guide](src/v2x-quick-install.md)
 
 ## Quick Start
 
-- [OpenV2X 1.0.126 QuickStart Guide](src/v2x-1.0.126-quick-start.md)
+- [OpenV2X QuickStart Guide](src/v2x-quick-start.md)
 
 ## Documents
 
-- [OpenV2X 1.0.126 Algorithm Documents](src/v2x-1.0.126-algorithm.md)
+- [OpenV2X Algorithm Documents](src/v2x-algorithm.md)
 
 ## Contributing
 

src/deploy/docker-compose-pre.yaml

@@ -2,7 +2,7 @@ version: '2.4'
 services:
  mariadb:
   image: 'mariadb:10.5.5'
-  container_name: 'mariadb1'
+  container_name: 'mariadb'
   restart: 'always'
   environment:
    MYSQL_USER: 'dandelion'

src/install.sh

@@ -1,83 +1,88 @@
 #!/bin/sh
-# set -e # TODO
+set -e
 
-unalias cp 2>/dev/null
+unalias cp 2>/dev/null || true
 alias docker-compose='docker compose'
 
-set_password() {
-  read -p "Enter your openv2x external ip: " ip
-  read -p "Enter your redis root password (do not include @): " redis_root
-  read -p "Enter your mariadb1 root password (do not include @): " mariadb1_root # TODO add url encode
-  read -p "Enter your mariadb1 dandelion password (do not include @): " mariadb1_dandelion
-  read -p "Enter your emqx root password (do not include @): " emqx_root
+set_env() {
+  [[ ! -n "$external_ip" ]] && read -p "Enter your openv2x external ip: " external_ip
+  [[ ! -n "$redis_root" ]] && read -p "Enter your redis root password (do not include @): " redis_root
+  [[ ! -n "$mariadb_root" ]] && read -p "Enter your mariadb root password (do not include @): " mariadb_root # TODO add url encode
+  [[ ! -n "$mariadb_dandelion" ]] && read -p "Enter your mariadb dandelion password (do not include @): " mariadb_dandelion
+  [[ ! -n "$emqx_root" ]] && read -p "Enter your emqx root password (do not include @): " emqx_root
+
+  echo "export external_ip=$external_ip"
+  echo "export redis_root=$redis_root"
+  echo "export mariadb_root=$mariadb_root"
+  echo "export mariadb_dandelion=$mariadb_dandelion"
+  echo "export emqx_root=$emqx_root"
 }
 
 verify_input() {
-  if [ ! -n "$ip" ] ;then
+  if [[ ! -n "$external_ip" ]] ;then
     echo "you have not input openv2x external ip!"
     exit 1
   fi
-  if [ ! -n "$redis_root" ] ;then
+  if [[ ! -n "$redis_root" ]] ;then
     echo "you have not input redis root password!"
     exit 1
   fi
-  if [ ! -n "$mariadb1_root" ] ;then
-    echo "you have not input mariadb1 root password!"
+  if [[ ! -n "$mariadb_root" ]] ;then
+    echo "you have not input mariadb root password!"
     exit 1
   fi
-  if [ ! -n "$mariadb1_dandelion" ] ;then
-    echo "you have not input mariadb1 dandelion password!"
+  if [[ ! -n "$mariadb_dandelion" ]] ;then
+    echo "you have not input mariadb dandelion password!"
     exit 1
   fi
-  if [ ! -n "$emqx_root" ] ;then
+  if [[ ! -n "$emqx_root" ]] ;then
     echo "you have not input emqx root password!"
     exit 1
   fi
-
 }
 
 verify_uninstall() {
-  containers=(redis emqx mariadb1 dandelion edgeview centerview cerebrum rse-simulator)
+  containers=(redis emqx mariadb dandelion edgeview centerview cerebrum rse-simulator)
   for i in ${containers[@]}; do
     docker stop $i 2>/dev/null || true
     docker rm $i 2>/dev/null || true
   done
 }
 
-set_env() {
+pre_install() {
   mkdir -pv /tmp/pre
   mkdir -pv /tmp/init
   mkdir -pv /tmp/service
   cp -f deploy/docker-compose-pre.yaml /tmp/pre/docker-compose-pre.yaml
   cp -f deploy/docker-compose-init.yaml /tmp/init/docker-compose-init.yaml
   cp -f deploy/docker-compose-service.yaml /tmp/service/docker-compose-service.yaml
-  sed -i "s/127.0.0.1/$ip/" /tmp/service/docker-compose-service.yaml
+  sed -i "s/127.0.0.1/$external_ip/" /tmp/service/docker-compose-service.yaml
   sed -i "s/redis12345/$redis_root/" /tmp/pre/docker-compose-pre.yaml
-  sed -i "s/mysql@1234/$mariadb1_root/" /tmp/pre/docker-compose-pre.yaml
-  sed -i "s/dandelion123/$mariadb1_dandelion/" /tmp/pre/docker-compose-pre.yaml
+  sed -i "s/mysql@1234/$mariadb_root/" /tmp/pre/docker-compose-pre.yaml
+  sed -i "s/dandelion123/$mariadb_dandelion/" /tmp/pre/docker-compose-pre.yaml
   sed -i "s/abc@1234/$emqx_root/" /tmp/pre/docker-compose-pre.yaml
   sed -i "s/abc@1234/$emqx_root/" /tmp/service/docker-compose-service.yaml
-  sed -i "s/mysql@1234/$mariadb1_root/" /tmp/service/docker-compose-service.yaml
+  sed -i "s/mysql@1234/$mariadb_root/" /tmp/service/docker-compose-service.yaml
   sed -i "s/redis12345/$redis_root/" /tmp/service/docker-compose-service.yaml
   cp -rf deploy/edgeview /etc/
   cp -rf deploy/centerview /etc/
   cp -rf deploy/dandelion /etc/
   sed -i "s/redis12345/$redis_root/" /etc/dandelion/dandelion.conf
-  sed -i "s/dandelion123/$mariadb1_dandelion/" /etc/dandelion/dandelion.conf
+  sed -i "s/dandelion123/$mariadb_dandelion/" /etc/dandelion/dandelion.conf
   sed -i "s/abc@1234/$emqx_root/" /etc/dandelion/dandelion.conf
   rm -rf /var/log/dandelion && mkdir -p /var/log/dandelion
   rm -rf /data && mkdir -pv /data
   cp -rf deploy/mysql /data/
-  sed -i "s/dandelion123/$mariadb1_dandelion/" /data/mysql/init/init.sql
+  sed -i "s/dandelion123/$mariadb_dandelion/" /data/mysql/init/init.sql
   touch /var/log/dandelion/dandelion.log
 }
 
 verify_mysql(){
   while true
   do
-    databases=`docker exec mariadb1 mysql -uroot -p$mariadb1_root -e 'show databases;' 2>/dev/null`
+    databases=`docker exec mariadb mysql -uroot -p$mariadb_root -e 'show databases;' 2>/dev/null || true`
     target="dandelion"
-    result=$(echo $databases | grep "${target}")
+    result=$(echo $databases | grep "${target}" || true)
     if [[ "$result" != "" ]]
     then
       break
@@ -92,7 +97,7 @@ verify_bootstrap(){
   do
     info=`docker ps -a | grep dandelion_bootstrap 2>/dev/null`
     status="Exited (0)"
-    result=$(echo $info | grep "${status}")
+    result=$(echo $info | grep "${status}" || true)
     if [[ "$result" != "" ]]
     then
       break
@@ -125,8 +130,8 @@ verify_install() {
     repository: https://github.com/open-v2x
     portal: https://openv2x.org
 
-  OpenV2X Edge Portal (Edgeview): http://$ip
-  OpenV2X Central Portal (Centerview): http://$ip:8080
+  OpenV2X Edge Portal (Edgeview): http://$external_ip
+  OpenV2X Central Portal (Centerview): http://$external_ip:8080
 
   username: admin
   password: dandelion
@@ -135,9 +140,9 @@ verify_install() {
 }
 
 {
-  set_password
+  set_env
   verify_input
   verify_uninstall
-  set_env
+  pre_install
   verify_install
 }

src/v2x-1.0.126-algorithm.md renamed to src/v2x-algorithm.md

@@ -1,4 +1,4 @@
-# V2X 算法文档
+# OpenV2X 算法文档
 
 ## 1.算法架构
 

src/v2x-1.0.126-architectural-design.md renamed to src/v2x-architectural-design.md

@@ -1,4 +1,4 @@
-# 架构设计文档
+# OpenV2X 架构设计文档
 
 ## 1. 设计架构图
 

src/v2x-1.0.126-quick-install.md renamed to src/v2x-quick-install.md

@@ -1,4 +1,4 @@
-# V2X 1.0.126 All in One 部署文档
+# OpenV2X All-in-One 部署文档
 
 ## 1. 基本环境
 
@@ -61,19 +61,19 @@ cd docs-albany/src/
 ## 5. 一键部署服务
 
 ```shell
+export external_ip=100.100.100.100
+# 这里的外部 IP 地址要确保客户端可以访问，用于后续 centerview 和 edgeview portal 访问
+export redis_root=password
+export mariadb_root=password
+export mariadb_dandelion=password
+export emqx_root=password
 sh ./install.sh
 ```
 
 安装效果如下：
 
 ```console
 [root@v2x-demo src]# sh ./install.sh 
-Enter your openv2x external ip: 100.100.100.100
-这里的外部 IP 地址要确保客户端可以访问，用于后续 centerview 和 edgeview portal 访问
-Enter your redis root password (do not include @): password
-Enter your mariadb1 root password (do not include @): password
-Enter your mariadb1 dandelion password (do not include @): password
-Enter your emqx root password (do not include @): password
 
 ...
 
@@ -96,7 +96,7 @@ Enter your emqx root password (do not include @): password
 
 上述提示中包含了 Edge Portal 和 Central Portal 的访问路径，以及用户名密码。此时可以从客户端，通过 Chrome 浏览器（其它浏览器未测试）访问试用。
 
-欢迎试用～，参考：[快速入门](v2x-1.0.126-quick-start.md)。
+欢迎试用～，参考：[快速入门](v2x-quick-start.md)。
 
 如果遇到问题，欢迎在 github 提交
 issue：<https://github.com/open-v2x/docs/issues/new/choose>，参考：[提交注意事项](v2x_contribution-zh_CN.md)。

src/v2x-1.0.126-quick-start.md renamed to src/v2x-quick-start.md

@@ -45,7 +45,7 @@ request** 按钮并按照模板要求填写必要的信息 ![](images/issues_but
 
 ### 开始之前
 
-查看[OpenV2X 架构设计文档](v2x-1.0.126-architectural-design.md)，了解组成 OpenV2X
+查看[OpenV2X 架构设计文档](v2x-architectural-design.md)，了解组成 OpenV2X
 的不同模块。选择最合适的一个来加入新功能。如果在此过程中出现任何问题，请随时与我们的团队联系。
 
 ### 代码规范

src/v2x_contribution-zh_CN.md

@@ -58,9 +58,9 @@ with the original repository.
 
 ### Before getting started
 
-Check out the [OpenV2X Architectural Design document](v2x-1.0.126-architectural-design.md) to get an
-idea on the different modules that compose OpenV2X. Choose the most appropriate one to hold the new
-feature. Feel free to contact the team in case any doubt arises during the process.
+Check out the [OpenV2X Architectural Design document](v2x-architectural-design.md) to get an idea on
+the different modules that compose OpenV2X. Choose the most appropriate one to hold the new feature.
+Feel free to contact the team in case any doubt arises during the process.
 
 ### Coding standard