The Transform Service is deployed as part of the Alfresco Content Services deployment, using Docker images that are packaged in Helm charts. These charts are a deployment template which can be used as the basis for your specific deployment needs.
Note: Deployment of Transform Service with Content Services on AWS, such as Amazon EKS (Elastic Kubernetes Service), is recommended only for customers with a good knowledge of Content Services, and strong competencies in AWS and containerized deployment.
The following diagram shows how Content Services and the components of the Transform Service interact when deployed using Docker Compose.
The following diagram shows how Content Services and the components of the Transform Service interact when deployed using Helm charts.
There are a number of software requirements for deploying Transform Service.
The Transform Service is only deployed as part of Content Services for containerized deployments.
The images downloaded directly from Docker Hub, or Quay.io are for a limited trial of the Enterprise version of Content Services that goes into read-only mode after 2 days. For a longer (30-day) trial, get the Alfresco Content Services Download Trial.
Note: A Quay.io account is needed to pull the Docker images that are needed for the Transform Service:
The other images are available in DockerHub:
Software requirements (Helm)
To use the Content Services deployment (including the Transform Service), you need to install the following software:
- AWS CLI - the command line interface for Amazon Web Services.
- Kubectl - the command line tool for Kubernetes.
- Helm - the tool for installing and managing Kubernetes applications.
- There are Helm charts that allow you to deploy Content Services with Transform Service in a Kubernetes cluster, for example, on AWS.
See Install with Helm charts for more details.
Software requirements (Docker)
This is recommended for evaluations only (i.e. test and development environments).
- Docker (latest stable version)
- This allows you to run Docker images and
docker-composeon a single computer.
- This allows you to run Docker images and
- Docker Compose
- Docker Compose is included as part of some Docker installers. If it’s not part of your installation, then install it separately after you’ve installed Docker.
Note: Check the prerequisites for your operating system, both for Docker and Docker Compose.
See Install with Docker Compose for more details.
Install with Helm charts
Use this information to deploy Content Services (including the Transform Service) using Helm charts by running a Kubernetes cluster on Amazon Web Services (AWS). These charts are a deployment template which can be used as the basis for your specific deployment needs.
The Helm charts are provided as a reference that can be used to build deployments in AWS. If you’re a System administrator, ensure that data persistence, backups, log storage, and other system-level functions have been configured to meet your needs.
Here is a summary of the steps required:
- Set up your Kubernetes cluster on AWS.
- Install the Kubernetes Dashboard to manage your Kubernetes cluster.
- Set up Content Services on the Kubernetes cluster, including creating file storage.
- To access the images in Quay.io, you’ll need to generate a pull secret and apply it to your cluster.
- Deploy Content Services.
- Check the status of your deployment.
See the Alfresco/acs-deployment GitHub project documentation for the prerequisites and detailed setup.
Install with Docker Compose
Use this information to quickly start up Content Services (including Transform Service) using Docker Compose. Due to the limited capabilities of Docker Compose, this deployment method is only recommended for development and test environments.
To check which branch tag corresponds to a specific Content Services release, review the release versions page in GitHub. Choose a version from the left column that corresponds to the required Content Services version you want to deploy.
Note: Check the prerequisites for your operating system, both for Docker and Docker Compose, using the links provided.
Clone the project locally, and then change directory to the project folder:
git clone --branch x.y.z https://github.com/Alfresco/acs-deployment.git cd acs-deployment/docker-compose
Note: Replace the version number
x.y.zwith the tag that matches the Content Services version you want to deploy. For example, if you want Content Services 6.2.0, then select tag
Note: Make sure that exposed ports are open on your host computer. Check the
docker-compose.ymlfile to determine the exposed ports - refer to the
host:containerport definitions. You’ll see they include 5432, 8080, 8083 and others.
Log in to Quay.io using your credentials:
docker login https://quay.io
Deploy Content Services, including the repository, Share, Postgres database, Search Services, and Transform Service:
This downloads the images, fetches all the dependencies, creates each container, and then starts the system:
Creating network "docker-compose_default" with the default driver Creating docker-compose_postgres_1 ... done Creating docker-compose_share_1 ... done Creating docker-compose_tika_1 ... done Creating docker-compose_shared-file-store_1 ... done Creating docker-compose_digital-workspace_1 ... done Creating docker-compose_solr6_1 ... done Creating docker-compose_activemq_1 ... done Creating docker-compose_alfresco_1 ... done Creating docker-compose_libreoffice_1 ... done Creating docker-compose_imagemagick_1 ... done Creating docker-compose_alfresco-pdf-renderer_1 ... done Creating docker-compose_proxy_1 ... done Creating docker-compose_transform-misc_1 ... done Creating docker-compose_transform-router_1 ... done Creating docker-compose_sync-service_1 ... done Attaching to docker-compose_postgres_1, docker-compose_share_1, docker-compose_tika_1, docker-compose_shared-file-store_1
As an alternative, you can also start the containers in the background by running
docker-compose up -d.
Wait for the logs to show messages:
alfresco_1 | 2019-11-21 11:50:46,000 WARN ... The Alfresco Content Services license will expire in 2 days. alfresco_1 | 2019-11-21 11:50:50,341 INFO ... Starting 'Transformers' subsystem, ID: [Transformers, default] alfresco_1 | 2019-11-21 11:50:50,600 INFO ... Startup of 'Transformers' subsystem, ID: [Transformers, default] complete
If you encounter errors whilst the system is starting up:
- Stop the session (by using
- Remove the container using
--rmi all. This option also removes the images created by docker-compose up, and the images used by any service. You can use this, for example, if any containers fail and you need to remove them.
- Try allocating more memory resources, as advised in
docker-compose.yml. For example, in Docker, change the memory setting in Preferences (or Settings) > Advanced > Memory, to at least 6 GB. Make sure you restart Docker and wait for the process to finish before continuing.
- Go back to step 3 and start the deployment again.
Note: Although 16 GB is the required minimum memory setting, keep in mind that 6 GB is much lower than the required minimum, and may need to be adapted for your environment.
- Stop the session (by using
Open your browser and check everything starts up correctly:
Service Endpoint Administration and REST APIs
Search Services administration
Transform Router configuration
ActiveMQ Admin Web Console
Log in as the
adminuser. Enter the default administrator password
You can use a number of commands to check that the system started correctly, see below.
Check system start up
Use this information to verify that the system started correctly, and to clean up the deployment.
Open a new terminal window.
Change directory to the
docker-composefolder that you created in the deployment steps.
Verify that all the services started correctly.
List the images and additional details:
You should see a list of the services defined in your
Container Repository ... Size ---------------------------------------------------------------------------------------------------- docker-compose_activemq_1 alfresco/alfresco-activemq ... 447 MB docker-compose_alfresco-pdf-renderer_1 alfresco/alfresco/alfresco-pdf-renderer ... 625 MB docker-compose_alfresco_1 alfresco/alfresco-content-repository ... 1.02 GB docker-compose_digital-workspace_1 quay.io/alfresco/alfresco-digital-workspace ... 27.1 MB docker-compose_imagemagick_1 alfresco/alfresco/alfresco-imagemagick ... 698 MB docker-compose_libreoffice_1 alfresco/alfresco/alfresco-libreoffice ... 1.46 GB docker-compose_postgres_1 postgres ... 274 MB docker-compose_proxy_1 alfresco/alfresco/alfresco-acs-nginx ... 16.9 MB docker-compose_share_1 alfresco/alfresco-share ... 681 MB docker-compose_shared-file-store_1 alfresco/alfresco-shared-file-store ... 435 MB docker-compose_solr6_1 alfresco/alfresco-search-services ... 1.02e+03 MB MB docker-compose_sync-service_1 quay.io/alfresco/service-sync ... 738 MB docker-compose_tika_1 alfresco/alfresco/alfresco-tika ... 743 MB docker-compose_transform-misc_1 alfresco/alfresco/alfresco-transform-misc ... 712 MB docker-compose_transform-router_1 quay.io/alfresco/alfresco-transform-router ... 574 MB
List the running containers:
You should see a list of the services defined in the
View the log files for each service
<service-name>, or container
docker-compose logs <service-name> docker container logs `<container-name>`
For example, to check the logs for Share, run any of the following commands:
docker-compose logs share docker container logs docker-compose_share_1
You can add an optional parameter
<container-name>to display the last 25 lines of the logs for the selected container.
docker container logs --tail=25 docker-compose_share_1
Check for a success message:
Successfully retrieved license information from Alfresco.
Once you’ve tested the services, you can clean up the deployment by stopping the running services.
Stop the session by using
CONTROL+Cin the same window as the running services:
^CGracefully stopping... (press Ctrl+C again to force) Stopping docker-compose_proxy_1 ... done Stopping docker-compose_alfresco-pdf-renderer_1 ... done Stopping docker-compose_tika_1 ... done Stopping docker-compose_imagemagick_1 ... done Stopping docker-compose_transform-misc_1 ... done Stopping docker-compose_libreoffice_1 ... done Stopping docker-compose_transform-router_1 ... done Stopping docker-compose_sync-service_1 ... done Stopping docker-compose_alfresco_1 ... done Stopping docker-compose_solr6_1 ... done Stopping docker-compose_activemq_1 ... done Stopping docker-compose_postgres_1 ... done Stopping docker-compose_shared-file-store_1 ... done Stopping docker-compose_share_1 ... done Stopping docker-compose_digital-workspace_1 ... done
Alternatively, you can open a new terminal window, change directory to the
docker-composefolder, and run:
This stops the running services, as shown in the previous example, and removes them from memory:
Stopping docker-compose_transform-router_1 ... done ... Stopping docker-compose_postgres_1 ... done Removing docker-compose_transform-router_1 ... done ... Removing docker-compose_postgres_1 ... done Removing network docker-compose_default
You can use a few more commands to explore the services when they’re running. Change directory to
docker-composebefore running these:
Stop all the running containers:
Restart the containers (after using the
Starts the containers that were started with
Stop all running containers, and remove them and the network:
docker-compose down [--rmi all]
--rmi alloption also removes the images created by
docker-compose up, and the images used by any service. You can use this, for example, if any containers fail and you need to remove them.
See the Docker documentation for more on getting started with Docker and using Docker.