action #76990
closedcoordination #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
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¶
- AC1: the proof-of-concept instructions can be reached from http://open.qa/docs/
Suggestions¶
- Take a look into the existing documentation in https://github.com/os-autoinst/openQA/blob/master/docker/README.md
- Either include the README file in the documentation generation chain or move the content into one of the existing doc files in docs/ that are already included
Updated by okurz about 4 years ago
- Copied from action #69355: [spike] redundant/load-balancing webui deployments of openQA added
Updated by ilausuch almost 4 years ago
I think ticket is blocked by https://progress.opensuse.org/issues/88187
Updated by livdywan almost 4 years ago
- Blocked by action #88187: Set the addresses in the "internal clients" configurable added
Updated by mkittler almost 4 years 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".
Updated by okurz over 3 years ago
PR merged. Additional to the AC I suggest to crosscheck with "example users" if the new documentation structure is sufficient.
Updated by mkittler over 3 years 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.
Updated by mkittler over 3 years ago
Updated by mkittler over 3 years 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.