Skip to content

Fire webhooks on deployment events

Everyone can contribute. Help move this issue forward while earning points, leveling up and collecting rewards.

Release notes

Problem to solve

As an Application Operator, I'd like to integrate with webhooks in order to send slack messages or other notifications when deployments succeed or fail.

As an Application Operator, I'd like to integrate with webhooks in order to run BDD tests or various scripts related to a deployment.

gitops-engine currently supports either Argo or Helm style annotation hooks. These are great to run in-cluster Jobs or pods. At the same time, we might be able to provide a more integrated solution by firing GitLab webhooks that could trigger pipeline jobs for example.

Intended users

User experience goal

Proposal

kas should notify GitLab about some cluster-side GitOps sync events.

When a sync finishes, notify GitLab with information such as

  • the synced commit ref
  • time started
  • time finished
  • sync result (success, error)
  • message (e.g. error message if failed)
  • agent sending the notification

Fire this webhook on the manifest project being deployed.

Further details

One of the motivations behind this issue is to allow debugging:

How does all this handle when something goes wrong? How is this expressed back to the user, if at all? Currently using plain old CI jobs, we can see the pipeline fail, and get normal email notifications if something does go wrong. If agentk is just applying manifests in the background, how do we know everything worked ok?

Permissions and Security

Documentation

Availability & Testing

What does success look like, and how can we measure that?

What is the type of buyer?

Is this a cross-stage feature?

Links / references

Edited by 🤖 GitLab Bot 🤖