Skip to content

feat: support explicit HyperDX Deployment and pod annotations - #255

Open
mfroembgen wants to merge 4 commits into
ClickHouse:mainfrom
mfroembgen:warren/hyperdx-deployment-annotations
Open

feat: support explicit HyperDX Deployment and pod annotations#255
mfroembgen wants to merge 4 commits into
ClickHouse:mainfrom
mfroembgen:warren/hyperdx-deployment-annotations

Conversation

@mfroembgen

@mfroembgen mfroembgen commented Jul 28, 2026

Copy link
Copy Markdown
Contributor

Summary

  • add hyperdx.deployment.deploymentAnnotations for HyperDX Deployment metadata
  • add hyperdx.deployment.podAnnotations for HyperDX pod-template metadata
  • retain hyperdx.deployment.annotations as a deprecated compatibility alias
  • document and test that podAnnotations wins on duplicate legacy keys

Motivation

The existing hyperdx.deployment.annotations value configures spec.template.metadata.annotations, but its scope is ambiguous and there is no value for the Deployment object's metadata.annotations. Explicit names make both Kubernetes metadata surfaces clear without breaking existing installations.

Backward compatibility

The new values default to empty maps. Existing hyperdx.deployment.annotations values continue to render on the pod template. When both annotations and podAnnotations contain the same key, the explicit podAnnotations value takes precedence; non-conflicting legacy annotations are preserved.

Test plan

  • helm unittest charts/clickstack — 28 suites, 190 tests pass
  • focused HyperDX suite — 33 tests pass
  • helm lint charts/clickstack
  • default values and all three example values files render with Helm 3.12.0
  • focused render confirms distinct Deployment and pod annotations plus compatibility merge precedence
  • git diff --check

Fixes #254.

@mfroembgen
mfroembgen requested a review from a team as a code owner July 28, 2026 06:34
@changeset-bot

changeset-bot Bot commented Jul 28, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: cac526f

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
helm-charts Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@github-actions github-actions Bot added the external Opened by an external contributor label Jul 28, 2026
@mfroembgen mfroembgen changed the title feat: support HyperDX Deployment annotations feat: support explicit HyperDX Deployment and pod annotations Jul 28, 2026
@mfroembgen
mfroembgen force-pushed the warren/hyperdx-deployment-annotations branch from 6e59624 to dd4a55b Compare July 29, 2026 06:07
teeohhem
teeohhem previously approved these changes Jul 30, 2026

@teeohhem teeohhem left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thank you for the PR!

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

This PR updates the ClickStack Helm chart’s HyperDX Deployment templating to support explicit annotation maps for the Deployment object (metadata.annotations) vs the pod template (spec.template.metadata.annotations), while preserving the existing legacy value as a deprecated alias for backward compatibility.

Changes:

  • Add hyperdx.deployment.deploymentAnnotations (Deployment metadata) and hyperdx.deployment.podAnnotations (pod template metadata) to values.yaml.
  • Update the HyperDX Deployment template to render Deployment annotations separately and to merge legacy pod annotations with podAnnotations taking precedence on key conflicts.
  • Expand helm-unittest coverage to validate separation and precedence behavior, and add a Changeset entry.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.

File Description
charts/clickstack/values.yaml Documents and introduces explicit deploymentAnnotations and podAnnotations values plus a deprecated legacy alias.
charts/clickstack/tests/hyperdx-deployment_test.yaml Adds/updates unit tests validating default behavior, separation of annotation surfaces, and precedence of podAnnotations.
charts/clickstack/templates/hyperdx/deployment.yaml Implements Deployment-level annotations and merged pod-template annotations with explicit precedence.
.changeset/expose-hyperdx-deployment-annotations.md Records the user-facing chart change as a minor release via Changesets.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread charts/clickstack/templates/hyperdx/deployment.yaml Outdated
Comment on lines +104 to 106
example.com/configuration: explicit
example.com/legacy: preserved

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

external Opened by an external contributor

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Support explicit Deployment and pod annotations for HyperDX

3 participants