isabella232 / cloud-mta-build-tool

Multi-Target Application (MTA) build tool for Cloud Applications https://sap.github.io/cloud-mta-build-tool

Description

Multi-Target Application

Before using this package, make sure that you are familiar with the multi-target application concept and terminology. For background and detailed information, see the Multi-Target Application Model guide.

The Cloud MTA Build Tool Overview

The Cloud MTA Build Tool is a standalone command-line tool that builds a deployment-ready multitarget application (MTA) archive .mtar file from the artifacts of an MTA project according to the project’s MTA development descriptor (mta.yaml file) or from module build artifacts according to the MTA deployment descriptor (mtad.yaml file). Also, it provides commands for running intermediate build process steps; for example, the mta.yaml file validations, building a single module according to the configurations in the development descriptor, generating the deployment descriptor, and so on.

For more information, see the Cloud MTA Build Tool user guide

Demo

This demo shows the basic usage of the tool. For more advanced scenarios, follow the documentation.

The Cloud MTA Build Tool Images

We supply serveral images for CI environment containg the Cloud MTA Build Tool. The images are hosted at Github container registry and also at Docker Hub registry. The images are built from template docker files which depend on most common technologies (Java and Node) as follows:

• mbtci-java8-node12 is built from Dockerfile_mbtci_java8 using Node 12.
• mbtci-java8-node14 is built from Dockerfile_mbtci_java8 using Node 14.
• mbtci-java11-node12 is built from Dockerfile_mbtci_java11 using Node 12.
• mbtci-java11-node14 is built from Dockerfile_mbtci_java11 using Node 14.

Additional image which is more light-weight and gives the flexibility to add "per-scenario" the required set of tools:

• mbtci-alpine is built from Dockerfile_mbtci_alpine.

How to pull the images

You should choose the relevant image type from following list to replace the <TYPE> template in the command/FROM according your MTA project technologies:

• java8-node12
• java8-node14
• java11-node12
• java11-node14
• alpine

From the command line:

$ docker pull devxci/mbtci-<TYPE>:latest

or

$ docker pull ghcr.io/sap/mbtci-<TYPE>:latest

From Dockerfile as a base image:

FROM devxci/mbtci-<TYPE>:latest

or

FROM ghcr.io/sap/mbtci-<TYPE>:latest

E.g. if your MTA project uses Java 11 and Node 14 then you should pull the relevant image as follows:

From the command line:

$ docker pull devxci/mbtci-java11-node14:latest

or

$ docker pull ghcr.io/sap/mbtci-java11-node14:latest

From Dockerfile as a base image:

FROM devxci/mbtci-java11-node14:latest

or

FROM ghcr.io/sap/mbtci-java11-node14:latest

How to use the images

You should choose the relevant image type from following list to replace the <TYPE> template in the command according your MTA project technologies:

• java8-node12
• java8-node14
• java11-node12
• java11-node14
• alpine

On a Linux/Darwin machine you can run:

docker run -it --rm -v "$(pwd)/[proj-releative-path]:/project" devxci/mbtci-<TYPE>:latest mbt build -p=cf -t [target-folder-name]

This will build an mtar file for SAP Cloud Platform (Cloud Foundry). The folder containing the project needs to be mounted into the image at /project.

Note: The parameter -p=cf can be omitted as the build for cloud foundry is the default build, this is an example of the MBT build parameters, for further commands see MBT docs.

How to build the images

To buid the images, you should choose the relevant docker file type from following list to replace the <TYPE> template in the Dockerfile according your MTA project Java version:

• java8
• java11

Copy the docker file template:

cp Dockerfile_<TYPE> Dockerfile

E.g. copy the docker file used for Java 8:

cp Dockerfile_java8 Dockerfile

Replace NODE_VERSION_TEMPLATE with your Node version in the Dockerfile:

ARG NODE_VERSION=NODE_VERSION_TEMPLATE

Then you can build the image:

docker build -t devxci/mbtci .

To build the mbtci-alpine image you can run:

docker build -f Dockerfile_alpine -t devxci/mbtci .

The images provide:

• Cloud MTA Build Tool - 1.2.8
• Nodejs - 12.22.5 or 14.17.5
• Maven - 3.6.3
• Golang - 1.14.7
• Java - 8 or 11

The MTA Archive Builder delegates module builds to other native build tools. These images provide Node.js, Maven, Java, and Golang so the archive builder can delegate to these build technologies. In case other build tools are needed, inherit from one of these images and add more build tools.

License

Copyright (c) 2020 SAP SE or an SAP affiliate company. All rights reserved. This file is licensed under the Apache Software License, v. 2 except as noted otherwise in the LICENSE file. Please note that Docker images can contain other software which may be licensed under different licenses. This License file is also included in the Docker image. For any usage of built Docker images please make sure to check the licenses of the artifacts contained in the images.

Contributions

Contributions are greatly appreciated. If you want to contribute, follow the guidelines.

Support

Please follow our issue template on how to report an issue.