Set context for gitlab commit status

[havard024]

We have a multi env setup using single branch model on gitlab.

We have configured git commit status ref https://fluxcd.io/flux/components/notification/provider/#git-commit-status
The problem we are facing is that each env will override each others commit status.

If we could set the context on the gitlab commit status API ref https://docs.github.com/en/rest/commits/statuses#create-a-commit-status
We could differentiate the status of each env on the same commit

[kingdonb]

You should get multiple different checks, one for each Kustomization. If you have multiple different clusters that all have Kustomizations by the same name, you might see this issue. Is that the case for your configuration?

For alerts that surface through a notification provider like Slack, you get a "summary" field which is meant to let you specify which cluster is impacted by the change.

For commit status notifications, I don't think this field has any effect (but you can try it also!)

[kingdonb]

This may be a bug or missing feature, if I've understood the situation, please let me know and I'll give it a try to reproduce the issue. Could you put some more detail (screenshot of the message that gets overwritten for example)

[havard024]

Sorry for the late reply.

Yes, that's exactly the case, multiple different clusters that all have kustomizations by the same name and same branch (running single branch instead of multi branch)

We are unable to differentiate the commit status from our test cluster vs prod cluster since there is no difference in the names

screenshot of the commit history where the commit status passed

screenshot after clicking on the commit status from the picture above

screenshot after clicking on the checkmark, shows the pipelines that run and the stage "external"

screenshot where I triggered a reconciliation error in our test cluster, both pipelines run, nothing is overwritten, but its not possible to differentiate which cluster failed in gitlab itself. It would be nice if we can get two different commit statuses or be able to name the pipeline / stage somehow

[havard024]

Not sure when it happened, but noticed that we are now getting a different id per commit status

Is it possible to configure the id to make it more human readable?

[marhbere-glb]

We are interested in this relations too

[Cenness]

Starting from notification v1.6.0 you can use cel expressions for that:

apiVersion: notification.toolkit.fluxcd.io/v1beta3
kind: Provider
metadata:
  name: gitlab
  namespace: flux-system
spec:
  type: gitlab
  address: https://gitlab/group/repo
  commitStatusExpr: |
    '${CLUSTER_SLUG}'
    + '/' + event.involvedObject.namespace
    + '/' + event.involvedObject.kind.substring(0, 8)
    + '/' + event.involvedObject.name
  secretRef:
    name: gitlab-token

[libredeb]

Starting from notification v1.6.0 you can use cel expressions for that:

apiVersion: notification.toolkit.fluxcd.io/v1beta3
kind: Provider
metadata:
  name: gitlab
  namespace: flux-system
spec:
  type: gitlab
  address: https://gitlab/group/repo
  commitStatusExpr: |
    '${CLUSTER_SLUG}'
    + '/' + event.involvedObject.namespace
    + '/' + event.involvedObject.kind.substring(0, 8)
    + '/' + event.involvedObject.name
  secretRef:
    name: gitlab-token

How you are used or builded that CLUSTER_SLUG environment variable? the custom-commit-status-messages documentation says we only have access to flux event object, provider object and alert object but none of them has the cluster information. Is there any way to get that information?

[Cenness]

How you are used or builded that CLUSTER_SLUG environment variable?

It's sent via kustomize postBuild.substitute

Imagine that provider object in /app/flux-alerts/provider.yaml
And then you apply something like

apiVersion: kustomize.toolkit.fluxcd.io/v1
kind: Kustomization
metadata:
  name: flux-alerts
  namespace: flux-system
spec:
  interval: 10m0s
  path: ./app/flux-alerts
  targetNamespace: flux-system
  prune: true
  sourceRef:
    kind: GitRepository
    name: gitops-repo
    namespace: flux-system
  postBuild:
    substitute:
      CLUSTER_SLUG: "prod"

[matheuscscp]

Like @Cenness mentioned, .spec.commitStatusExpr, introduced in Flux 2.6, allows for customizing commit statuses.

Docs here: https://fluxcd.io/flux/components/notification/providers/#custom-commit-status-messages