Automated Install

When users would like to automate the process of installing and running HarperDB there is the capability to pass arguments via the command line. Not All arguments are required.

harperdb [ install | run ] --TC_AGREEMENT [yes | no] --HDB_ROOT [PATH] --HTTP_PORT [HTTP_PORT] --HTTPS_PORT [HTTPS_PORT] --HDB_ADMIN_USERNAME [USERNAME] --HDB_ADMIN_PASSWORD [PASSWORD] --CLUSTERING_USERNAME [CLUSTERING USERNAME] --CLUSTERING_PASSWORD [CLUSTERING USER PASSWORD] --CLUSTERING_PORT [CLUSTER PORT] --NODE_NAME [CLUSTER NODE NAME] --enable_clustering [TOGGLE FLAG]

Available arguments are:
--TC_AGREEMENT
--HDB_ROOT
--HTTP_PORT
--HTTPS_PORT
--HDB_ADMIN_USERNAME
--HDB_ADMIN_PASSWORD
--CLUSTERING_USERNAME
--CLUSTERING_PASSWORD
--CLUSTERING_PORT
--NODE_NAME
--enable_clustering

 

The variables are defined as follows:
[yes | no]: Agree yes, Do not Agree no.
[PATH]: full path to where you would like the HarperDB data to be installed. i.e. /tmp/hdb
[HTTP_PORT]: port you would like HTTP server to run on
[HTTPS_PORT]: port you would like HTTPS server to run on
[USERNAME]: username of your  administrator
[PASSWORD]: password for your administrator user
[PORT NUMBER > 1024]  Non Root users do not have authority to open ports below 1024
[CLUSTERING USERNAME]: username of clustering user, needs to be the same between connected nodes
[CLUSTERING USERN PASSWORD]: password of clustering user, needs to be the same between connected nodes
[CLUSTERING_PORT]: port you would like to do clustering communication on
[CLUSTERING NODE NAME]: cluster node name to reference connected node
[TOGGLE FLAG]: No Value needs to be supplied to –enable_clustering it is a flag to enable clustering.

 

Here is an example we use internally to automate, build, and test procedures in containers and VMs:

harperdb install --TC_AGREEMENT yes --HDB_ROOT /tmp/hdb --HTTP_PORT 9925 --HTTPS_PORT 31283 --HDB_ADMIN_USERNAME HDB_ADMIN --HDB_ADMIN_PASSWORD password --CLUSTERING_USERNAME clustering --CLUSTERING_PASSWORD password --CLUSTERING_PORT 1111 --NODE_NAME ci_dev --enable_clustering