Reference - Ansible4IOM Hooks 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 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.

1.1 Glossary

Term
Description
Ansible4IOMAnsible4IOM is a tool of IOM for server configuration management. Additionally operation tasks are predifined and can be customized.
AzureA cloud computing service created by Microsoft for building, testing, deploying, and managing applications and services through a global network of Microsoft-managed data centers.
CIContinous integration
Configuration RepositoryIn 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.
DBDatabase
EPELExtra Packages for Enterprise Linux is a repository of the Fedora-Project (https://fedoraproject.org/wiki/EPEL).
FSFile system
Gluster-FSA scale-out network-attached storage file system
HookHooks are part of Ansible4IOM. Hooks are a sophisticated way to customize processes. Additionally the behavior of processes can be simply customized by various variables.
IOMThe abbreviation for Intershop Order Management
IOM WatchdogA tool of IOM to monitor and manage the availablity of IOM application servers
JMSJava Message Service
OMSThe abbreviation for Order Management System, the technical name of the IOM
PGPostgreSQL
RHEL

Red Hat Enterprise Linux

SQLStructured Query Language

1.2 References

2 PostgreSQL Server Related Hooks

HooksProcessesAvailable FactsComment/ Usage
setup_pgserverreconfigure_pgservercleanup_pgserver
post_pgserver_configuration_hookXX-
  • 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

3 Apache Based Load Balancer Related Hooks

HooksProcessesAvailable Facts

Comment/ Usage

setup_load_balancerreconfigure_load_balancercleanup_load_balancer
post_apache_configuration_hookXX-

-

Adapt httpd.conf

pre_apache_extract_hookX--ApachePkgDirProvide apache package to be installed on a different way, not by Maven repository.

4 OMS Node Related Hooks

HooksProcessesAvailable FactsComment/ Usage
setup_oms_nodeupdate_oms_nodereconfigure_oms_nodecleanup_oms_node
pre_sharedfs_detach_hook-X-X-
  • Implement unmount operations for single-node installations
pre_oms_cleanup_hook-X-X-
  • Save logs
post_sharedfs_attach_hookXX---
  • Implement mount operations for single-node installations
pre_oms_extract_hookXX---
  • Restore saved logs
  • Setup ssh-config of oms-user
  • Replace IOM-install package (e.g., during CI process)
post_oms_extract_hookXX---
  • Receive and extract customization packages and copy content to destinations
pre_oms_dump_hookXX--

OmsDumpVersion (DEPRECATED)

  • Load different dump than initial dump (e.g., test dump for CI process)
post_oms_dump_hookXX---
  • Execute custom SQL scripts
pre_oms_initialization_hookXX---
  • Adapt initSystem.std.*.cli
  • Run custom scripts for Wildfly initialization
pre_oms_configuration_hookXXX--
  • Adapt system.std.*.properties before applying them
post_oms_configuration_hookXXX--
  • Adapt and load custom properties
pre_oms_deploy_hookXXX--
  • Adapt deployment.*.properties
  • Artifacts will be deployed automatically, server will be redeployed after hook execution
post_oms_deploy_hookXXX--
  • 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.

Customer Support
Knowledge Base
Product Resources
Support Tickets