Pipeline Definition for Low-Code Solutions

Build & Deploy Pipeline Tasks and Steps

TypeScript Solutions

The Build and Deploy Pipeline for TypeScript Low-Code Solutions contains the following tasks:

• k5-build-managed-node
• k5-deploy

Java Solutions

The Build and Deploy Pipeline for Low Code Java Solutions contains the following Tasks:

• k5-build-managed-ddd-java
• k5-deploy

Task Steps Overview

Task Steps Build (k5-build-managed-node & k5-build-managed-ddd-java)

• prepare-validate-design-model
• prepare-denormalized-domain-model
• prepare-api-spec-gen
• build-baw-toolkit
• build-low-code-gen-ts
• prepare-solution-docker
• pack-helm-chart
• pack-installation-image

Task Steps Deploy (k5-deploy)

• prepare-image
• prepare-deploy-solution
• deploy-solution
• test-solution
• complete-deploy-solution

Task Steps Build (k5-build-managed-node)

The build part of the pipeline prepares the necessary k5-project files from the design time, builds and packs the artifacts needed for the deployment:

prepare-validate-design-model

Validates the Design Model (API Model, Domain Model and Solution Manifest). The result is saved in a result.json and can be shown in the logs of the pipeline run.

prepare-denormalized-domain-model

This job takes a normalized design model of a solution and converts it to its denormalized model form that is needed for the build steps. The denormalized model (JSON files) can be interpreted by the k5-project.

prepare-api-spec-gen

This job takes the API namespace's design model files provided as input and creates the API specification files in the format Swagger 2 and OpenApi 3.

build-baw-toolkit

The job takes one or more swagger files and transforms them into BAW importable tool-kits. The tool-kits are downloadable in the Details view of a solution in the Solution Envoy dashboard.

build-low-code-gen-ts

This job takes the domain model of the solution and generates/includes all code necessary to produce a working solution action executable. The resulting artifact will be a Node.js application that runs on a Node.js k5-project.

prepare-solution-docker

Creates the Docker image containing the necessary denormalized model files for the solution and the deploy jobs of the solution. The created Docker image will be saved as .tar file, packed in the result image (see pack-installation-image) and then used in the deploy-solution step.

pack-helm-chart

Creates the Helm chart for deploying the solution. This Helm chart is packed in the result image (see pack-installation-image) and then used in the deploy-solution step.

pack-installation-image

Packs the created Helm chart and the solution Docker image (.tar file) into the result image (image name: solutionAcronym:imageTag) and pushes it into the OpenShift Registry. That is needed, so the built solution artifacts can be used in the Deploy part of a Build & Deploy pipeline and in a Deploy pipeline in another k5-project.

Task Steps Build (k5-build-managed-ddd-java)

The build part of the pipeline prepares the necessary k5-project files from the design time, builds and packs the artifacts needed for the deployment.

Following steps function equally to the k5-build-managed-node task:

• prepare-validate-design-model
• prepare-denormalized-domain-model
• prepare-api-spec-gen
• build-baw-toolkit
• prepare-solution-docker
• pack-helm-chart
• pack-installation-image

The following step differs in the output from the above steps:

build-low-code-gen-ts

This job takes the domain model of the solution and generates/includes all code necessary to produce a working solution action executable. The resulting artifact will be a Java application and framework with provided API modelling.

Task Steps Deploy (k5-deploy)

The Deploy task of the pipeline deploys the solution into the k5-project and runs the solution tests if they exist:

prepare-image

Copies the image (containing the created solution image and solution helm chart) from the configured source (project and image tag) into the current k5-project.

prepare-deploy-solution

Unpacks the artifacts (created solution image as .tar file and the solution Helm chart) from the image (see prepare-image step) and push the solution image into the current namespace.

deploy-solution

It deploys the solution into the k5-project using solution Helm chart. The needed Helm variables for the solution deployment (configuration name ssob-sdo-values-yaml) are provided by the Configuration Management (see Solution Specific Configuration).

test-solution

It runs the solution tests. The needed configuration variables (test user) for the solution test (configuration name ssob-integration-test) are provided by the Configuration Management (see Solution Specific Configuration).

complete-deploy-solution

Prepares the result image (containing the created solution image and solution Helm chart) for the next stage.