Reference - Ansible4IOM Variables 1.0

Product Version

2.2

Product To Version

2.2
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

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-XXChanges the value updates super-users 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

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)Changes 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)Changes the value after initial run is possible. It always creates a new database. Renaming an existing database is not possible.

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_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-The content of the log directory will not be saved/restored by the standard process. You have to implement hooks for this functionality.
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_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----
is_oms_media_usercluster.propertiesX---
is_oms_media_passcluster.propertiesX---
is_oms_pdf_hostcluster.properties----
is_oms_pdf_usercluster.propertiesX---
is_oms_pdf_passcluster.propertiesX---
is_oms_smtp_hostcluster.propertiesXXX-
is_oms_smtp_portcluster.propertiesXXX-
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_jboss_base_urlcluster.propertiesXXX-
is_oms_validation_pattern_phonecluster.propertiesXXX-
is_oms_db_hostlistcluster.propertiesXXX-
is_oms_jms_hostlistcluster.propertiesXXX-
is_oms_media_healthcheckcluster.propertiesXXX-
is_oms_pdf_healthcheckcluster.propertiesXXX-
is_oms_validation_pattern_emailcluster.propertiesXXX-
is_oms_validation_pattern_passwordcluster.propertiesXXX-
is_oms_validation_pattern_password_hintcluster.propertiesXXX-
OMS_SERVER_READY_TIMEOUT-XXX-

2.4 Load-balancer

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 

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