Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Add labels on Application's k8s events (#11381) #18160

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

svghadi
Copy link
Contributor

@svghadi svghadi commented May 10, 2024

Closes #11381

This PR implements #11381 enhancement to expose application labels on k8s events generated by Argo CD.

Change:
This PR introduces a new key resource.eventLabelKeys in argocd-cm configmap which takes in a comma separated string of label keys. For any events generated for Applications containing the specified label keys from argocd-cm, the controller adds the matched label onto the event thus establishing an easy link between the event and the application to filter-out/process later using labels.

The specified label keys are matched against the Application and it's AppProject labels. In case of conflict between labels on Application and it's AppProject, the Application label values are prioritised and added to the event.

Sample output:

$ kubectl get events -l env=dev --show-labels
LAST SEEN   TYPE     REASON               OBJECT                                      MESSAGE                                                                LABELS
25s         Normal   ResourceCreated      application/test-labels-on-app-k8s-events   admin created application                                              app=test,env=dev
25s         Normal   OperationStarted     application/test-labels-on-app-k8s-events   admin initiated sync to  (7e2013dcfdd0c801eececd38aa5f3db898e29f4b)    app=test,env=dev
24s         Normal   OperationCompleted   application/test-labels-on-app-k8s-events   Sync operation to 7e2013dcfdd0c801eececd38aa5f3db898e29f4b succeeded   app=test,env=dev
24s         Normal   ResourceUpdated      application/test-labels-on-app-k8s-events   Updated sync status:  -> Synced                                        app=test,env=dev
24s         Normal   ResourceUpdated      application/test-labels-on-app-k8s-events   Updated health status:  -> Progressing                                 app=test,env=dev
17s         Normal   ResourceUpdated      application/test-labels-on-app-k8s-events   Updated health status: Progressing -> Healthy                          app=test,env=dev

Checklist:

  • Either (a) I've created an enhancement proposal and discussed it with the community, (b) this is a bug fix, or (c) this does not need to be in the release notes.
  • The title of the PR states what changed and the related issues number (used for the release note).
  • The title of the PR conforms to the Toolchain Guide
  • I've included "Closes [ISSUE #]" or "Fixes [ISSUE #]" in the description to automatically close the associated issue.
  • I've updated both the CLI and UI to expose my feature, or I plan to submit a second PR with them.
  • Does this PR require documentation updates?
  • I've updated documentation as required by this PR.
  • I have signed off all my commits as required by DCO
  • I have written unit and/or e2e tests for my change. PRs without these are unlikely to be merged.
  • My build is green (troubleshooting builds).
  • My new feature complies with the feature status guidelines.
  • I have added a brief description of why this PR is necessary and/or what this PR solves.
  • Optional. My organization is added to USERS.md.
  • Optional. For bug fixes, I've indicated what older releases this fix should be cherry-picked into (this may or may not happen depending on risk/complexity).

Signed-off-by: Siddhesh Ghadi <sghadi1203@gmail.com>
Signed-off-by: Siddhesh Ghadi <sghadi1203@gmail.com>
# the corresponding labels are added on the generated event.
# In case of conflict between labels on Application and AppProject,
# the Application label values are prioritized and added to the event.
resource.eventLabelKeys: team,env
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wdyt about resource.includeLabelKeys and resource.excludeLabelKeys could have wildcards as an improvement - @leoluz

Copy link
Contributor

@todaywasawesome todaywasawesome left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is a great start, to make it feature complete can we handle the include/exclude use cases?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Exposing Application labels in events
2 participants