Personal Library

Reference - Ansible4IOM Hooks 1.1

https://support.intershop.com/kb/2859F7

Introduction
- Glossary
- References
PostgreSQL Server Related Hooks
Apache Based Load Balancer Related Hooks
OMS Node Related Hooks

Product Version	2.2
Product To Version	2.11
Status	New Labels

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 available hooks, their relation to processes and their typical usage. Hooks will be used within Ansible4IOM to customize predefined operations tasks. The target group of this document are developers of a project as well as system administrators.

Glossary

Term	Description
Ansible4IOM	Ansible4IOM is a tool of IOM for server configuration management. Additionally operation tasks are predifined and can be customized.
Azure	A cloud computing service created by Microsoft for building, testing, deploying, and managing applications and services through a global network of Microsoft-managed data centers.
CI	Continous integration
Configuration Repository	In the scope of Ansible4IOM a configuration repository is a set of configurations that describes the used machines, values of variables hooks and more. It's a descripton of how to install a custom IOM.
DB	Database
EPEL	Extra Packages for Enterprise Linux is a repository of the Fedora-Project (https://fedoraproject.org/wiki/EPEL).
FS	File system
Gluster-FS	A scale-out network-attached storage file system
Hook	Hooks are part of Ansible4IOM. Hooks are a sophisticated way to customize processes. Additionally the behavior of processes can be simply customized by various variables.
IOM	The abbreviation for Intershop Order Management
IOM Watchdog	A tool of IOM to monitor and manage the availablity of IOM application servers
JMS	Java Message Service
OMS	The abbreviation for Order Management System, the technical name of the IOM
PG	PostgreSQL
RHEL	Red Hat Enterprise Linux
SQL	Structured Query Language

References

PostgreSQL Server Related Hooks

Hooks	Processes	Available Facts	Comment/ Usage
setup_pgserver	reconfigure_pgserver	cleanup_pgserver
post_pgserver_configuration_hook	X	X	-	PGServerOSUser PGServerOSGroup Use these variables when modifying configuration files. Confiiguration files are mostly owned by the user running the PostgreSQL-server.	adapt pg_hba.conf adapt postgresql.conf
pre_pgserver_cleanup_hook			X	-	Save logs Save data

Hooks

Processes

Available Facts

Comment/ Usage

setup_pgserver

reconfigure_pgserver

cleanup_pgserver

post_pgserver_configuration_hook

PGServerOSUser
PGServerOSGroup

Use these variables when modifying configuration files. Confiiguration files are mostly owned by the user running the PostgreSQL-server.

adapt pg_hba.conf
adapt postgresql.conf

pre_pgserver_cleanup_hook

Save logs
Save data

Apache Based Load Balancer Related Hooks

Hooks	Processes			Available Facts	Comment/ Usage
Hooks	setup_load_balancer	reconfigure_load_balancer	cleanup_load_balancer	Available Facts	Comment/ Usage
post_apache_configuration_hook	X	X	-	-	Adapt httpd.conf
pre_apache_extract_hook	X	-	-	ApachePkgDir	Provide apache package to be installed on a different way, not by Maven repository.

OMS Node Related Hooks

Hooks	Processes				Available Facts	Comment/ Usage
Hooks	setup_oms_node	update_oms_node	reconfigure_oms_node	cleanup_oms_node	Available Facts	Comment/ Usage
pre_sharedfs_detach_hook	-	X	-	X	-	Implement unmount operations for single-node installations
pre_oms_cleanup_hook	-	X	-	X	-	Save logs
post_sharedfs_attach_hook	X	X	-	-	-	Implement mount operations for single-node installations
pre_oms_extract_hook	X	X	-	-	-	Restore saved logs Setup ssh-config of oms-user Replace IOM-install package (e.g., during CI process)
post_oms_extract_hook	X	X	-	-	-	Receive and extract customization packages and copy content to destinations
pre_oms_dump_hook	X	X	-	-	OmsDumpVersion (DEPRECATED)	Load different dump than initial dump (e.g., test dump for CI process)
post_oms_dump_hook	X	X	-	-	-	Execute custom SQL scripts
pre_oms_initialization_hook	X	X	-	-	-	Adapt initSystem.std.*.cli Run custom scripts for Wildfly initialization
pre_oms_configuration_hook	X	X	X	-	-	Adapt system.std.*.properties before applying them
post_oms_configuration_hook	X	X	X	-	-	Adapt and load custom properties
pre_oms_deploy_hook	X	X	X	-	-	Adapt deployment.*.properties Artifacts will be deployed automatically, server will be redeployed after hook execution
post_oms_deploy_hook	X	X	X	-	-	Run custom SQL scripts, which require already deployed customizations Place import files to be imported automatically

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.