The MultiApps Controller (formerly known as deploy service) for Cloud Foundry is based on the Multitarget Application (MTA) model, in which CF applications are modeled as modules and CF services as resources. The MTA model enables the delivery of packaged applications, where any target specific configuration could be specified on deployment time without changing application code. For more information about the Multitarget Application model, see the official Multitarget Application Model v.2 and the Multitarget Application Model v.3 specification documents.
The CF MultiApps Controller provides the possibility to operate (deploy, update, undeploy) CF entities (applications, services, routes, etc.) with a single command, while ensuring the consistency and completeness of the entire MTA.
You can find more information about what the MultiApps Controller offers in the way of functionality as well as information about creating MTA archives on the MultiApps Controller Wiki. If you are planning to deploy on the SAP Business Technology Platform you can find even more information in the official SAP Help Documentation under Multitarget Applications.
The project has also provided schema support in the open Schema Store which would provide auto-completion, tooltips, syntax checking and more when writing MTA descriptors.
Contains the Swagger generated definitions of the REST API models and endpoints. The complete Swagger definitions can be found at: https://app.swaggerhub.com/apis/SAP53/mtarest/1.3.0 and https://app.swaggerhub.com/apis/SAP53/mtarest2.0/2.0.0
Extends the Java Client Library for Cloud Foundry with additional domain model objects and attributes, OAuth token providers and retrying functionality.
Contains the domain model, persistence and other core services and utilities.
Can be used to migrate the data from an existing MultiApps Controller database to a new one.
Contains utilities for upload and processing of file artifacts. These are used for initial upload of the MTA archive and descriptors and their processing as part of the deployment.
Contains the concrete workflow definitions for MTA operations like deploy, undeploy, blue-green deploy, etc. These are modeled via Flowable BPMN process definitions. The process definitions have steps, where each step logic uses the Cloud Foundry Java client to call the Cloud Foundry API.
Contains a client for the graceful shutdown API of the MultiAppsController.
Contains REST API implementations for:
- performing MTA applications - executing deploy, undeploy, blue-green deploy
- listing deployed MTA applications
- listing MTA operations - both ongoing and historic ones
- reading and writing cross MTA configurations
The result from the build of this component is a WAR file which is the deployable assembly of the MultiApps Controller.
WARNING: With Issue 117 the master branch of this repository as well as other artifacts will be renamed. Adaptation to any CI/CD infrastructure & scripts will be required.
All components are built with Java 17 and Apache Maven, version 3.9.6 or newer.
Make sure that your Maven is configured to use Java 17 by configuring the JAVA_HOME env to point to the correct Java JDK.
To build all components, run the following command from the root directory of the project:
$ mvn clean install
The deployable result from building components is a WAR file, located at multiapps-controller-web/target/multiapps-controller-web-<version>.war.
Additionally, the project uses Immutables to generate value objects. As a result, it won't compile in IDEs like Eclipse or IntelliJ unless you also have an enabled annotation processor. See this guide for instructions on how to configure your IDE.
There is also a certain preprocessing of the manifest.yml that creates a version of the manifest with information about the newly built MultiApps-Controller such as version and path to the built WAR file.
This manifest is located at multiapps-controller-web/target/manifests/manifest.yml.
The CF MultiApps Controller is deployed as a standard application in Cloud Foundry. So first you have to get access to a Cloud Foundry instance, log in and target an organization and space, where the CF deploy service application is to be deployed.
If you do not have a Cloud Foundry instance you can sign up for SAP Business Technology Platform trial here.
The manifest.xml located at multiapps-controller-web/target/manifests/manifest.yml is used to configure the deployment of the MultiApps Controller to Cloud Foundry as well as some of its functionality.
| Property | Sample Value | Description |
|---|---|---|
| host | deploy-service | The entry can be changed to define a different host name for the application. |
| memory | 1024M | This setting can be further tuned depending on the expected load. If you set the memory to too low, the application might fail to start due to JVM heap memory shortage. |
| instances | 1 | The CF MultiApps Controller can also scale by instances. The default number of instances is set to 1 to avoid consuming too much resources. |
In order to function the CF Multiapps Controller requires a PostgreSQL service instance for persistence. So, this should first be created by running the create-service command:
$ cf cs <postgresql-service> <postgresql-service-plan> deploy-service-database
Push the CF MultiApps Controller application to Cloud Foundry by running the following command from the multiapps-controller-web directory:
$ cf push -f target/manifests/manifest.yml
After the push operation completes then the CF MultiApps Controller should be up and running.
In order to use the CF MultiApps Controller you should install the multiapps plugin, so follow the instructions in the Download and installation section there. For the set of supported operations and examples refer to the Usage section.
If you're using a different host than the default for your CF MultiApps Controller either set the following environment variable MULTIAPPS_CONTROLLER_URL=<URL> or run CF MTA plugin commands with -u <URL> so that they are executed against your instance(s) of the MultiApps Controller.
You could use a modified spring-music application, which is extended and adapted to the MTA model to test your newly deployed MultiApps Controller.
- Did you find a bug?
- Do you have a question or need support?
- How to develop, test and contribute to MultiApps Controller
Presentations, documents, and tutorials:
- Managing Distributed Cloud Native Applications Made Easy (CF Summit EU 2017 slides)
- Managing Distributed Cloud Native Applications Made Easy (CF Summit EU 2017 video)
- CF orchestration capabilities by tutorial & example
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.