feat: handle pod annotations #138
Conversation
WalkthroughThis change updates the version numbers for multiple Helm charts across their respective README files and introduces or documents a new Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Helm Chart
participant Kubernetes
User->>Helm Chart: Set podAnnotations in values.yaml
Helm Chart->>Kubernetes: Render manifests with podAnnotations
Kubernetes-->>User: Deploy pods with specified annotations
Possibly related PRs
Suggested reviewers
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
⏰ Context from checks skipped due to timeout of 90000ms (1)
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (5)
charts/core/templates/_annotations.tpl (1)
1-8: Consider indentingtoYamloutputThe new
core.podAnnotationstemplate correctly renders annotations when.Values.podAnnotationsis set. To ensure the YAML lines are properly indented in consuming templates, pipe the output throughindent. For example:- {{ toYaml . }} + {{ toYaml . | indent 2 }}charts/cloudprem/README.md (4)
566-566: Enhance documentation with podAnnotations example
You’ve addedconsole.podAnnotationscorrectly. Consider including a minimal usage snippet (e.g.:console: podAnnotations: my-annotation: "true") to illustrate how users can apply custom annotations.
621-621: Enhance documentation with podAnnotations example
The newconsole-v3.podAnnotationsentry is well‑introduced. Adding a brief example YAML block will help users understand its purpose and usage.
699-699: Enhance documentation with podAnnotations example
membership.podAnnotationsis documented. A small example of setting membership pod annotations would improve clarity (e.g.:membership: podAnnotations: monitoring: "enabled").
751-751: Enhance documentation with podAnnotations example
You’ve documentedportal.podAnnotations. Including an example snippet demonstrating portal pod annotations will guide users in customizing their deployments.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (37)
charts/agent/Chart.lockis excluded by!**/*.lock,!**/*.lockcharts/agent/Chart.yamlis excluded by!**/*.yamlcharts/agent/templates/deployment.yamlis excluded by!**/*.yamlcharts/agent/values.yamlis excluded by!**/*.yamlcharts/cloudprem/Chart.lockis excluded by!**/*.lock,!**/*.lockcharts/cloudprem/Chart.yamlis excluded by!**/*.yamlcharts/console-v3/Chart.lockis excluded by!**/*.lock,!**/*.lockcharts/console-v3/Chart.yamlis excluded by!**/*.yamlcharts/console-v3/templates/deployment.yamlis excluded by!**/*.yamlcharts/console-v3/values.schema.jsonis excluded by!**/*.jsoncharts/console-v3/values.yamlis excluded by!**/*.yamlcharts/console/Chart.lockis excluded by!**/*.lock,!**/*.lockcharts/console/Chart.yamlis excluded by!**/*.yamlcharts/console/templates/deployment.yamlis excluded by!**/*.yamlcharts/console/values.schema.jsonis excluded by!**/*.jsoncharts/console/values.yamlis excluded by!**/*.yamlcharts/core/Chart.yamlis excluded by!**/*.yamlcharts/membership/Chart.lockis excluded by!**/*.lock,!**/*.lockcharts/membership/Chart.yamlis excluded by!**/*.yamlcharts/membership/templates/cronjob-gc-invitation.yamlis excluded by!**/*.yamlcharts/membership/templates/cronjob-gc.yamlis excluded by!**/*.yamlcharts/membership/templates/cronjob-stack-lifeycle.yamlis excluded by!**/*.yamlcharts/membership/templates/deployment.yamlis excluded by!**/*.yamlcharts/membership/templates/job.yamlis excluded by!**/*.yamlcharts/membership/values.schema.jsonis excluded by!**/*.jsoncharts/membership/values.yamlis excluded by!**/*.yamlcharts/portal/Chart.lockis excluded by!**/*.lock,!**/*.lockcharts/portal/Chart.yamlis excluded by!**/*.yamlcharts/portal/templates/deployment.yamlis excluded by!**/*.yamlcharts/portal/values.schema.jsonis excluded by!**/*.jsoncharts/portal/values.yamlis excluded by!**/*.yamlcharts/regions/Chart.lockis excluded by!**/*.lock,!**/*.lockcharts/regions/Chart.yamlis excluded by!**/*.yamlcharts/stargate/Chart.lockis excluded by!**/*.lock,!**/*.lockcharts/stargate/Chart.yamlis excluded by!**/*.yamlcharts/stargate/templates/deployment.yamlis excluded by!**/*.yamlcharts/stargate/values.yamlis excluded by!**/*.yaml
📒 Files selected for processing (11)
README.md(1 hunks)charts/agent/README.md(2 hunks)charts/cloudprem/README.md(5 hunks)charts/console-v3/README.md(2 hunks)charts/console/README.md(2 hunks)charts/core/README.md(1 hunks)charts/core/templates/_annotations.tpl(1 hunks)charts/membership/README.md(2 hunks)charts/portal/README.md(2 hunks)charts/regions/README.md(2 hunks)charts/stargate/README.md(2 hunks)
🧰 Additional context used
🪛 LanguageTool
README.md
[style] ~13-~13: Using many exclamation marks might seem excessive (in this case: 10 exclamation marks for a text that’s 2958 characters long)
Context: ...tions, users, roles, and permissions. | 
(EN_EXCESSIVE_EXCLAMATION)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Tests
🔇 Additional comments (16)
charts/core/README.md (1)
3-3: Update core chart version badgeThe version badge was correctly bumped to 1.3.0 to reflect this release.
charts/agent/README.md (2)
3-3: Bump agent chart version to 2.8.0The version badge update aligns with the coordinated chart version increments.
68-68: DocumentpodAnnotationsvalueThe addition of the
podAnnotationskey with default{}and description "pod annotations" is correct and consistent with other charts.charts/regions/README.md (2)
3-3: Bump regions chart version to 2.17.0The version badge update is correct and follows the release pattern.
176-176: Addagent.podAnnotationsdocumentationThe new
agent.podAnnotationsentry with default{}and description "pod annotations" correctly documents the feature.charts/portal/README.md (2)
3-3: Bump portal chart version to 2.2.0The version badge update reflects the new release version.
108-108: DocumentpodAnnotationsvalueThe addition of the
podAnnotationskey under values with default{}and description "pod annotations" is consistent with the PR’s scope.charts/console-v3/README.md (2)
3-3: Verify version bump to 2.2.0
The version badge update to 2.2.0 looks correct and aligns with the coordinated chart version updates.
108-108: Document newpodAnnotationskey
ThepodAnnotationsconfiguration key is now documented with typeobject, default{}, and description "pod annotations". This aligns with other charts—good addition.README.md (1)
7-11: Top‑level chart version matrix updated
The chart versions in the matrix have been bumped appropriately for Agent (2.8.0), Cloudprem (3.1.0), Console (2.2.0), Console‑V3 (2.2.0), Core (1.3.0), Membership (2.5.0), Portal (2.2.0), Regions (2.17.0), and Stargate (0.8.0).Please verify that these version updates match the corresponding
charts/*/README.mdfiles, and confirm that thepodAnnotationskey is documented uniformly across all chart READMEs.Also applies to: 13-16
charts/stargate/README.md (1)
3-3: Verify version bump to 0.8.0
The version badge has been updated from 0.7.3 to 0.8.0, consistent with the release.charts/membership/README.md (2)
3-3: Verify version bump to 2.5.0
The version badge update to 2.5.0 aligns with the coordinated release.
241-241: Document newpodAnnotationskey
ThepodAnnotationskey is now added with typeobject, default{}, and description "pod annotations", matching the update in other charts.charts/console/README.md (2)
3-3: Verify version bump to 2.2.0
The version badge has been updated correctly from 2.1.5 to 2.2.0.
105-105: Document newpodAnnotationskey
ThepodAnnotationsconfiguration key is now documented under "Other Values" with typeobject, default{}, and description "pod annotations". This adds consistent support for pod‑level annotations.charts/cloudprem/README.md (1)
4-4: Ensure version consistency in Chart.yaml
The badge now shows Version 3.1.0 and AppVersion v1.1.0; please verify that theChart.yamlreflects these updates (version: 3.1.0,appVersion: v1.1.0) and update any related index files or pipeline configurations to prevent mismatches.
No description provided.