Commit 60c064f2 authored by Robert Dietrich's avatar Robert Dietrich

added more documentation and replaced a hard-coded path

parent 21e8b6bd
......@@ -15,16 +15,28 @@ To simplify the installation, appropriate install scripts are available.
For detailed install instructions see the [README.md](install/README.md) in the install directory.
## Configuration
Five files are used to configure the software stack.
Five files are used to configure the software stack:
*pika.conf*
* *pika.conf*
contains the global version independent configuration variables. It also sets some environment variables that are used in the job prolog and epilog. It uses `source` to read the environment variables from *.pika_access*.
* *.pika_access*
exports the environment variables with the access parameters for the databases. Thus, this file should have restricted read access. You can use [pika_access_template](pika_access_template) to create this file.
* *pika-VERSION.conf*
is used for versioning of the PIKA package. It sets the PIKA package version along with the used version of collectd, LIKWID and Python. Finally, it uses `source` to read the environment variables from *pika.conf*.
* *pika_utils.conf*
provides utility functions for prolog, epilog and other bash scripts.
*.pika_access*
exports the environment variables with the access parameters for the databases. Thus, this file should have restricted read access.
Edit *pika.conf* an change the variables *LOCAL_STORE*, *PIKA_LOGPATH* and *PIKA_INSTALL_PATH* according to your needs or system setup.
*LOCAL_STORE* specifies the path where temporary files are placed during prolog and read by the epilog script. It is also used for locking of the install and collectd start procedure.
*PIKA_LOGPATH* specifies the path where the collectd log file *pika_collectd.log* will be written to.
*PIKA_INSTALL_PATH* specifies the path where the PIKA software (binaries, libraries, etc.) is installed to.
*pika-VERSION.conf*
is used for versioning of the PIKA package. It sets the PIKA package version along with the used version of collectd, LIKWID and Python. Finally, it uses `source` to read the environment variables from *pika.conf*.
Edit *pika-VERSION.conf* and set the variable *PIKA_ROOT* to the path where the PIKA sources (and also the *.conf files) are located.
This file also specifies the collectd batch size (number of metric values that are collected until being sent to the database) with the variable *PIKA_COLLECTD_BATCH_SIZE*.
Furthermore, it does some exception handling for different types of nodes.
*pika_utils.conf*
provides utility functions for prolog, epilog and other bash scripts.
Finally, a symbolic link that points on a *pika-VERSION.conf* file has to be created an named pika-current.conf. For example:
ln -s pika-1.2.conf pika-current.conf
To create a new PIKA software package, copy a *pika-VERSION.conf* file with a new version number and change the variables *PIKA_VERSION*, *COLLECTD_VERSION*, *LIKWID_VERSION* and, if necessary, *LIKWID_VERSION_SHA*.
\ No newline at end of file
......@@ -14,15 +14,15 @@ export PIKA_INSTALL_PATH=/opt/pika/${PIKA_VERSION}
### END: global configuration (usually there is no need to touch the following)
# access parameters for databases
source ${PIKA_ROOT}/.pika_access
# collectd configuration and logging
export PIKA_COLLECTD_LOGFILE=${PIKA_LOGPATH}/pika_collectd.log
export PIKA_COLLECTD_CONF=${PIKA_INSTALL_PATH}/pika_collectd.conf
export PIKA_COLLECTD_PID_FILE=${PIKA_INSTALL_PATH}/pika_collectd.pid
export PIKA_COLLECTD_SOCKET=${PIKA_INSTALL_PATH}/pika_collectd.sock
# access parameters for databases
source /sw/taurus/tools/pika/.pika_access
# build path for PIKA tools (collectd, python, LIKWID), no root needed
export PIKA_BUILD_PATH=${PIKA_ROOT}/sw/${PIKA_VERSION}
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment