Skip to content

Waldur CI/CD

General Architecture

Waldur uses CI/CD approach for testing, packaging and deployment. The approach is implemented with GitLab CI system. It provides a framework for building pipelines. A pipeline consists of a sequence of stages, each of which depends on the result of a predecessor and includes smaller parts called jobs. A job is a sequence of actions executed for a specific purpose, e.g., testing an application.

The entire CI/CD pipeline consists of smaller pipelines, each of which resides in a corresponding repository and belongs to a particular part.

The CI pipelines are created for the following modules:

  • Waldur Mastermind - REST API backend
  • Waldur Homeport - frontend module
  • Waldur Docker Compose - configuration for single-node deployment via Docker Compose
  • Waldur Helm Chart - package with templates of Kubernetes manifests for workload resources

The CD pipelines were created for several Waldur deployments like Waldur development or production.

The following diagram illustrates the general picture of the pipeline.

CI/CD Pipeline for Waldur

Pipeline architecture for Waldur Components

Waldur components are the separate applications of Waldur. The two major ones are Waldur Mastermind and Waldur Homeport.

Pipeline for Waldur Components

There are three main stages in the pipeline:

  • Test, where the source code lint and unit testing takes place. This stage runs for each commit in a merge request and for the main branch commits;
  • Build, where Docker image is being built. This stage runs for the main branch commits;
  • Release, where Docker image from the last stage is being published in Docker Hub registry. This stage runs for the main branch commits.

Pipeline architecture for Waldur Deployment Templates

Waldur deployment templates are the configurations for different deployment environments. Currently, Waldur supports Docker Compose and Kubernetes. The structure of the latter one is based on Helm technology. The pipeline is shown below.

Pipeline for Waldur Deployment Templates

This pipeline includes two stages:

  • Test, where the source code lint and configuration testing takes place. This stage runs for each commit in a merge request and the main branch commits;
  • Release, where the configuration is published to GitHub. This step is implemented with GitLab mirroring.

Pipeline architecture for Waldur Deployments

In this context, deployments are repositories with values for further insertion into Waldur Deployment Templates. For example, they can be values for environmental variables used in Waldur containers. The pipeline is shown below.

Pipeline for Waldur Deployments

There are three independent stages:

  • Deploy, where Waldur release is installed or updated. This stage runs only for main branch commits. For Docker Compose environment, this stage is triggered automatically. For Kubernetes, it runs automatically only for update operations, while installation requires a manual trigger. Also, the update action runs by a schedule, e.g. at 5 AM;
  • Test, where the running Waldur instance is tested. For example, it checks availability via HTTP requests sent to public Waldur endpoints;
  • Undeploy, which removes the Waldur instance. This stage can be triggered only manually.

Last update: 2022-02-18