Skip to content

environment

SYNOPSIS

environment

DESCRIPTION

The punch lets you execute differents kind of applications. Each of them calls for specific jars, binaries, loggers and configurations to run properly.

To point to the appropriate requirements, PunchPlatform defines some environment variables.

This documentation describes each environment variable use in Punchplatform and who is using it

ENVIRONMENT

  • PUNCHPLATFORM_CONF_DIR :

    • The PUNCHPLATFORM_CONF_DIR variable must points to the directory holding user resources (dashboards, mappings ..) and configurations (channels, tenants ..). This variable takes different values depending on the runtime context : Shiva or Operator.

  • PUNCHPLATFORM_LOG_DIR :

    • The PUNCHPLATFORM_LOG_DIR variable can be defined to override the log directory in which punchplatform-XXXXX.sh commands will write their log/debug file. By default, this parameter is provided in punchplatform-deployment.settings configuration file via parameter punchplatform_log_dir.

  • PUNCHPLATFORM_LOG_FILE :

    • The PUNCHPLATFORM_LOG_FILE variable can be defined to override the log file name used by punchplatform-XXXXX.sh. By default the log file will be called 'punchplatform.log' and placed in PUNCHPLATFORM_LOG_DIR (see above)

  • PUNCHPLATFORM_PROPERTIES_FILE :

    • The PUNCHPLATFORM_PROPERTIES_FILE variable must points to a specific punchplatform.properties This is a generated file during installation and duplicated in shiva, operator and gateway packaging This variable takes different values depending on the runtime context : Shiva, Gateway, Operator.

  • PUNCHPLATFORM_INSTALL_DIR :

    • The PUNCHPLATFORM_INSTALL_DIR variable must points to the installation directory which contains the various punch binaries. Each punch node (operator, shiva, gateway, spark, storm etc..) has such directory.

  • PUNCHPLATFORM_RESOLV_FILE :

    • The PUNCHPLATFORM_RESOLV_FILE variable must points to a resolv.json file This file is provided at deploy time by the user and duplicated in shiva, operator and gateway packaging. It helps reducing the verbosity of channel and punchline files and provides for automatic address resolution and completion. This variable takes different values depending on the runtime context : Shiva, Gateway, Operator.

  • PUNCHPLATFORM_SECRETS_FILE :

    • The PUNCHPLATFORM_SECRETS_FILE variable must points to a punch_secrets.json file This file is provided at deploy time by the user and duplicated in shiva, operator and gateway packaging. It helps to protect secrets needed by our operator tools to access secured components when they are protected by credentials and certificates. This variable takes different values depending on the runtime context : Shiva, Gateway, Operator.

  • PUNCHPLATFORM_LOG4J_CONF_DIR :

    • The PUNCHPLATFORM_LOG4J_CONF_DIR must points to the directory containing the required log4j2.xml and log4j2.properties. This variable takes different values depending on the runtime context : Shiva, Gateway, Operator.

  • PUNCHPLATFORM_PEX_CACHE_DIR :

    • The PUNCHPLATFORM_PEX_CACHE_DIR must points to the directory containing pex cache files . This variable takes different values depending on the runtime context : Shiva, Gateway, Operator.

  • PUNCHPLATFORM_OPERATOR_INSTALL_DIR :

    • The PUNCHPLATFORM_SHIVA_INSTALL_DIR must points to the shiva installation directory. Shiva acts as an completly autonomous application launcher. It contains only a few configuration files, not the binaries themselves that are provided by the PUNCHPLATFORM_INSTALL_DIR This variable is only set on a Operator runtime context

  • PUNCHPLATFORM_SHIVA_INSTALL_DIR :

    • The PUNCHPLATFORM_SHIVA_INSTALL_DIR must points to the operator installation directory. It contains only a few configuration files, not the binaries themselves that are provided by the PUNCHPLATFORM_INSTALL_DIR This variable is only set on a Shiva runtime context

  • PUNCHPLATFORM_GATEWAY_INSTALL_DIR :

    • The PUNCHPLATFORM_GATEWAY_INSTALL_DIR must points to the gateway installation directory. It contains only a few configuration files, not the binaries themselves that are provided by the PUNCHPLATFORM_INSTALL_DIR This variable is only set on a Gateway runtime context

  • PUNCHPLATFORM_SPARK_INSTALL_DIR :

    • The PUNCHPLATFORM_SPARK_INSTALL_DIR must points to the spark installation directory. It is a subfolder in PUNCHPLATFORM_INSTALL_DIR which contains Spark binaries Each punch node (operator, shiva, gateway, spark, storm etc..) has such directory.

  • PUNCHPLATFORM_PYSPARK_INSTALL_DIR :

    • The PUNCHPLATFORM_PYSPARK_INSTALL_DIR must points to the spark installation directory. It is a subfolder in PUNCHPLATFORM_INSTALL_DIR which contains PySpark binaries Each punch node (operator, shiva, gateway, spark, storm etc..) has such directory.

  • PUNCHPLATFORM_ZOOKEEPER_INSTALL_DIR :

    • The PUNCHPLATFORM_ZOOKEEPER_INSTALL_DIR must points to the zookeeper installation directory. It is a specific directory which contains Zookeeper binaries This variable is only set on a Gateway runtime context in order to call punchplatform-zookeeper-console.sh shell

  • PUNCHPLATFORM_KAFKA_INSTALL_DIR :

    • The PUNCHPLATFORM_KAFKA_INSTALL_DIR must points to the kafka installation directory. It is a specific directory which contains Kafka binaries This variable is only set on a Gateway runtime context in order to call punchplatform-kafka-consumers.sh and punchplatform-kafka-topics.sh shells

  • PUNCHPLATFORM_*COMPONENT*_INSTALL_DIR :

    • Other environment variable with pattern PUNCHPLATFORM_COMPONENT_INSTALL_DIR are standalone only variables and points specifics installation directories. They are use to start and stop each Punchplatform component in a standalone