QA » openQA Project

Motivation¶

Helm charts allows you to automate the deployment of a complex set of items in a kubernetes environment. These elements are not only limited to pods (containers) but also to configurations (configmaps and secrets), and all the resources they need in the correct order and with the proper checks.

Thanks to the work done in #80142 we saw how to divide the web UI into parts, which were could be converted into HA and which had to remain standalone. In addition to how we should configure the load balancer to integrate each of the different services that make up the complete web UI.

This ticket proposes to create a helm chart capable of generating a complete and functional deployment of the web UI based on the following prerequisites:

• There is a pre-existing installation of kubernetes

Acceptance criteria¶

• AC1: The complete web UI HA is installed with the DB with the default options
• AC2: The web UI is accessible from outside of the cluster
• AC3: The helm chart is configurable with: Typical and basic parameters and, number of replicas for HA, type of persistence for DB, ...
• AC4: Documentation is completed with instructions of use
• AC5: Deployed together with rancher

Suggestions¶

• Highly recommended based on work already done in #80142, e.g. the existing docker-compose setup
• Proof-of-concept of either openQA webUI or worker within kubernetes, e.g. using k3s or try rancher directly done for both webUI and worker in #110524
• Use local kubernetes deployments to development purposes (this avoid the infra needs). For instance: minikube, k3s,...
• Figure out if is necessary to publish the helm chart and where: https://helm.sh/docs/howto/chart_releaser_action/
• Combine with rancher
• Ensure proper testing of the charts
  • Create kubernetes cluster inside docker inside GitHub Actions: https://github.com/marketplace/actions/kind-cluster
  • Look at chart-testing tool: https://github.com/marketplace/actions/helm-chart-testing
  • Try to deploy the chart inside CI
• Add definitions for init containers to allow fetching tests/needles from git repository during installation
• As an alternative to git, provide a persistent volume claim template for shared volume (ReadMany) -- think about Longhorn
• Add definition for rsyncd container to allow usage of cache service in the worker pod to synchronize data between webui and worker pods
• Enhance customization options of the current chart, add common options (like annotations, pod security, replicas count, ...) which are provided by the blank helm templates (reuse initial templates created by helm create)