Patchdemo shows streaming install logs while waiting for a vhost-environment to become ready. We want a similar behaviour for a k8s-environment.
AS a patchdemo user
GIVEN I have enabled the header to see Catalyst features
WHEN I launch a new environment with Catalyst backend
THEN I am directed to a page that streams logs of the installation progress
The container that needs to be streamed from is the init container "install-mediawiki"
jhuneidi opened https://gitlab.wikimedia.org/repos/qte/catalyst/patchdemo/-/merge_requests/46
Draft: Display installation progress for k8s environments
ebomani opened https://gitlab.wikimedia.org/repos/qte/catalyst/catalyst-api/-/merge_requests/61
Draft: Change Stream logs behavior when Pod is initializing
This has vexed us for a bit because there is/was a timing component to when the Catalyst API would allow you to stream logs (i.e. the pod that to be running). This meant that patchdemo had to divine when it would be safe to stream the results. What was worse is that, except when the pod was ready to stream logs, it's response would not be text/event-stream which would cause the PHP http clients to throw and exception. We're still working on smoothing out this integration.
After patchdemo connects to catalyst-api logs endpoint (logs/streaming), under some circumstances the endpoint returns a 200 OK without streaming anything.
So that's what remains on this task.
To reproduce:
Note: this features streams multiple containers; could descope and stream logs from just init.
Jeena's back! Reassigning.
jhuneidi opened https://gitlab.wikimedia.org/repos/qte/catalyst/catalyst-api/-/merge_requests/63
log streaming: Check whether container has started
A new MR for catalyst-api addresses the race condition encountered by reviewers.
An additional thing I noticed is that if logs have begun to stream and then the container is stopped (in my case there was no space on the cluster), the kubernetes log stream will not return any error and the log stream will finish as a 200, so the UI would announce the wiki is ready when it wasn't. Maybe in another task, after the logs finished, we could do another request to confirm the wiki is running to determine what result to announce.
jhuneidi merged https://gitlab.wikimedia.org/repos/qte/catalyst/catalyst-api/-/merge_requests/63
log streaming: Check whether container has started
jhuneidi merged https://gitlab.wikimedia.org/repos/qte/catalyst/patchdemo/-/merge_requests/46
Display installation progress for k8s environments
ebomani closed https://gitlab.wikimedia.org/repos/qte/catalyst/catalyst-api/-/merge_requests/61
Draft: Change Stream logs behavior when Pod is initializing