public inbox for
 help / color / mirror / Atom feed
* [COMMITTED] Add README_containers - Debugging issues with CI container files
@ 2022-06-13  9:51 Mark Wielaard
  0 siblings, 0 replies; only message in thread
From: Mark Wielaard @ 2022-06-13  9:51 UTC (permalink / raw)
  To: buildbot; +Cc: Mark Wielaard

A quick reference on how to debug issues inside the container files.

 README_containers | 112 ++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 112 insertions(+)
 create mode 100644 README_containers

diff --git a/README_containers b/README_containers
new file mode 100644
index 0000000..66ac558
--- /dev/null
+++ b/README_containers
@@ -0,0 +1,112 @@
+Debugging issues with CI container files
+- Setup podman (or docker)
+- git clone
+- cd builder
+- podman build -t builder-debian-stable \
+               -f builder/containers/Containerfile-debian-stable \
+               builder/containers
+- podman run --name debian-stable -ti --entrypoint /bin/bash \
+         builder-debian-stable
+Full intructions below.
+Some CI builders on will use container
+files to run builds and tests. When the logs don't make clear how/why
+a test fails and local debugging doesn't help it is useful to be able
+to recreate the container environment locally.
+We will assume an x86_64 GNU/Linux install with docker or podman and
+user namespaces support. The none-x86_64 hosts on
+ don't use container files and you can
+contact to get access if debugging locally
+isn't possible.
+The container files
+The container files can be found in builder.git together with the
+buildbot configuration:
+git clone
+cd builder
+ls builder/containers
+Containerfile-debian-stable  Containerfile-opensuse-leap
+Containerfile-fedora-latest  Containerfile-opensuse-tumbleweed
+Setting up docker or podman
+- Make sure that you have docker installed and that the user is in the
+  docker group
+sudo apt install or sudo dnf install moby-engine
+sudo systemctl enable docker.service
+sudo systemctl start docker.service
+sudo usermod -a -G docker $(whoami)
+- Or make sure to have podman and user namespaces setup
+sudo apt install podman slirp4netns fuse-overlayfs
+sudo dnf install podman slirp4netns fuse-overlayfs
+Make sure cat /proc/sys/user/max_user_namespaces is >= 15000:
+if not, sudo sysctl user.max_user_namespaces=15000
+or set it in /etc/sysctl.conf
+Make sure that /etc/subuid and /etc/subgid are setup for your user,
+both should contain something like: youruser:100000:65536
+if not,
+sudo usermod --add-subuids 100000-165535 \
+             --add-subgids 100000-165535 $(whoami)
+Building the image
+Note that the container files are rebuild once a week for the workers. So although unlikely it might be that
+a freshly build container contains slightly newer versions of the
+packages than the one that ran on the worker.
+The containers contain all build dependencies for all projects
+including for generating the documentation. So they are similar in
+size to a full distribution. Make sure you have several GB available
+in /var/lib/docker for docker or in $HOME/.local/share/containers and
+/var/tmp for podman
+git clone
+cd builder
+podman build -t builder-debian-stable \
+             -f builder/containers/Containerfile-debian-stable \
+             builder/containers
+Or use docker instead of podman, they take the same arguments
+(although the last PATH is optional in some versions).
+Running the image
+The image is setup for running the buildbot-worker as user builder. To
+use it interactively we'll have to override the entrypoint with
+podman run --name debian-stable -ti --entrypoint /bin/bash \
+       builder-debian-stable
+To reuse the same container run (with interactive attach):
+podman start -ai debian-stable
+The container has all the packages needed for building the projects,
+including git. But if you find some package is missing start the
+container and enter it as root:
+podman start debian-stable
+podman exec -it --user root debian-stable apt install emacs
+The same works with the docker command.

^ permalink raw reply	[flat|nested] only message in thread

only message in thread, other threads:[~2022-06-13  9:51 UTC | newest]

Thread overview: (only message) (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2022-06-13  9:51 [COMMITTED] Add README_containers - Debugging issues with CI container files Mark Wielaard

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).