Skip to the content.

Documentation

The key components of FlashPipe are

FlashPipe uses the public APIs of the SAP Integration Suite to automate the Build-To-Deploy cycle. The components are implemented in Groovy and compiled as Java executables.

While it is possible to use the Java executables directly, the Unix scripts do most of the heavy lifting by orchestrating between the various API calls required to complete the Build-To-Deploy cycle.

Prerequisite

To use FlashPipe, you will need the following

  1. Access to Cloud Integration on an SAP Integration Suite tenant - typically an Integration Developer credentials are required
  2. Access to a CI/CD platform, e.g. Azure Pipelines, GitHub Actions
  3. Git-based repository to host the contents of the Cloud Integration artifacts

Technically, it should be possible to use FlashPipe on any CI/CD platform that supports container-based pipeline execution and Unix script execution.

Docker image tags

FlashPipe’s Docker images comes in two flavours. The difference between the full and lite tags for each version release is the inclusion of Maven capabilities in the image.

Rolling tags

Starting from version 2.3.0, rolling tags are introduced to make it easier to get the latest version. Rolling tags are dynamic and will point to the latest version of the corresponding image. The following rolling tags are available:

Usage recommendation

Authentication

FlashPipe supports the following methods of authentication when accessing the SAP Integration Suite APIs.

It is recommended to use OAuth so that the access is not linked to an individual’s credential (which may be revoked or the password might change). For details on setting up an OAuth client for use with FlashPipe, visit the OAuth client setup page.

Usage of Unix scripts

For details on usage of the Unix scripts in pipeline steps, visit the Unix scripts page.

Usage examples

Following are different usage examples of FlashPipe on different CI/CD platforms.

Reference

The following repository on GitHub provides sample usage of FlashPipe.

https://github.com/engswee/flashpipe-demo