wcm_io_devops.aem_service

This role manages an Adobe Experience Manager (AEM) 6.x service on Linux servers. It ensures that the service starts up and shuts down completely and allows for restarting the service when needed.

This role was created as part of the wcm.io DevOps Ansible Automation for AEM to work with CONGA but can also be used on its own.

Requirements

You need Ansible version 2.7 or above to use this role, which works with AEM 6.1 or newer. The AEM service on your target machine must be controllable with the Ansible service module.

Role Variables

Here are the variables you can use, along with their default values:

• aem_service_name:
  The name of the AEM service on the target machine.

• aem_service_port:
  This is the port the AEM instance listens to, which is needed to check if startup or shutdown is finished.

Additional optional variables:

• aem_service_state: started
  Defines what state you want the service to be in when the role finishes. Options are started, stopped, or restarted. Using started and stopped won't change the state unless necessary, but restarted will always restart the service.

• aem_service_timeout: 1200
  The maximum time to wait for the startup or shutdown to complete, measured in seconds.

• aem_service_restricted_mode: false
  Turns on or off the restricted mode for running custom commands like sudo.

• aem_service_start_command:
  You can set a custom start command here.

• aem_service_stop_command:
  You can set a custom stop command here.

• aem_service_status_command:
  You can set a custom status command here.

• aem_service_status_stopped_status_codes:
  Custom codes for a stopped status, if set.

• aem_service_status_started_status_codes:
  Custom codes for a started status, if set.

• aem_service_status_valid_status_codes:
  Combines all valid status codes for AEM.

Dependencies

This role does not have strict dependencies but works closely with the wcm_io_devops.aem_cms role.

Example Playbook

This example stops the aem-author service and waits for it to shut down completely:

- hosts: aem-author
  roles:
    - { role: wcm_io_devops.aem_service,
        aem_service_state: stopped,
        aem_service_name: aem-author,
        aem_service_port: 4502 }

License

Apache 2.0