Project: datamanagement
Issue DM-2630: Document configuration tool main use cases
- Document main use case for qserv-configure.py: install Qserv master/worker node with externalized data directory - Hide complex configuration options? {code} Configuration steps: General configuration steps -d, --directory-tree Create directory tree in QSERV_RUN_DIR, eventually create symbolic link from QSERV_RUN_DIR/var/lib to QSERV_DATA_DIR. -e, --etc Create Qserv configuration files in QSERV_RUN_DIR using values issued from meta-config file QSERV_RUN_DIR/qserv-meta.conf -c, --client Create client configuration file (used by integration tests for example) Components configuration: Configuration of external components -X, --xrootd Create xrootd query and result directories -C, --css-watcher Configure CSS-watcher (i.e. MySQL credentials) Database components configuration: Configuration of external components impacting data, launched if and only if QSERV_DATA_DIR is empty -M, --mysql Remove MySQL previous data, install db and set password -Q, --qserv-czar Initialize Qserv master database -W, --qserv-worker Initialize Qserv worker database -S, --scisql Install and configure SciSQL {code}
Story points: 3