Skip to content

Commit

Permalink
Add galaxy metadata and README
Browse files Browse the repository at this point in the history
  • Loading branch information
interatom committed Sep 21, 2017
1 parent ccc6971 commit 8b7e819
Show file tree
Hide file tree
Showing 2 changed files with 71 additions and 2 deletions.
50 changes: 50 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
# aem-service

This role controls an Adobe Experience Manager (AEM) 6.x service on Linux servers and waits until the startup and shutdown is complete. It also provides a handler to only restart the instance as required from other roles/playbooks.
> This role was developed as part of the wcm.io set of roles to integrate Ansible with [CONGA](http://devops.wcm.io/conga/) and is designed to be used in combination with the [aem-cms](https://github.com/wcm-io-devops/ansible-aem-cms) role (but can be used independently).
## Requirements

This role requires Ansible 2.0 or higher and works with AEM 6.1 or higher. The role requires an AEM service that can be controlled with the Ansible `service` module to be installed on the target machine.

## Role Variables

These variables are shared with the [aem-cms](https://github.com/wcm-io-devops/ansible-aem-cms) role and are required to be set:

aem_instance_name

Name of the AEM service on the target machine.

aem_port

To be able to poll for completion of the startup and shutdown process the role needs to know the port the AEM instance is listening on.

Additionally the following optional variables are available:

aem_service_state: started

The desired state of the service after this role finishes, one of `started`, `stopped` or `restarted`. `started` and `stopped` are idempotent and will not change the state unless necessary while `restarted` will always restart the service.

aem_service_timeout: 1200

The time to wait for the startup or shutdown to finish (in seconds).


## Dependencies

This role has no hard dependencies but interacts heavily with the [aem-cms](https://github.com/wcm-io-devops/ansible-aem-cms) role.

## Example Playbook

Stops the `aem-author` instance and waits for the shutdown to complete:

- hosts: aem-author
roles:
- { role: aem-service,
state: stopped,
aem_instance_name: aem-author,
aem_port: 4502 }

## License

Apache 2.0
23 changes: 21 additions & 2 deletions meta/main.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,26 @@
galaxy_info:
author: Martin Wehner
description: Starts an AEM instance on Linux and provides restart handler
description: Controls AEM service on Linux
company: pro!vision
issue_tracker_url: https://wcm-io.atlassian.net
license: Apache
min_ansible_version: 2.0
min_ansible_version: 2.0

platforms:
- name: Ubuntu
versions:
- trusty
- xenial
- name: Debian
versions:
- jessie
- name: EL
versions:
- 7

galaxy_tags:
- aem
- cms
- web
- java
- wcmio

0 comments on commit 8b7e819

Please sign in to comment.