Configure the GitLab Events Module plugin
Configure GitLab webhooks and system hooks to trigger real-time updates for GitLab Discovery and organizational data.
Before you begin
- You have added your GitLab integration credentials in the
app-config.yamlfile.For self-hosted GitLab instances:
integrations: gitlab: - host: ${GITLAB_HOST} token: ${GITLAB_TOKEN} apiBaseUrl: https://${GITLAB_HOST}/api/v4For GitLab.com:
integrations: gitlab: - host: gitlab.com token: ${GITLAB_TOKEN} - You have defined the
schedule.frequencyin theapp-config.yamlfile as a longer time period, such as 24 hours. - For GitLab Discovery only: You have enabled GitLab Discovery by adding the
catalog-backend-module-gitlabplugin with the following configuration in theapp-config.yamlfile:catalog: providers: gitlab: default: host: ${GITLAB_HOST} group: ${GITLAB_ORG} schedule: initialDelay: seconds: 15 frequency: hours: 24 timeout: minutes: 3 - For GitLab Organizational Data only: You have enabled GitLab Authentication with user ingestion.
About this task
Learn how to configure Events Module for use with the RHDH GitLab Discovery feature and GitLab organization data.
These features are for Technology Preview only. Technology Preview features are not supported with Red Hat production service level agreements (SLAs), might not be functionally complete, and Red Hat does not recommend using them for production. These features provide early access to upcoming product features, enabling customers to test functionality and provide feedback during the development process.
For more information on Red Hat Technology Preview features, see Technology Preview Features Scope.
Procedure
Results
- Check the log for an entry that confirms that the http endpoint was set up successfully to receive events from the GitLab webhook.
- Example of a log of successfully set up http endpoint
-
{"level":"\u001b[32minfo\u001b[39m","message":"Registered /api/events/http/gitlab to receive events","plugin":"events","service":"backstage","timestamp":"2025-11-03 02:19:12"}
- For GitLab Discovery only:
- Trigger a GitLab push event by adding, modifying, or deleting the
catalog-info.yamlfile in the repository where you set up your webhook. A record of this event should appear in the pod logs of your RHDH instance.- Example of a log with changes to
catalog-info.yamlfile -
{"level":"\u001b[32minfo\u001b[39m","message":"Processed GitLab push event from https://gitlab.com/backstage-test-catalog/test-repo-1: added 1 - removed 0 - modified 0","plugin":"catalog","service":"backstage","span_id":"abfe425c441ee3e8","target":"GitlabDiscoveryEntityProvider:providerId","timestamp":"2025-09-07 23:03:12","trace_flags":"01","trace_id":"0c21b7c71d7ce8aa626d42e6f4060716"}
- Example of a log with changes to
- Trigger a GitLab push event by adding, modifying, or deleting the
- For GitLab Organizational Data only:
- Newly added users and groups appear in the RHDH catalog.