Skip to content

Latest commit

 

History

History
43 lines (30 loc) · 2.36 KB

continuous-integration-and-delivery.md

File metadata and controls

43 lines (30 loc) · 2.36 KB
Raw

Universal Resolver — Continuous Integration and Delivery

This section describes the building-blocks and ideas of the implemented CI/CD pipeline. In case of issues or requests in the scope of CI/CD, please directly consult the maintainers of the repository.

Intro

The CI/CD pipeline helps achieving the following goals:

  • Detection of problems asap
  • Short and robust release cycles
  • Avoidance of repetitive, manual tasks
  • Increase of Software Quality

After every code change the CI/CD pipeline builds all software packages/Docker containers automatically. Once the containers are built, they are automatically deployed to the dev-system. By these measures building as well as deployment issues are immediately discovered. Once the freshly built containers are deployed, automatic tests are run in order to verify the software and to detect functional issues.

Building Blocks

The CI/CD pipeline is constructed by using GitHub Actions. The workflows are run after every push to the main branch and on ever PR against the main branch. The workflows consist of several steps. Currently, the two main steps are:

  1. Building the resolver (workflow file https://github.com/decentralized-identity/universal-resolver/blob/main/.github/workflows/docker-build-and-deploy-image.yml)
  2. Deploying the resolver (workflow file https://github.com/decentralized-identity/universal-resolver/blob/main/.github/workflows/kubernetes-deploy-to-cluster.yml)

The first step builds a Docker image and pushes it to Docker Hub at https://hub.docker.com/u/universalresolver. The second step takes the image and deploys it (create or update) to the configured Kubernetes cluster.

Steps of the CI/CD Workflow

  1. Dev pushes code to GitHub
  2. GitHub Actions (GHA) is triggerd by the „push“ event, clones the repo and runs the workflow for every container:
    • (a) Docker build
    • (b) Docker push (Docker image goes to DockerHub)
    • (c) Deploy to Kubernetes
    • (d) Runs a test-container
  3. Manual and automated feedback

Open Issues regarding CI/CD

  • Make all drivers accessible via sub-domains eg. elem.dev.uniresolver.io
  • Bundle new release for resolver.identity.foundation (only working drivers)
  • Render Smoke Test results as HTML-page and host it via gh-pages
  • Update documentation