Simplify config and port check (#60)

* remove path and port * fix error * remove light * fix number error * fix api error * check karst folder * exit when error * update readme
crustio · Sep 15, 2020 · bf571ac · bf571ac
1 parent 03d780d
commit bf571ac
Show file tree

Hide file tree

Showing 14 changed files with 54 additions and 81 deletions.
diff --git a/README.md b/README.md
@@ -29,10 +29,16 @@ sudo ./install.sh
 sudo vim /opt/crust/crust-node/config.yaml
 ```
 
-### Run crust service
+### Run crust service and karst service
+Please make sure the following ports are not occupied before starting：
+- 30333 9933 9944 (for crust chain)
+- 56666 (for crust API)
+- 12222 (for crust sWorker)
+- 17000 (for karst)
 
 ```shell
 sudo systemctl start crust
+sudo systemctl start karst
 ```
 
 ## License

diff --git a/config.yaml b/config.yaml
@@ -1,6 +1,6 @@
 ## node configurations
 node:
-  ## the type of crust, for example: authority, full, light
+  ## the type of crust, for example: authority, full
   chain: "authority"
   ## enable or disable sworker
   sworker: "enable"
@@ -16,40 +16,19 @@ identity:
 
 ## chain configurations
 chain:
-  ## chain data will be saved in this path, need absolute path
-  base_path: "/opt/crust/data/chain"
   ## the name of chain node
   name: "vnode"
-  ## the port
-  port: 30333
-  ## the rpc port
-  rpc_port: 9933
-  ## the ws port
-  ws_port: 9944
-
-## api configurations
-api:
-  ## the port
-  port: 56666
 
 ## sworker configurations
 sworker:
-  ## sworker base data will be saved in this path, need absolute path
-  base_path: "/opt/crust/data/sworker"
   ## the srd data will be saved in those paths, need absolute path
   srd_paths:
     - "/opt/crust/data/sworker/srd1"
     - "/opt/crust/data/sworker/srd2"
   ## the number of srd in GB, input must be an integer greater than 0
   srd_init_capacity: 1
-  ## the port
-  port: 12222
 
 ## karst configurations
 karst:
-  ## karst data will be saved in this path, need absolute path
-  base_path: "/opt/crust/data/karst"
   ## the thacker address
   tracker_addrs: "127.0.0.1:22122"
-  ## the port
-  port: 17000
diff --git a/generator/config-gen/api-config.gen.js b/generator/config-gen/api-config.gen.js
@@ -1,7 +1,7 @@
 
 async function genApiConfig(config, outputCfg) {
   const apiConfig = {
-    ...config.api,
+    port: 56666,
     chain_ws_url: `ws://127.0.0.1:${config.chain.ws_port}`,
   }
   return {
@@ -12,8 +12,8 @@ async function genApiConfig(config, outputCfg) {
 
 async function genApiComposeConfig(config) {
   const args = [
-    `${config.api.port}`,
-    `ws://127.0.0.1:${config.chain.ws_port}`,
+    '56666',
+    `ws://127.0.0.1:9944`,
   ].join(' ')
   return {
     image: 'crustio/crust-api:latest',

diff --git a/generator/config-gen/chain-config.gen.js b/generator/config-gen/chain-config.gen.js
@@ -14,30 +14,28 @@ async function genChainComposeConfig(config) {
   let args = [
     './crust',
     '--base-path',
-    `${config.chain.base_path}`,
+    '/opt/crust/data/chain',
     '--chain',
     'maxwell',
     '--port',
-    `${config.chain.port}`,
+    '30333',
     '--name',
     `${config.chain.name}`,
     '--rpc-port',
-    `${config.chain.rpc_port}`,
+    '9933',
     '--ws-port',
-    `${config.chain.ws_port}`,
+    '9944',
   ]
 
   if (config.node.chain == "authority") {
     args.push('--validator', '--pruning', 'archive')
-  } else if (config.node.chain == "light") {
-    args.push('--light')
   }
 
   return {
     image: 'crustio/crust:latest',
     network_mode: 'host',
     volumes: [
-      `${config.chain.base_path}:${config.chain.base_path}`
+      '/opt/crust/data/chain:/opt/crust/data/chain'
     ],
     command: args,
   }
@@ -46,7 +44,7 @@ async function genChainComposeConfig(config) {
 function getSharedChainConfig(config) {
   return {
     ...config.identity,
-    base_url: `http://127.0.0.1:${config.api.port}/api/v1`,
+    base_url: `http://127.0.0.1:56666/api/v1`,
     address: config.identity.backup.address,
     account_id: config.identity.account_id,
     backup: JSON.stringify(config.identity.backup),
@@ -56,7 +54,7 @@ function getSharedChainConfig(config) {
 function getSharedChainConfigForKarst(config) {
   return {
     ...config.identity,
-    base_url: `127.0.0.1:${config.api.port}`,
+    base_url: `127.0.0.1:56666`,
     address: config.identity.backup.address,
     backup: JSON.stringify(config.identity.backup),
   }

diff --git a/generator/config-gen/karst-config.gen.js b/generator/config-gen/karst-config.gen.js
@@ -3,12 +3,12 @@ const { getSharedChainConfigForKarst } = require('./chain-config.gen')
 
 async function genKarstConfig(config, outputCfg) {
   const karstConfig = {
-    base_path: config.karst.base_path,
-    port: config.karst.port,
+    base_path: '/opt/crust/data/karst',
+    port: 17000,
     debug: true,
     crust: getSharedChainConfigForKarst(config),
     sworker: {
-      base_url: `127.0.0.1:${config.sworker.port}`
+      base_url: `127.0.0.1:12222`
     },
     file_system: {
       fastdfs: {
@@ -19,9 +19,9 @@ async function genKarstConfig(config, outputCfg) {
       }
     }
   }
-  const basePaths = _.isEmpty(config.karst.base_path) ? [] : [{
+  const basePaths = [{
     required: true,
-    path: config.karst.base_path,
+    path: '/opt/crust/data/karst',
   }]
   return {
     config: karstConfig,
@@ -30,8 +30,8 @@ async function genKarstConfig(config, outputCfg) {
 }
 
 async function genKarstComposeConfig(config) {
-  const basePath = _.isEmpty(config.karst.base_path) ? '/home/crust/crust/karst' : config.karst.base_path
-  const baseVolume = _.isEmpty(config.karst.base_path) ? [] : [ `${basePath}:${basePath}` ]
+  const basePath = '/opt/crust/data/karst'
+  const baseVolume =[ `${basePath}:${basePath}` ]
 
   return {
     image: 'crustio/karst:latest',

diff --git a/generator/config-gen/sworker-config.gen.js b/generator/config-gen/sworker-config.gen.js
@@ -1,17 +1,11 @@
 const _ = require('lodash')
-const { createDir, writeConfig, } = require('../utils')
 const { getSharedChainConfig } = require('./chain-config.gen')
 
 async function genSworkerConfig(config, outputCfg) {
-  karstPort = 17000
-  if (config.karst) {
-    karstPort = config.karst.port
-  }
-
   const sworkerConfig = {
     ..._.omit(config.sworker, ['port']),
-    base_url: `http://0.0.0.0:${config.sworker.port}/api/v0`,
-    karst_url: `ws://127.0.0.1:${karstPort}/api/v0/node/data`,
+    base_url: `http://0.0.0.0:12222/api/v0`,
+    karst_url: `ws://127.0.0.1:17000/api/v0/node/data`,
     chain: getSharedChainConfig(config),
   }
   const srdPaths = _.map(config.sworker.srdPaths, (p) => ({
@@ -22,7 +16,7 @@ async function genSworkerConfig(config, outputCfg) {
     config: sworkerConfig,
     paths: [{
       required: true,
-      path: config.sworker.base_path,
+      path: '/opt/crust/data/sworker',
     }, ...srdPaths],
   }
 }
@@ -32,15 +26,12 @@ async function genSworkerComposeConfig(config) {
         .map((p) => `${p}:${p}`)
 
   let tempVolumes = [
-    `${config.sworker.base_path}:${config.sworker.base_path}`,
+    '/opt/crust/data/sworker:/opt/crust/data/sworker',
     ...srdVolumes,
-    './sworker:/config'
+    './sworker:/config',
+    '/opt/crust/data/karst:/opt/crust/data/karst'
   ]
 
-  if (config.karst) {
-    tempVolumes.push(`${config.karst.base_path}:${config.karst.base_path}`)
-  }
-
   return {
     image: 'crustio/crust-sworker:latest',
     network_mode: 'host',

diff --git a/generator/schema/api.schema.js b/generator/schema/api.schema.js
diff --git a/generator/schema/chain.schema.js b/generator/schema/chain.schema.js
@@ -2,11 +2,7 @@ const Joi = require('joi')
 const bluebird = require('bluebird')
 
 const chainSchema = Joi.object({
-  base_path: Joi.string().required(),
-  name: Joi.string().required(),
-  port: Joi.number().port().default(30333),
-  rpc_port: Joi.number().port().default(9933),
-  ws_port: Joi.number().port().default(9944),
+  name: Joi.string().required()
 })
 
 module.exports = {

diff --git a/generator/schema/index.js b/generator/schema/index.js
@@ -1,22 +1,21 @@
 
 const Joi = require('joi')
-const { apiSchema } = require('./api.schema')
 const { chainSchema } = require('./chain.schema')
 const { karstSchema } = require('./karst.schema')
 const { identitySchema } = require('./identity.schema')
 const { sworkerSchema } = require('./sworker.schema')
 const { nodeSchema } = require('./node.schema')
 
 function getConfigSchema(config) {
-  sMap = {
+  let sMap = {
     node: nodeSchema.required(),
     chain: chainSchema.required(),
   }
 
   if (config.node.sworker != "enable") {
     return Joi.object(sMap)
   }
-  sMap["api"] = apiSchema.required()
+  sMap["api"] = Joi.object().default()
   sMap["identity"] = identitySchema.required()
   sMap["sworker"] = sworkerSchema.required()
 

diff --git a/generator/schema/karst.schema.js b/generator/schema/karst.schema.js
@@ -2,9 +2,7 @@
 const Joi = require('joi')
 
 const karstSchema = Joi.object({
-  base_path: Joi.string().required(),
   tracker_addrs: Joi.string().required(),
-  port: Joi.number().port().default(17000),
 })
 
 module.exports = {

diff --git a/generator/schema/node.schema.js b/generator/schema/node.schema.js
@@ -1,7 +1,7 @@
 const Joi = require('joi')
 
 const nodeSchema = Joi.object({
-  chain: Joi.string().valid('authority', 'full', 'light').required(),
+  chain: Joi.string().valid('authority', 'full').required(),
   sworker: Joi.string().valid('enable', 'disable').required(),
   karst: Joi.string().valid('enable', 'disable').required(),
 })

diff --git a/generator/schema/sworker.schema.js b/generator/schema/sworker.schema.js
@@ -2,10 +2,8 @@
 const Joi = require('joi')
 
 const sworkerSchema = Joi.object({
-  base_path: Joi.string().required(),
   srd_paths: Joi.array().items(Joi.string()).required(),
   srd_init_capacity: Joi.number().positive().integer().default(1),
-  port: Joi.number().port().default(12222),
 })
 
 module.exports = {

diff --git a/scripts/crust.sh b/scripts/crust.sh
@@ -7,6 +7,8 @@ builddir=$basedir/build
 start()
 {
 	echo "Start"
+	check_port 30333 && check_port 9933 && check_port 9944 && check_port 56666 && check_port 12222 && check_port 17000
+
 	$scriptdir/gen_config.sh
 	if [ $? -ne 0 ]; then
 		echo "Generate configuration files failed"
@@ -30,13 +32,16 @@ start()
 	if [ -d "$builddir/sworker" ]; then
 		docker-compose -f $builddir/docker-compose.yaml up -d crust-api
 		if [ $? -ne 0 ]; then
+			docker-compose -f $builddir/docker-compose.yaml rm -fsv crust
 			echo "Start crust-api failed"
 			exit 1
 		fi
 
 		a_or_b=`cat $basedir/etc/sWorker.ab`
 		docker-compose -f $builddir/docker-compose.yaml up -d crust-sworker-$a_or_b
 		if [ $? -ne 0 ]; then
+			docker-compose -f $builddir/docker-compose.yaml rm -fsv crust
+			docker-compose -f $builddir/docker-compose.yaml rm -fsv crust-api
 			echo "Start crust-sworker-$a_or_b failed"
 			exit 1
 		fi
@@ -62,6 +67,15 @@ reload() {
 	stop
 	start
 }
+
+check_port() {
+	port=$1
+	grep_port=`netstat -tlpn | grep "\b$port\b"`
+	if [ -n "$grep_port" ]; then
+		echo "Please make sure port $port is not occupied"
+		exit 1
+	fi
+}
 
 case "$1" in
 	start)

diff --git a/scripts/karst.sh b/scripts/karst.sh
@@ -7,13 +7,13 @@ builddir=$basedir/build
 start()
 {
 	echo "Start"
-    $scriptdir/gen_config.sh
+	$scriptdir/gen_config.sh
 	if [ $? -ne 0 ]; then
 		echo "Generate configuration files failed"
 		exit 1
 	fi
 
-    if [ ! -d "$builddir/sworker" ]; then
+	if [ ! -d "$builddir/sworker" ]; then
 		echo "No sworker"
 		exit 1
 	fi
@@ -24,6 +24,9 @@ start()
 			echo "Start karst failed"
 			exit 1
 		fi
+	else
+		echo "Please enable karst in /opt/crust/crust-node/config.yaml"
+		exit 1
 	fi
 }