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

Add optional annotations to secrets #1599

Merged
merged 3 commits into from
Jan 30, 2025
Merged

Conversation

brkinney
Copy link
Contributor

@brkinney brkinney commented Jan 9, 2025

Description: Add optional annotations to be passed for secrets.

My team uses a mutating webhook to inject secrets on create. We utilize annotations as part of this webhook which this chart does not currently support.

Testing: This is an optional value, and tested that no examples show any changes when rendering. I also tested rendering with the below test value file to verify my changes show up correctly. I did not think this change warranted a new example to be created.

agent:
  controlPlaneMetrics:
    etcd:
      secret:
        create: true
        annotations:
          testAnnotation: etcdSecret

secret:
  annotations:
    testAnnotation: secret

Documentation: Updated values schema.

Note:
I went with an if conditional in the templates because I saw it was done this way in the serviceAccount.yaml file:
https://github.com/signalfx/splunk-otel-collector-chart/blob/main/helm-charts/splunk-otel-collector/templates/serviceAccount.yaml#L20-L23

Afterwards I noticed that the service.yaml uses with instead:
https://github.com/signalfx/splunk-otel-collector-chart/blob/main/helm-charts/splunk-otel-collector/templates/service.yaml#L17-L20

I don't know if there is a preference but I can change if requested.

@brkinney brkinney requested review from a team as code owners January 9, 2025 21:07
Copy link
Contributor

github-actions bot commented Jan 9, 2025

All contributors have signed the CLA ✍️ ✅
Posted by the CLA Assistant Lite bot.

@brkinney
Copy link
Contributor Author

brkinney commented Jan 9, 2025

I have read the CLA Document and I hereby sign the CLA

srv-gh-o11y-gdi-cla added a commit to splunk/cla-agreement that referenced this pull request Jan 9, 2025
@atoulme
Copy link
Contributor

atoulme commented Jan 28, 2025

Please see the failing build:

FAIL: A new changelog file in .chloggen/ or entry in CHANGELOG.md is required for this commit due to:

  • Updates to files under 'helm-charts//templates'
  • Updates to Chart.yaml files
    Please run "make chlog-new" for normal PRs or "make chlog-update" for PRs creating releases.
    make: *** [Makefile:115: chlog-validate] Error 1
    Options:
  • Add a Changelog Entry: Please add a '.yaml' file to the './.chloggen/' directory detailing the changes in your commit. See 'CONTRIBUTING.md' for guidance on creating this entry.
  • Skip the Changelog Check: If your changes don't necessitate a changelog entry or it's a minor chore, you can skip this check by:
    1. Adding '[chore]' to the title of the pull request
    2. Applying the 'Skip Changelog' label to the pull request.

@brkinney
Copy link
Contributor Author

@atoulme I have added a changelog file to the PR, but I'm unsure of what to put in the issue field. I have a support case number, but I'm unsure if I should be referencing that in the changelog, or if there is supposed to be a github issue linked to this.

@atoulme
Copy link
Contributor

atoulme commented Jan 29, 2025

@atoulme I have added a changelog file to the PR, but I'm unsure of what to put in the issue field. I have a support case number, but I'm unsure if I should be referencing that in the changelog, or if there is supposed to be a github issue linked to this.

you can use this PR number. I have gone ahead and added it.

Copy link
Contributor

@atoulme atoulme left a comment

Choose a reason for hiding this comment

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

LGTM. I have asked for a second review from the team.

@atoulme atoulme merged commit 8789029 into signalfx:main Jan 30, 2025
65 checks passed
@github-actions github-actions bot locked and limited conversation to collaborators Jan 30, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants