yabeda

Yabeda is a tool that gets information about pipelines from GitLab CI and sends it to Slack as pretty messages to. You can call it from your deployment pipelines to get detailed deployment notifications.

screenshot

How to install yabeda service

Getting access to GitLab

To allow yabeda get pipeline info from GitLab you need to provide access token with "api" scope for any GitLab user. Because "api" scope provides too much access, it's better to create a separate user with limited permissions.

Assuming you have self-hosted GitLab instance and access to admin panel:

Open /admin/users/new page in you Gitlab
Create user:
- Name - "Yabeda"
- Username - "yabeda"
- Email - provide any email address you have
- Access level - "Regular"
- External - check. This will allow yabeda to see only project where access was explicitly granted.
- Upload yabeda logo as avatar.
- Push "Create user" button
Open "Impersonation Tokens" page. Url would look like /admin/users/yabeda/impersonation_tokens.
Create impersonation token with "api" scope.

Save token. You'll need to provide it in yabeda configuration.

Getting access to Slack

You have to create your own slack app so only your instances of yabeda can post notifications to your slack workspace.

Open "Your Apps" page in slack: https://api.slack.com/apps
Click "Create New App" button
Fill "Create a Slack App" form:
- App Name - "Yabeda"
- Development Slack Workspace - your workspace name
- Push "Create App" button
Now you're on "Basic Information" page where you need to upload app icon. We've got an icon for you, here it is: Yabeda logo.
It's time to create a bot user:
- Open page "Features > Bot Users"
- Click on "Add a Bot User" button
- Set bot name as "yabeda"
- Click on "Add a Bot User" button again to save a bot user
One more thing - we need permission to read workspace's custom emojis:
- Open page "Features > OAuth & Permissions"
- In "Scopes -> Select Permission Scopes" input add "emoji:read" scope.
- Click "Save Changes"
We are ready to install our app to workspace:
- Open page "Settings > Install App"
- Depending on your permissions you can either install app or request approval. Do it.

After installing app to your workspace you'll see two tokens: "OAuth Access Token" and "Bot User OAuth Access Token". Save them both. You'll need to provide them in yabeda configuration.

Installing yabeda app

Install docker image following instructions on Docker Hub or in docker directory README.
Add these emojis to your Slack workspace:
- - :yabeda-pending-stage:
- - :gitlab-status-canceled:
- - :gitlab-status-created:
- - :gitlab-status-failed:
- - :gitlab-status-manual:
- - :gitlab-status-pending:
- - :gitlab-status-running:
- - :gitlab-status-skipped:
- - :gitlab-status-success:
- - :gitlab-status-warning:

Hot to enable yabeda reporting for your gitlab project

Add yabeda user as "Reporter" member to your gitlab project.
If you want to send notifications to private channel - invite yabeda bot to this channel.
Get yabeda token - same as token you used when installing yabeda app.
Add this query to your gitlab CI pipeline:

yabeda:
  stage: build
  image: alpine
  before_script:
    - apk --no-cache add ca-certificates httpie
  script:
    - http --check-status --ignore-stdin -f POST "https://my-yabeda-host.test/report/$CI_PROJECT_PATH" pipeline_id=${CI_PIPELINE_ID} token=${YABEDA_TOKEN} channel=random
  allow_failure: true
  only:
    - master
    - tags
  except:
    - schedules

Replace random with your slack channel name, https://my-yabeda-host.test with your yabeda host and add YABEDA_TOKEN to your CI secrets.

You can also call yabeda with any http client like curl:

curl -X POST -d "channel=random&pipeline_id=${CI_PIPELINE_ID}&token=${YABEDA_TOKEN}" "https://my-yabeda-host.test/report/$CI_PROJECT_PATH"

To run locally

You can create a virtualenv with python3 -m venv .venv and source .venv/bin/activate to ensure everytihing is local

make install
make run-locally

flix-tech / yabeda

readme