Reference - Ansible4IOM Variables

Product Version

2.2

Product To Version

2.17
Status

final

1 Introduction

Ansible4IOM is a tool of the Intershop Order Management (IOM) for automated server configuration management. Additionally, operational tasks are predefined in operational processes which can be customized by using hooks.

This reference lists all variables and their scope that can be used within Ansible4IOM. The target group of this document are developers of a project as well as system administrators.

1.1 References

and

2 Ansible4IOM Variables

2.1 PostgreSQL Server

Possible default  values for these variables can be read in roles/pgserver_config/defaults/main.yml

VariableConfiguration FileChanges can be applied in this processComment
setup_pgserverreconfigure_pgserver
PGSERVER_VERSION-X--
PGSERVER_PORT{{PGSERVER_DATA}}/postgresql.confXX-
PGSERVER_DATA/usr/lib/systemd/system/postgresql-*.service.d/environment.confX-The data directory cannot be moved after initial setup.
PGSERVER_SUPERUSER-X--
PGSERVER_SUPERUSER_PASSWD-XXChanging the value updates the super-user's password.
PGSERVER_TRUSTED_HOSTS{{PGSERVER_DATA}}/pg_hba.confXX-
PGSERVER_USER_NAME-XX

Only used to control access to oms-db. Changing the value does not change the user account, it only allows PGSERVER_USER_NAME to access the database.

PGSERVER_USER_DB-XXOnly used to control access to oms-db. Changing the value does not change the name of oms database, it only allows access to database named PGSERVER_USER_DB.

2.2 Database

Default  values for these variables can be read in roles/omsdb_config/defaults/main.yml.

VariableConfiguration Filein Process setup_omsdbComment
OMSDB_SUPERUSER-XUsed only to access DB-server with super-user access rights. Changing the value does not have any impact on super-user.
OMSDB_SUPERUSER_PASSWD-XUsed only to access DB-server with super-user access rights. Changing the value does not have any impact on super-user.
OMSDB_HOST-XUsed only to access DB-server. Changing the value does not have any impact on PostgreSQL-server.
OMSDB_PORT-XUsed only to access DB-server. Changing the value does not have any impact on PostgreSQL-server.
OMSDB_USER-(X)Changing the value user after initial run is possible. It always creates a new user. Renaming an existing user is not possible.
OMSDB_PASSWD-X-
OMSDB_NAME-(X)Changing the value after initial run is possible. It always creates a new database. Renaming an existing database is not possible.
OMSDB_OPTIONS-X

Could be used to change the database creation parameters (e.g. ENCODING, LC_COLLATE, LC_CTYPE, TABLESPACE)

OMSDB_USER_CONNECTION_SUFFIX-XCould be used to support database services that require a special username format e.g. in azure the username should be in <username@hostname> format

2.3 OMS

VariableConfiguration FileChanges can be applied in this processComment
setup_oms_nodeupdate_oms_nodereconfigure_oms_node
PG_VERSION-X--Used to install PG client of requested version
OMS_PUBLIC_DOMAIN_NAME-XXX-
OMS_PUBLIC_PROTOCOL-XXX-
OMS_PUBLIC_PORT["http"|"https"]-XXX-
OMS_SERVER_TYPEinstallation.properties-Never set this variable explicitly, it is set by the processes automatically.
OMS_VERSION-XX--
OMS_REPO_URL-XX--
OMS_REPO_USER-XX--
OMS_REPO_PASSWD-XX--
OMS_REPO_SKIP-XX--
OMS_USERinstallation.propertiesX---

OMS_USER_HOME

-XX--
OMS_USER_ID-X---
OMS_GROUP-X---
OMS_GROUP_ID-X---

OMS_HOME[OMS_SERVER_TYPE]

installation.propertiesXX--
OMS_ETC[OMS_SERVER_TYPE]-XX--
OMS_VAR[OMS_SERVER_TYPE]installation.propertiesXX--
OMS_LOG[OMS_SERVER_TYPE]installation.propertiesXX-

IOM < 2.12.0.0: The content of the log directory will not be saved/restored by the standard process. You have to implement hooks for this functionality or change the value to a directory outside of OMS_VAR.

IOM >= 2.12.0.0: Default value was changed to /opt/var/{{OMS_USER}}.log. This directory lies outside of OMS_VAR, hence it will not be longer necessary to protect content of OMS_LOG from standard processes.

OMS_APP[OMS_SERVER_TYPE]installation.propertiesXX(X)You may only add new entries in process reconfigure_oms_node.
OMS_JAVA_HOMEinstallation.propertiesXXXReferenced Java has to exist in advance.

JBOSS_SERVICE_NAME[OMS_SERVER_TYPE]

-X---
SERVER_ID[OMS_SERVER_TYPE]installation.propertiesXXX-
JBOSS_JAVA_OPTS[OMS_SERVER_TYPE]installation.propertiesXXX-
JBOSS_HOME[OMS_SERVER_TYPE]installation.propertiesXX--
JBOSS_BIND_ADDRESS[server-type]installation.propertiesXXX-
JBOSS_ADMIN_USER[server-type]installation.propertiesXX--
JBOSS_ADMIN_PASSWD[server-type]installation.propertiesXX--
JBOSS_PORT_OFFSETinstallation.propertiesXXXJMS- and load balancer configuration are not updated automatically.
WATCHDOG_ACTIVATED
XXXIOM >= 2.12.0.0: when set to false, the installation of the Watchdog will be skipped. This is necessary for developer installations only, to enable developers to reconfigure the application server or to to deploy applications without to fear the watchdog is assuming an error. Setting of this variable to false is only supported for single machine installations of type oms_cluster_node.
WATCHDOG_JAVA_OPTSinstallation.propertiesXXX-
is_oms_db_namecluster.propertiesXXX-
is_oms_db_usercluster.propertiesXXX-
is_oms_db_passcluster.propertiesXXX-
is_oms_db_cachecluster.propertiesXXX-
is_oms_xmlbinder_cachecluster.propertiesXXX-
is_oms_media_hostcluster.properties---IOM >= 2.12.0.0: according property was removed in IOM version 2.11.0.0. The variable has no impact in this and newer versions of IOM.
is_oms_media_usercluster.propertiesX--IOM >= 2.12.0.0: according property was removed in IOM version 2.11.0.0. The variable has no impact in this and newer versions of IOM.
is_oms_media_passcluster.propertiesX--IOM >= 2.12.0.0: according property was removed in IOM version 2.11.0.0. The variable has no impact in this and newer versions of IOM.
is_oms_pdf_hostcluster.properties---IOM >= 2.12.0.0: according property was removed in IOM version 2.11.0.0. The variable has no impact in this and newer versions of IOM.
is_oms_pdf_usercluster.propertiesX--IOM >= 2.12.0.0: according property was removed in IOM version 2.11.0.0. The variable has no impact in this and newer versions of IOM.
is_oms_pdf_passcluster.propertiesX--IOM >= 2.12.0.0: according property was removed in IOM version 2.11.0.0. The variable has no impact in this and newer versions of IOM.
is_oms_smtp_hostcluster.propertiesXXX-
is_oms_smtp_portcluster.propertiesXXX-
is_oms_smtp_usercluster.propertiesXXXOptional, The user name for mail server authentication.
is_oms_smtp_passcluster.propertiesXXXOptional, The user password for mail server authentication
is_oms_mail_external_fromcluster.propertiesXXX-
is_oms_mail_internal_fromcluster.propertiesXXX-
is_oms_mail_internal_tocluster.propertiesXXX-
is_oms_mail_internal_cccluster.propertiesXXX-

is_oms_mail_internal_bcc

cluster.propertiesXXX-
is_oms_mail_businessoperations_tocluster.propertiesXXX-
is_oms_mail_resources_base_urlcluster.propertiesXXX-
is_oms_jboss_base_urlcluster.propertiesXXX-
is_oms_validation_pattern_phonecluster.propertiesXXX-
is_oms_db_hostlistcluster.propertiesXXX-
is_oms_jms_hostlistcluster.propertiesXXXIOM >= 2.10.0.0: according property was removed in IOM version 2.10.0.0. The variable has no impact in this and newer versions of IOM.
is_oms_media_healthcheckcluster.propertiesXXXIOM >= 2.12.0.0: according property was removed in IOM version 2.12.0.0. The variable has no impact in this and newer versions of IOM.
is_oms_pdf_healthcheckcluster.propertiesXXXIOM >= 2.12.0.0: according property was removed in IOM version 2.12.0.0. The variable has no impact in this and newer versions of IOM.
is_oms_sharedfs_healthcheckcluster.propertiesXXXIOM >= 2.12.0.0: according property was added in IOM version 2.12.0.0. The variable has no impact in older versions of IOM.
is_oms_healthcheck_cachelivetimecluster.propertiesXXX

(optional)

IOM  2.9.0.0: Max age to read the health check status from the cache before to trigger a new check on a health check status REST request.
No caching will take place when not defined or set to 0. When using the Watchdog, this value should be less than the property watchdog.cycle.
default 2, set to 0 to disable the cache.

IOM >= 2.9.1.0: Maximum age in seconds for which a health check found within the cache is considered to be valid. The server status will be returned as 503 after that, assuming that the health check timer has stopped or is hanging.
default 10, minimum = is_oms_healthcheck_recurringtime + 6

is_oms_healthcheck_recurringtimecluster.propertiesXXX

(Optional) Since IOM 2.9.1.0

Health check recurring interval (in seconds), optional, default 3 s., minimum 1 s. When using the Watchdog, this value should be less than the property watchdog.cycle.

is_oms_healthcheck_enabledcluster.propertiesXXX

(Optional) Since IOM 2.9.4.0

Enable/ disable health check. It will always be activated, except when this parameter is set to "false".

is_oms_validation_pattern_emailcluster.propertiesXXX-
is_oms_validation_pattern_passwordcluster.propertiesXXX-
is_oms_validation_pattern_password_hintcluster.propertiesXXX-
OMS_SERVER_READY_TIMEOUT-XXX-
OMS_DB_USER_CONNECTION_SUFFIXcluster.propertiesXXXCould be used to support database services that require a special username format e.g., in Azure the username should be in <username@hostname> format
DUMMY_FILESYSTEMS-X--Used in standalone installations of OMS only.


2.4 Load Balancer

The default values can be read in roles/apache_config/defaults/main.yml.

Variable

Configuration FileChanges can be applied in this processComment
setup_load_balancerreconfigure_load_balancer
APACHE_VERSION-X--
APACHE_REPO_URL-X--
APACHE_REPO_USER-X--
APACHE_REPO_PASSWD-X--
APACHE_REPO_SKIP-X--
APACHE_INSTALL_DIR-X--
APACHE_VAR_DIR-X--
APACHE_USER-X--
APACHE_GROUP-X--
APACHE_SERVICE_NAME-X--
APACHE_SERVER_ADMIN{{APACHE_INSTALL_DIR}}/conf/httpd.confXX

see Apache 2.4 Core

APACHE_LB_SCHEDULER{{APACHE_INSTALL_DIR}}/conf/oms/balancer.confXX

see Apache 2.4 mod_proxy_balancer

APACHE_LB_MEMBER_PARAMS{{APACHE_INSTALL_DIR}}/conf/oms/balancer.confXX

see Apache 2.4 mod_proxy_balancer

APACHE_LB_HEALTHCHECK_INTERVAL{{APACHE_INSTALL_DIR}}/conf/oms/balancer.confXX

see Apache 2.4 mod_proxy_hcheck

APACHE_LB_OMSSERVER_LIST{{APACHE_INSTALL_DIR}}/conf/oms/balancer.confXX

see Apache 2.4 mod_proxy_balancer and Apache 2.4 mod_prox_hcheck 

APACHE_MGMNT_USER{{APACHE_INSTALL_DIR}}/conf/oms/balancer.confXX

Management user, which is required to access /server-status and /balancer-manager

APACHE_MGMNT_PASSWD

{{APACHE_INSTALL_DIR}}/conf/oms/balancer.conf

{{APACHE_INSTALL_DIR}}/conf/htpasswd

XXManagement user, which is required to access /server-status and /balancer-manager
APACHE_REQUIRE_MGMNT{{APACHE_INSTALL_DIR}}/conf/oms/balancer.confXXList of require rules to be applied when accessing /server-status and /balancer-manager
entries of the list are used to build "Require" lines in apache configuration according
the rules of mod_authz_host (https://httpd.apache.org/docs/2.4/mod/mod_authz_host.html)
each entry of the list will be transformed into a line like the following:
Require {{APACHE_REQUIRE_MGMNT[n]}}
APACHE_REQUIRE_IOM{{APACHE_INSTALL_DIR}}/conf/oms/balancer.confXXList of require rules to be applied when accessing OMT, REST/SOAP
entries of the list are used to build "Require" lines in apache configuration according
the rules of mod_authz_host (https://httpd.apache.org/docs/2.4/mod/mod_authz_host.html)
each entry of the list will be transformed into a line like the following:
Require {{APACHE_REQUIRE_IOM[n]}}
APACHE_LOG_FORMAT{{APACHE_INSTALL_DIR}}/conf/oms/balancer.confXXLog format to be used for access-log

Disclaimer

The information provided in the Knowledge Base may not be applicable to all systems and situations. Intershop Communications will not be liable to any party for any direct or indirect damages resulting from the use of the Customer Support section of the Intershop Corporate Web site, including, without limitation, any lost profits, business interruption, loss of programs or other data on your information handling system.

Customer Support
Knowledge Base
Product Resources
Support Tickets