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 full support for labels and annotations in helm chart #9490

Conversation

tuunit
Copy link
Contributor

@tuunit tuunit commented Sep 27, 2024

Motivation

For Operators like ArgoCD or Teleport it is quite useful and sometimes necessary to be able to control and insert annotations and labels into all kinds of resources and especially services.

Furthermore the documentation in the values.yaml was wrong in some places.

  • The common labels and annotations aren't applied to all resources.
  • Some comments mentioned the wrong resources like "Labels & Annotations for API" despite living in the "Auth" block

Description

  • Remove unnecessary templating function common.tpl.renders
  • Add new helper function kubernetes-dashboard.annotations to apply common annotations to all resources
  • Add common app.labels to helper function kubernetes-dashboard.labels
  • Add auth, api, web, and metricsScraper labels and annotation options to all their respective resources
  • Add a two new options serviceLabels and serviceAnnotations to auth, api, web, and metricsScraper services

What type of PR is this?

/kind cleanup
/kind feature

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Sep 27, 2024
@k8s-ci-robot
Copy link
Contributor

Welcome @tuunit!

It looks like this is your first PR to kubernetes/dashboard 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes/dashboard has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot k8s-ci-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Sep 27, 2024
@tuunit tuunit changed the title feat: add full support for label and annotation in helm chart feat: add full support for labels and annotations in helm chart Sep 27, 2024
@tuunit
Copy link
Contributor Author

tuunit commented Sep 27, 2024

@desaintmartin @floreks let me know what you think of this change and if I should increase the Chart version as part of this PR

Copy link

codecov bot commented Oct 4, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 37.08%. Comparing base (2ac2758) to head (55802d2).
Report is 4 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #9490   +/-   ##
=======================================
  Coverage   37.08%   37.08%           
=======================================
  Files         283      283           
  Lines       11830    11830           
  Branches      183      202   +19     
=======================================
  Hits         4387     4387           
  Misses       7221     7221           
  Partials      222      222           

@tuunit tuunit force-pushed the feat/full-support-for-labels-and-annotation-in-all-resources branch from 9bc23bc to c609881 Compare October 4, 2024 13:12
@k8s-ci-robot k8s-ci-robot added the kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. label Oct 4, 2024
@tuunit
Copy link
Contributor Author

tuunit commented Oct 4, 2024

/kind cleanup
/kind feature

@k8s-ci-robot k8s-ci-robot added the kind/feature Categorizes issue or PR as related to a new feature. label Oct 4, 2024
@tuunit tuunit force-pushed the feat/full-support-for-labels-and-annotation-in-all-resources branch from c609881 to 55802d2 Compare October 4, 2024 13:20
@maciaszczykm
Copy link
Member

@tuunit I can see you are still force pushing this branch. I started reviewing but it is hard to track changes. It would be better if you could push new commits. We do squash anyways. Let us know when it will be ready for reviews.

@tuunit
Copy link
Contributor Author

tuunit commented Oct 4, 2024

@maciaszczykm You can review it now :) I only rebased from the main and bumped the chart version.

Copy link
Member

@maciaszczykm maciaszczykm left a comment

Choose a reason for hiding this comment

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

LGTM, leaving to @floreks for final approval.

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Oct 4, 2024
@maciaszczykm maciaszczykm removed the kind/feature Categorizes issue or PR as related to a new feature. label Oct 4, 2024
@maciaszczykm
Copy link
Member

Tested deployment locally on kind cluster, everything seems to work. Added some labels as well.

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Oct 4, 2024
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: maciaszczykm, tuunit

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@floreks
Copy link
Member

floreks commented Oct 4, 2024

Great, codewise lgtm

@maciaszczykm maciaszczykm merged commit 6c9cfce into kubernetes:master Oct 4, 2024
18 of 20 checks passed
@tuunit tuunit deleted the feat/full-support-for-labels-and-annotation-in-all-resources branch October 4, 2024 15:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants