Google Git
Sign in
apache / manifoldcf-sdk / refs/tags/v0.0.4
commitd98110b5a05f1d95ea5b6ad2cd2ac7456019a2e8[log] [tgz]
authorPiergiorgio Lucidi <plucidi@ziaconsulting.com>Thu Dec 21 23:00:01 2023 +0100
committerPiergiorgio Lucidi <plucidi@ziaconsulting.com>Thu Dec 21 23:00:01 2023 +0100
tree9570288735c1266b0a96f64ed9d91b8579c77cfd
first commit migrating 0.0.4 release
18 files changed
tree: 9570288735c1266b0a96f64ed9d91b8579c77cfd
  1. mcf-docker-overlay/
  2. mcf-extensions-jar/
  3. src/
  4. .asf.yaml
  5. .gitignore
  6. LICENSE
  7. pom.xml
  8. README.md
  9. run-site.bat
  10. run-site.sh
  11. run.bat
  12. run.sh
README.md

Apache ManifoldCF SDK 0.0.4

This is the SDK project of Apache ManifoldCF dedicated to developers that need to extend the platform with new components, connectors or integrations using Maven and Docker. On the other hand this SDK can be extremely useful also for all the developers who want to contribute to the ManifoldCF project. This project has started with an initial contribution by @OpenPj and @binduwavell.

The SDK will take care of the following tasks:

  • Creating the Docker Volumes for the MCF Maven Repo and the MCF installation
  • Preparing the Docker Image for executing the build installing Ant and Maven
  • Running the container for executing the building process with Ant and then with Maven
  • Copying the entire Maven Repo in the Maven target folder in the host machine (locally)
  • Generating the MCF official site

Examples of commands using the main bash script for a typical usage:

  • ./run.sh init 2.26 ga -> start the init process for ManifoldCF 2.26 GA
  • ./run.sh build_start -> build extensions and run everything with Docker locally
  • ./run.sh start -> start all the containers (MCF and PostgreSQL)
  • ./run.sh stop -> stop all the containers (MCF and PostgreSQL)

Examples of commands for developing and testing MCF itself:

  • ./run.sh init 2.22.1 rc -> start the init process for ManifoldCF 2.22.1 RC
  • ./run.sh test -> execute unit and integration tests in the MCF source bundle
  • ./run.sh clean -> execute ant clean; mvn clean in the MCF source bundle
  • ./run.sh purge -> removes all the Docker Volumes and the MCF init container

Examples of commands for generating the MCF website contents:

  • ./run-site.sh build -> Start Apache ManifoldCF SDK initialization for generating website contents
  • ./run-site.sh start -> Run ManifoldCF Site Docker container
  • ./run-site.sh purge -> Remove the ManifoldCF Site Docker artifacts and volumes
  • ./run-site.sh clean -> Start the mcf-sdk-site in order to clean the project
  • ./run-site.sh stop -> Stop the mcf-sdk-site

Initializing the local Maven repository using Docker

In order to compile extensions with Maven, the SDK provides an initialization script that will download the source code of ManifoldCF and then build it in the container. At the end of the build process the Maven repository included in the container will be copied in the local folder target/mcf-maven-repo. The local Maven repo will be used as the main reference for compiling the extension code.

The initialization command consists of the following arguments:

  • MCF version
  • MCF distribution: ga for GA release and rc for a Release Candidate

Example for initializing ManifoldCF 2.26 GA release:

  • ./run.sh init 2.26 ga

Example for initializing ManifoldCF 2.27.1 RC release:

  • ./run.sh init 2.27.1 rc

The initialization process will be executed with the following command:

  • /run.sh init 2.21 ga

Building extensions, overlaying and run Docker

A Dockerfile and a Docker Compose file is provided in order to build the ManifoldCF container and for running the instance with its own database, a PostgreSQL container.

The following command will take care of building extensions, run tests and building and running the ManifoldCF container

  • ./run.sh build_start

To stop all the containers:

  • ./run.sh stop

Executing tests in the container

For running MCF tests related to the source code bundle:

  • ./run.sh test -> execute unit and integration tests for the related MCF version initialized in the Docker Volumes

Docker images, containers and volumes

The Docker images, containers and volumes managed by ManifoldCF SDK are the following:

run.sh (.bat)

The Docker image created with for creating the ManifoldCF installation and Maven repo is mcf-sdk-init. The Docker container built by the SDK in order to create the installation folder and the Maven repo is mcf-sdk-init-container.

Containers & Images

  • mcf-sdk-init -> image created with for creating the ManifoldCF installation
  • mcf-sdk-init-container -> container built by the SDK in order to create the installation folder and the Maven repo

Volumes

  • mcf-maven-repo -> this volume contains the Maven repo created by the initialization process
  • mcf-app-volume -> this volume contains the installation storage of ManifoldCF

run-site.sh (.bat)

Containers & Images

  • mcf-sdk-site -> image created with specific version of Apache Ant 1.9.x, Python 2.7.x and OpenJDK 8
  • mcf-sdk-site -> container running the generation process of the website contents

Volumes

  • mcf-site-source -> this volume contains the site trunk code
  • mcf-site-generated-volume -> this volume contains the generated site