Overview
This page provides an overview of Ansible, the project structure and the components deployed.
Ansible Overview
Ansible models your IT infrastructure by describing how all of your systems inter-relate, rather than just managing one system at a time.
It doesn’t use any agents nor additional custom security infrastructure, so it’s easy to deploy - and most importantly, it uses a very simple language, YAML, in the form of Ansible Playbooks that allow you to describe your automation jobs in a way that approaches plain English.
An Ansible playbook contains one or more roles. A role is an independent component which allows reuse of common configuration steps. It consists of a set of tasks used to configure a host to serve a certain purpose, for example, configuring a service. This is depicted in the diagram below.
Roles are defined using YAML files with a predefined directory structure.
A role directory structure contains directories: defaults, vars, tasks, files, templates, meta, and handlers.
- defaults contains default variables for the role. Variables in defaults have the lowest priority so they are easy to override
- vars contains variables for the role. Variables in vars have higher priority than variables in the defaults directory
- tasks contains the main list of steps to be executed by the role
- files contains files which we want to be copied to the remote host. We don’t need to specify a path of resources stored in this directory
- templates contains file templates which support modifications from the role. We use the Jinja2 templating language for creating templates
- meta contains metadata of the role like an author, support platforms, and dependencies
- handlers contains handlers which can be invoked by “notify” directives and are associated with a service
Project Overview
The project contains a playbook and multiple roles.
The ACS playbook can be found in the playbooks directory. Because the project makes use of Ansible role structure, the playbook contains only definitions of the roles, and all the logic is performed by them, thus making the project both granular and easy to maintain.
The playbook uses the following roles:
- acc - deploys and configures Alfresco Control Center
- activemq - deploys and configures Apache ActiveMQ
- adw - deploys and configures Alfresco Digital Workspace
- common - contains a set of common tasks that prepares the specified host for other roles (creates user and group, common directories)
- elasticsearch - deploys and configures ElasticSearch cluster required by Alfresco Search Enterprise
- identity - deploys and configures Keycloak to enable SSO capabilities(optional)
- java - deploys OpenJDK
- nginx - deploys and configures Nginx as a proxy
- postgres - deploys and configures PostgreSQL
- repository - deploys and configures Alfresco Repository and Alfresco Share
- search - deploys and configures Alfresco Search Services (as an alternative to Search Enterprise)
- search_enterprise - deploys and configures Alfresco Search Enterprise
- sfs - deploys and configures Alfresco Shared File Store
- sync - deploys and configures Alfresco Sync Service
- tomcat - deploys and configures Apache Tomcat
- transformers - deploys and configures Alfresco Transform Service
- trouter - deploys and configures the Transform Router
The same playbook can be run to deploy the system in several different ways, please refer to the deployment guide for a step by step set of instructions.
Versioning
To understand which Operating System the Alfresco Ansible playbook can work against (on the target nodes), please refer to the Supported platform doc (pick the right Alfresco version).
We aim to support these stacks with the exception of Amazon Linux & Suse distributions.
Ansible version used for testing this playbooks can be retrieved from the Pipfile.
The table below shows the version of the components deployed by the playbook for ACS 7.x onward.
| Component | 23.3 Enterprise (Community) | 7.4 Enterprise | 7.3 Enterprise | 7.2 Enterprise | 7.1 Enterprise |
|---|---|---|---|---|---|
| OpenJDK | 17.0.11 | 17.0.11 | 11.0.23 | 11.0.23 | 11.0.23 |
| Apache Tomcat | 10.1.25 | 9.0.91 | 9.0.91 | 9.0.91 | 9.0.91 |
| PostgreSQL | 15.x | 14.x | 14.x | 13.x | 13.x |
| Apache ActiveMQ | 5.18.5 | 5.17.6 | 5.17.6 | 5.16.7 | 5.16.7 |
| Repository | 23.3.2 (23.3.0) | 7.4.2.1 | 7.3.2.1 | 7.2.2.5 | 7.1.1.10 |
| Share | 23.3.2 (23.3.0) | 7.4.2.1 | 7.3.2.1 | 7.2.2.5 | 7.1.1.10 |
| Search Services | 2.0.11 | 2.0.11 | 2.0.11 | 2.0.11 | 2.0.2.2 |
| Search Enterprise | 4.1.0 (n/a) | 3.3.3 | 3.2.1 | 3.1.1.1 | 3.1.1.1 |
| All-In-One T-Engine | 5.1.4 | 5.1.4 | 3.1.2 | 3.1.2 | 3.1.2 |
| AOS | 3.1.0 | 1.6.2 | 1.5.0 | 1.4.1 | 1.4.1 |
| Google Docs | 4.0.0 | 3.4.2 | 3.3.1 | 3.2.2 | 3.2.1 |
| Digital Workspace | 5.1.0 (n/a) | 4.0.0 | 3.1.0 | 3.0.0 | 2.6.1 |
| Control Center | 9.1.0 | 8.0.0 | n/a | n/a | n/a |
| Transform Router | 4.1.4 (n/a) | 4.1.4 | 2.1.2 | 2.1.2 | 2.1.2 |
| Shared File Store | 4.1.4 (n/a) | 4.1.4 | 2.1.2 | 2.1.2 | 2.1.2 |
| Sync Service | 5.0.0 (n/a) | 3.11.3 | 3.11.3 | 3.11.3 | 3.11.3 |
Support for ACS 7.0 has been deprecated since April 2024, but you can still use the latest playbook that supported it (v2.6.0) Support for ACS 6.2 has been deprecated since November 2022, but you can still use the latest playbook that supported it (v2.2.0)