alfresco-transform-core/README.md at a6e016fe7f424fa1c699c4e93ea74f47fe56e114

mirror of https://github.com/Alfresco/alfresco-transform-core.git synced 2025-05-12 17:04:48 +00:00

ACS-2718 Streamline ATS t-model/t-core (#586 )

* Merge alfresco-transform-model project into alfresco-transform-core - WITHOUT the git history
* Simplify Maven dependencies and build project
* Unify release process of combined t-model and t-core

2022-04-05 17:36:43 +01:00

4.2 KiB

Raw Blame History

Alfresco Transform Core

Contains the common transformer (T-Engine) code, plus a few implementations.

Sub-projects

alfresco-transform-model - library packaged as a jar file which contains the data model of json configuration files and messages sent between clients, T-Engines and T-Router. Also contains code to work out which transform should be used for a combination of configuration files; see the sub-project's README
alfresco-transformer-base - library packaged as a jar file which contains code that is common to all the transformers; see the sub-project's README
alfresco-transform-<name> - multiple T-Engines; each one of them builds both a SpringBoot fat jar and a Docker image

Documentation

In addition to the subprojects (such as alfresco-transformer-base README above) some additional documentation can be found in:

this project's docs folder
ACS Packaging docs folder

Note: if you're interested in the Alfresco Transform Service (ATS) that is part of the enterprise Alfresco Content Services (ACS) please see:

https://docs.alfresco.com/transform/concepts/transformservice-overview.html

Building and testing

The project can be built by running the Maven command:

mvn clean install -Plocal,docker-it-setup

The local Maven profile builds local Docker images for each T-Engine.

Artifacts

Maven

The artifacts can be obtained by:

downloading from Alfresco repository
getting as Maven dependency by adding the dependency to your pom file:

<dependency>
    <groupId>org.alfresco</groupId>
    <artifactId>alfresco-transform-model</artifactId>
    <version>version</version>
</dependency>

<dependency>
    <groupId>org.alfresco</groupId>
    <artifactId>alfresco-transformer-base</artifactId>
    <version>version</version>
</dependency>

and Alfresco Maven repository:

<repository>
  <id>alfresco-maven-repo</id>
  <url>https://artifacts.alfresco.com/nexus/content/groups/public</url>
</repository>

Docker

The core T-Engine images are available on Docker Hub.

Either as a single Core AIO (All-In-One) T-Engine:

alfresco/alfresco-transform-core-aio

Or as set of individual T-Engines:

You can find examples of using Core AIO in the reference ACS Deployment for Docker Compose:

You can find examples of using the individual T-Engines in the reference ACS Deployment for Helm / Kubernetes:

Release Process

For a complete walk-through check out the build-and-release.MD under the docs folder.

Contributing guide

Please use this guide to make a contribution to the project.

4.2 KiB Raw Blame History