Project

General

Profile

action #76990

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

Improve documentation for redundant/load-balancing webui deployments of openQA

Added by okurz 12 months ago. Updated 7 months ago.

Status:
Resolved
Priority:
Low
Assignee:
Category:
Feature requests
Target version:
Start date:
Due date:
% Done:

0%

Estimated time:
Difficulty:

Description

Motivation

We have a proof-of-concept of a redundant/load-balancing webui deployment based on docker-compose. To make that more visible we should cover it in documentation so that it shows up in https://open.qa/docs

Acceptance criteria

Suggestions


Related issues

Blocked by openQA Project - action #88187: Set the addresses in the "internal clients" configurableResolved2021-01-25

Copied from openQA Project - action #69355: [spike] redundant/load-balancing webui deployments of openQAResolved2020-07-25

History

#1 Updated by okurz 12 months ago

  • Copied from action #69355: [spike] redundant/load-balancing webui deployments of openQA added

#2 Updated by okurz 11 months ago

  • Target version changed from future to Ready

#3 Updated by okurz 11 months ago

  • Parent task set to #80142

#4 Updated by ilausuch 9 months ago

I think ticket is blocked by https://progress.opensuse.org/issues/88187

#5 Updated by cdywan 9 months ago

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

#6 Updated by okurz 8 months ago

#88187 merged, unblocked

#7 Updated by mkittler 7 months ago

  • Assignee set to mkittler

#8 Updated by mkittler 7 months ago

  • Status changed from Workable to In Progress

PR: https://github.com/os-autoinst/openQA/pull/3819

As a first step I only did the improvements mentioned in the commit message. However, I have to note that the documentation is actually horrible to follow. Two different setups (Fedora and docker-compose) are explained in an interleaved way. It would make much more sense to use distinct sections. The documentation also uses way too many cross-references of the kind "do not follow instructions of that other section" or "follow instructions of that other section except for".

#9 Updated by okurz 7 months ago

PR merged. Additional to the AC I suggest to crosscheck with "example users" if the new documentation structure is sufficient.

#10 Updated by mkittler 7 months ago

  • Status changed from In Progress to Feedback

The documentation is now available under http://open.qa/docs/#containerizedsetup.

Additional to the AC I suggest to crosscheck with "example users" if the new documentation structure is sufficient.

I have already mentioned that I don't like the way the documentation is structured. At least the Fedora container and the docker-compose setup should be separated from each other. However, I'm not sure whether it makes much sense to improve it at this point.

#12 Updated by mkittler 7 months ago

  • Status changed from Feedback to Resolved

It should be good enough for now. I've been following the instructions myself and was able to create a basic docker-compose setup. The documentation should of course be further extended as we improve the docker-compose setup itself.

Also available in: Atom PDF