From 4282f3cdece1b1dc47da3d01f3f7bc6d3ca666c2 Mon Sep 17 00:00:00 2001
From: Mykola Lysenko <mykolal@fb.com>
Date: Thu, 17 Mar 2022 16:30:58 -0700
Subject: [PATCH] ci: Add troubleshooting steps to s390x setup readme

Related to libbpf CI. Added more information on how
to setup and troubleshoot GitHub action runners for
s390x platform.

Signed-off-by: Mykola Lysenko <mykolal@fb.com>
---
 .../s390x-self-hosted-builder/README.md       | 37 ++++++++++++++++++-
 1 file changed, 35 insertions(+), 2 deletions(-)

diff --git a/travis-ci/rootfs/s390x-self-hosted-builder/README.md b/travis-ci/rootfs/s390x-self-hosted-builder/README.md
index f8a4b86..cfc1466 100644
--- a/travis-ci/rootfs/s390x-self-hosted-builder/README.md
+++ b/travis-ci/rootfs/s390x-self-hosted-builder/README.md
@@ -1,16 +1,25 @@
 # IBM Z self-hosted builder
 
 libbpf CI uses an IBM-provided z15 self-hosted builder. There are no IBM Z
-builds of GitHub Actions runner, and stable qemu-user has problems with .NET
+builds of GitHub (GH) Actions runner, and stable qemu-user has problems with .NET
 apps, so the builder runs the x86_64 runner version with qemu-user built from
 the master branch.
 
+We are currently supporting runners for the following repositories:
+* libbpf/libbpf
+* kernel-patches/bpf
+* kernel-patches/vmtest
+
+Below instructions are directly applicable to libbpf, and require minor
+modifications for kernel-patches repos. Currently, qemu-user-static Docker
+image is shared between all GitHub runners, but separate actions-runner-\*
+service / Docker image is created for each runner type.
+
 ## Configuring the builder.
 
 ### Install prerequisites.
 
 ```
-$ sudo dnf install docker        # RHEL
 $ sudo apt install -y docker.io  # Ubuntu
 ```
 
@@ -35,6 +44,10 @@ for details.
 
 ### Autostart the x86_64 emulation support.
 
+This step is important, you would not be able to build docker container
+without having this service running. If container build fails, make sure
+service is running properly.
+
 ```
 $ sudo systemctl enable --now qemu-user-static
 ```
@@ -72,3 +85,23 @@ $ sudo systemctl stop actions-runner-libbpf
 $ sudo docker rm -f actions-runner-libbpf
 $ sudo docker volume rm actions-runner-libbpf
 ```
+
+## Troubleshooting
+
+In order to check if service is running, use the following command:
+
+```
+$ sudo systemctl status <service name>
+```
+
+In order to get logs for service:
+
+```
+$ journalctl -u <service name>
+```
+
+In order to check which containers are currently active:
+
+```
+$ sudo docker ps
+```