Add devfile for CI runner and registry

Peter Leitzenrequested to merge
pl-devfile-env into main

What does this merge request do and why?

This MR adds a new devfile, enabling the CI runner and the registry.

This corresponds to one of the use-case profiles that were devised earlier on in the process.

The goal of this is enabling the services and making sure bootstrapping works and the services are enabled thereafter.

How to set up and validate locally

You can try out the change by following these steps:

  1. Setup

    1. Create a workspace from this branch, choosing the new devfile.
    2. Open the workspace and letting the bootstrap finish.
    3. Run sed -i 's/"skipProxy": true,/"skipProxy": false,/g' gitlab/config/vite.json to fix the vite issue
    4. Run gdk reconfigure && gdk restart to apply the change.
    5. Log into the GDK as root
    6. export GITLAB_TOKEN=$(grep "token = " gitlab/db/fixtures/development/25_api_personal_access_token.rb | sed "s/.*'\([^']*\)'.*/\1/")

  2. Verify Registry

    1. Log in to GDK as root
    2. Log into the registry by doing docker login $(hostname):5100 -u gitlab-token -p "$GITLAB_TOKEN"
    3. docker pull hello-world && docker tag hello-world $(hostname):5100/gitlab-org/gitlab-test/image && docker push $(hostname):5100/gitlab-org/gitlab-test/image
    4. Verify the image is visible in the UI via navigating to /gitlab-org/gitlab-test/container_registry in your GDK.

    Screenshot 2025-06-13 at 10.59.41.png

  3. Verify Runner

    1. Log in to GDK and create an instance runner and take note of the token.
    2. Make sure the token is configured in ./gitlab-runner-config.toml
    3. sed -i "/token = /a\ clone_url = \"http://$(hostname -i):3000\"" gitlab-runner-config.toml
    4. From this point onwards do not execute gdk reconfigure anymore and pay attention that no other action you take removes the clone_url from said file.
    5. Run gdk restart runner
    6. Verify that the runner exists in GDK via the Admin panel.
    7. Create a new project in the namespace of the user witith a CI pipeline. I chose the Hugo Template.
    8. Run a pipeline

Screen Recording 2025-06-13 at 12.13.11.mov

This fixes #2637 (closed), as well as #2638 (closed) giving us one GDK Workspace profile successfully setting up a runner and a registry.

Future iterations to make the runner registration simpler and less error-prone via better integration in GDK should be considered.

Impacted categories

The following categories relate to this merge request:

Merge request checklist

  • This MR references an issue describing the change.
  • This change is backward compatible. If not, please include steps to communicate to our users.
  • Tests added for new functionality. If not, please raise an issue to follow-up.
  • Documentation added/updated, if needed.
  • Announcement added, if change is notable.
  • gdk doctor test added, if needed.
Edited by Peter Leitzen

Merge request reports