- Menu
- Sitemap
Reference - Ansible4IOM Variables 1.1
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
- Concept - Ansible4IOM Server Configuration Management 1.0 - 1.1
- Reference - Ansible4IOM Processes
- Reference - Ansible4IOM Hooks
and
2 Ansible4IOM Variables
2.1 PostgreSQL Server
Possible default values for these variables can be read in roles/pgserver_config/defaults/main.yml
| Variable | Configuration File | Changes can be applied in this process | Comment | |
|---|---|---|---|---|
| setup_pgserver | reconfigure_pgserver | |||
| PGSERVER_VERSION | - | X | - | - |
| PGSERVER_PORT | {{PGSERVER_DATA}}/postgresql.conf | X | X | - |
| PGSERVER_DATA | /usr/lib/systemd/system/postgresql-*.service.d/environment.conf | X | - | The data directory cannot be moved after initial setup. |
| PGSERVER_SUPERUSER | - | X | - | - |
| PGSERVER_SUPERUSER_PASSWD | - | X | X | Changing the value updates super-users password. |
| PGSERVER_TRUSTED_HOSTS | {{PGSERVER_DATA}}/pg_hba.conf | X | X | - |
| PGSERVER_USER_NAME | - | X | X | Only used to control access to oms-db. Changing the value does not change the user account, it only allows |
| PGSERVER_USER_DB | - | X | X | Only 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
| Variable | Configuration File | in Process setup_omsdb | Comment |
|---|---|---|---|
| OMSDB_SUPERUSER | - | X | Used only to access DB-server with super-user access rights. Changing the value does not have any impact on super-user. |
| OMSDB_SUPERUSER_PASSWD | - | X | Used only to access DB-server with super-user access rights. Changing the value does not have any impact on super-user. |
| OMSDB_HOST | - | X | Used only to access DB-server. Changing the value does not have any impact on PostgreSQL-server. |
| OMSDB_PORT | - | X | Used 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 | - | X | Could 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
| Variable | Configuration File | Changes can be applied in this process | Comment | ||
|---|---|---|---|---|---|
| setup_oms_node | update_oms_node | reconfigure_oms_node | |||
| PG_VERSION | - | X | - | - | Used to install PG client of requested version |
| OMS_PUBLIC_DOMAIN_NAME | - | X | X | X | - |
| OMS_PUBLIC_PROTOCOL | - | X | X | X | - |
| OMS_PUBLIC_PORT["http"|"https"] | - | X | X | X | - |
| OMS_SERVER_TYPE | installation.properties | - | - | - | Never set this variable explicitly, it is set by the processes automatically. |
| OMS_VERSION | - | X | X | - | - |
| OMS_REPO_URL | - | X | X | - | - |
| OMS_REPO_USER | - | X | X | - | - |
| OMS_REPO_PASSWD | - | X | X | - | - |
| OMS_REPO_SKIP | - | X | X | - | - |
| OMS_USER | installation.properties | X | - | - | - |
OMS_USER_HOME | - | X | X | - | - |
| OMS_USER_ID | - | X | - | - | - |
| OMS_GROUP | - | X | - | - | - |
| OMS_GROUP_ID | - | X | - | - | - |
OMS_HOME[OMS_SERVER_TYPE] | installation.properties | X | X | - | - |
| OMS_ETC[OMS_SERVER_TYPE] | - | X | X | - | - |
| OMS_VAR[OMS_SERVER_TYPE] | installation.properties | X | X | - | - |
| OMS_LOG[OMS_SERVER_TYPE] | installation.properties | X | X | - | 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.properties | X | X | (X) | You may only add new entries in process reconfigure_oms_node. |
| OMS_JAVA_HOME | installation.properties | X | X | X | Referenced Java has to exist in advance. |
JBOSS_SERVICE_NAME[OMS_SERVER_TYPE] | - | X | - | - | - |
| SERVER_ID[OMS_SERVER_TYPE] | installation.properties | X | X | X | - |
| JBOSS_JAVA_OPTS[OMS_SERVER_TYPE] | installation.properties | X | X | X | - |
| JBOSS_HOME[OMS_SERVER_TYPE] | installation.properties | X | X | - | - |
| JBOSS_BIND_ADDRESS[server-type] | installation.properties | X | X | X | - |
| JBOSS_ADMIN_USER[server-type] | installation.properties | X | X | - | - |
| JBOSS_ADMIN_PASSWD[server-type] | installation.properties | X | X | - | - |
| JBOSS_PORT_OFFSET | installation.properties | X | X | X | JMS- and load balancer configuration are not updated automatically. |
| WATCHDOG_JAVA_OPTS | installation.properties | X | X | X | - |
| is_oms_db_name | cluster.properties | X | X | X | - |
| is_oms_db_user | cluster.properties | X | X | X | - |
| is_oms_db_pass | cluster.properties | X | X | X | - |
| is_oms_db_cache | cluster.properties | X | X | X | - |
| is_oms_xmlbinder_cache | cluster.properties | X | X | X | - |
| is_oms_media_host | cluster.properties | - | - | - | - |
| is_oms_media_user | cluster.properties | X | - | - | - |
| is_oms_media_pass | cluster.properties | X | - | - | - |
| is_oms_pdf_host | cluster.properties | - | - | - | - |
| is_oms_pdf_user | cluster.properties | X | - | - | - |
| is_oms_pdf_pass | cluster.properties | X | - | - | - |
| is_oms_smtp_host | cluster.properties | X | X | X | - |
| is_oms_smtp_port | cluster.properties | X | X | X | - |
| is_oms_smtp_user | cluster.properties | X | X | X | Optional, The user name for mail server authentication. |
| is_oms_smtp_pass | cluster.properties | X | X | X | Optional, The user password for mail server authentication |
| is_oms_mail_external_from | cluster.properties | X | X | X | - |
| is_oms_mail_internal_from | cluster.properties | X | X | X | - |
| is_oms_mail_internal_to | cluster.properties | X | X | X | - |
| is_oms_mail_internal_cc | cluster.properties | X | X | X | - |
is_oms_mail_internal_bcc | cluster.properties | X | X | X | - |
| is_oms_mail_businessoperations_to | cluster.properties | X | X | X | - |
| is_oms_mail_resources_base_url | cluster.properties | X | X | X | - |
| is_oms_jboss_base_url | cluster.properties | X | X | X | - |
| is_oms_validation_pattern_phone | cluster.properties | X | X | X | - |
| is_oms_db_hostlist | cluster.properties | X | X | X | - |
| is_oms_jms_hostlist | cluster.properties | X | X | X | - |
| is_oms_media_healthcheck | cluster.properties | X | X | X | - |
| is_oms_pdf_healthcheck | cluster.properties | X | X | X | - |
| is_oms_healthcheck_cachelivetime | cluster.properties | X | X | X | (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. 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. |
| is_oms_healthcheck_recurringtime | cluster.properties | X | X | X | (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_enabled | cluster.properties | X | X | X | (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_email | cluster.properties | X | X | X | - |
| is_oms_validation_pattern_password | cluster.properties | X | X | X | - |
| is_oms_validation_pattern_password_hint | cluster.properties | X | X | X | - |
| OMS_SERVER_READY_TIMEOUT | - | X | X | X | - |
| OMS_DB_USER_CONNECTION_SUFFIX | cluster.properties | X | X | X | Could 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 File | Changes can be applied in this process | Comment | |
|---|---|---|---|---|
| setup_load_balancer | reconfigure_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.conf | X | X | see Apache 2.4 Core |
| APACHE_LB_SCHEDULER | {{APACHE_INSTALL_DIR}}/conf/oms/balancer.conf | X | X | |
| APACHE_LB_MEMBER_PARAMS | {{APACHE_INSTALL_DIR}}/conf/oms/balancer.conf | X | X | |
| APACHE_LB_HEALTHCHECK_INTERVAL | {{APACHE_INSTALL_DIR}}/conf/oms/balancer.conf | X | X | |
| APACHE_LB_OMSSERVER_LIST | {{APACHE_INSTALL_DIR}}/conf/oms/balancer.conf | X | X | see Apache 2.4 mod_proxy_balancer and Apache 2.4 mod_prox_hcheck |
| APACHE_MGMNT_USER | {{APACHE_INSTALL_DIR}}/conf/oms/balancer.conf | X | X | Management user, which is needed to access /server-status and /balancer-manager |
| APACHE_MGMNT_PASSWD | {{APACHE_INSTALL_DIR}}/conf/oms/balancer.conf {{APACHE_INSTALL_DIR}}/conf/htpasswd | X | X | Management user, which is needed to access /server-status and /balancer-manager |
| APACHE_REQUIRE_MGMNT | {{APACHE_INSTALL_DIR}}/conf/oms/balancer.conf | X | X | List 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.conf | X | X | List 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.conf | X | X | Log 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.