Project

General

Profile

coordination #81060

coordination #80142: [saga][epic] Scale out: Redundant/load-balancing deployments of openQA, easy containers, containers on kubernetes

[epic] openQA web UI in kubernetes

Added by ilausuch over 1 year ago. Updated about 1 month ago.

Status:
Blocked
Priority:
Low
Assignee:
Category:
Feature requests
Target version:
Start date:
2022-05-02
Due date:
% Done:

50%

Estimated time:
(Total: 0.00 h)
Difficulty:

Description

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
  • 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)

Subtasks

action #110524: [timeboxed:20h][spike] openQA proof-of-concept within kubernetes size:MResolvedjbaier_cz

action #110725: Unexpected behavior for cache service under k3s when the CACHE_MIN_FREE_PERCENTAGE is set size:MWorkable

action #111323: Simplified web proxy setup (remove path rewrite)Resolvedjbaier_cz

action #111329: openQA within kubernetes with tested helm charts size:MFeedbackjbaier_cz


Related issues

Related to openQA Project - action #76978: How to run an openQA test in 5 minutesNew2020-11-04

History

#1 Updated by cdywan over 1 year ago

  • Category set to Feature requests
  • Status changed from New to Workable

#2 Updated by okurz over 1 year ago

  • Target version set to future

This looks great, thx. Let's see when we have capacity to work on this

#3 Updated by ilausuch over 1 year ago

  • Related to action #88187: Set the addresses in the "internal clients" configurable added

#4 Updated by cdywan over 1 year ago

  • Related to deleted (action #88187: Set the addresses in the "internal clients" configurable)

#5 Updated by cdywan over 1 year ago

  • Blocked by action #88187: Set the addresses in the "internal clients" configurable added

#6 Updated by okurz over 1 year ago

  • Target version changed from future to Ready

Zoltan has mentioned this specific ticket to me. I think we can bring it back on our backlog again as a next task to followup with.

#7 Updated by okurz over 1 year ago

#88187 merged, unblocked

#8 Updated by ilausuch over 1 year ago

  • Status changed from Workable to In Progress
  • Assignee set to ilausuch

#9 Updated by openqa_review over 1 year ago

  • Due date set to 2021-03-09

Setting due date based on mean cycle time of SUSE QE Tools

#10 Updated by ilausuch over 1 year ago

  • Status changed from In Progress to Blocked

Bloqued until the problems with #76978 is solved

#11 Updated by ilausuch over 1 year ago

For validation the helm chart we could use

helm lint ./chart

But also there is an other interesting tool kubeval

helm template ./chart | kubeval --strict

This allows testing with the default helm chart values, but also set different values and test the helm chart with these. This is important in case we have different branches of execution based on conditions

helm template --set area.key="val" | kubeval --strict

Or more complex, creating a VALUES.yaml file with the new values

area:
  key: "val"

And use to check it

echo "$VALUES" | helm template -f - | kubeval --strict

#12 Updated by okurz over 1 year ago

  • Due date deleted (2021-03-09)

removing due date as the ticket is blocked. No need for a reminder.

#13 Updated by cdywan over 1 year ago

  • Blocks action #90344: kubevirt backend for openQA and/or os-autoinst added

#14 Updated by ilausuch about 1 year ago

Take in consideration the detected problem and the solutions in https://github.com/os-autoinst/openQA/pull/3821

In a helm chart should be an initial stage (a web UI pod) to create the initial DB (if is not created). This pod can be destroyed after done its job

#15 Updated by okurz about 1 year ago

  • Related to action #76978: How to run an openQA test in 5 minutes added

#16 Updated by cdywan about 1 year ago

  • Blocks deleted (action #90344: kubevirt backend for openQA and/or os-autoinst)

#17 Updated by cdywan about 1 year ago

  • Blocked by action #90344: kubevirt backend for openQA and/or os-autoinst added

#18 Updated by okurz about 1 year ago

  • Blocked by deleted (action #90344: kubevirt backend for openQA and/or os-autoinst)

#19 Updated by ilausuch 10 months ago

  • Assignee deleted (ilausuch)

#20 Updated by okurz 10 months ago

  • Assignee set to okurz

#21 Updated by cdywan about 2 months ago

  • Status changed from Blocked to Workable
  • Assignee deleted (okurz)

Considering #88187 was resolved I assume this is no longer blocked.

#22 Updated by cdywan about 2 months ago

  • Blocked by deleted (action #88187: Set the addresses in the "internal clients" configurable)

#23 Updated by okurz about 2 months ago

  • Status changed from Workable to New

#24 Updated by okurz about 2 months ago

  • Tracker changed from action to coordination
  • Subject changed from Create a helm chart to deploy web UI in kubernetes to [epic] openQA web UI in kubernetes
  • Description updated (diff)

#25 Updated by okurz about 2 months ago

  • Status changed from New to Blocked
  • Assignee set to okurz

#26 Updated by jbaier_cz about 1 month ago

  • Description updated (diff)

I added some more suggestions (as a result of working on #110524). Also, I think we do not need to limit ourselves to just the web UI, workers (at least qemu_x86_64) can run in the kubernetes as well.

Also available in: Atom PDF