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.
and
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 | Changes 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 . |
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) | 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. |
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_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_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_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_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 | - |
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 |
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.