Skip to content

fix(helm): Remove unused directory fields from archive_output.storage and stream_output.storage in values.yaml (fixes #2074).#2075

Merged
junhaoliao merged 3 commits into
y-scope:mainfrom
junhaoliao:helm-remove-dangling-config
Mar 6, 2026
Merged

fix(helm): Remove unused directory fields from archive_output.storage and stream_output.storage in values.yaml (fixes #2074).#2075
junhaoliao merged 3 commits into
y-scope:mainfrom
junhaoliao:helm-remove-dangling-config

Conversation

@junhaoliao

@junhaoliao junhaoliao commented Mar 5, 2026

Copy link
Copy Markdown
Member

Description

archive_output.storage.directory and stream_output.storage.directory in the Helm chart's
values.yaml are dangling references — they are defined but never consumed by any template. The
configmap template hardcodes the directories instead:

directory: "/var/data/archives"

directory: "/var/data/streams"

These hardcoded paths (/var/data/archives and /var/data/streams) match the PVC mount points, so
the directory fields in values.yaml have no effect. They appear to be leftovers from when the
clp-package used host-mounted directories (removed in #2023).

This PR removes the unused directory fields and their comments from both archive_output.storage and stream_output.storage in values.yaml.

Checklist

  • The PR satisfies the contribution guidelines.
  • This is a breaking change and that has been indicated in the PR title, OR this isn't a
    breaking change.
  • Necessary docs have been updated, OR no docs need to be updated.

Validation performed

1. Helm template renders identically

Task: Verify that removing the directory fields from values.yaml does not change the
rendered Kubernetes manifests.

Command:

$ cd tools/deployment/package-helm
$ helm template clp . | grep -B2 -A5 'archive_output:\|stream_output:'

Output:

        initial_backoff_ms: 100
        max_backoff_ms: 5000
    archive_output:
      compression_level: 3
      storage:
        directory: "/var/data/archives"
        type: "fs"
      retention_period: null
--
      retention_period: 60
      stream_collection_name: "stream-files"
    stream_output:
      storage:
        directory: "/var/data/streams"
        type: "fs"
      target_uncompressed_size: 134217728
    tmp_directory: "/var/tmp"

Explanation: The rendered configmap still contains the hardcoded directory values
(/var/data/archives and /var/data/streams) from the template — these come from
configmap.yaml, not values.yaml. The output is identical before and after this change.

2. No remaining references to removed fields in Helm chart

Task: Verify that no Helm template or helper references the removed directory fields.

Command:

$ grep -r 'archive_output.storage.directory\|stream_output.storage.directory' \
    tools/deployment/package-helm/

Output:

(no output)

Explanation: No templates or helpers reference the removed fields.

Summary by CodeRabbit

Release Notes

  • Documentation

    • Updated the multi-host deployment guide with corrected local filesystem storage configuration paths to ensure proper log directory setup.
  • Chores

    • Bumped Helm Chart version to 0.2.0-dev.2.
    • Removed directory configuration entries for archive and stream output storage from deployment configuration values, streamlining the deployment setup process.

…age` and `stream_output.storage` in `values.yaml` (fixes y-scope#2074).
@junhaoliao junhaoliao requested a review from a team as a code owner March 5, 2026 21:38
@coderabbitai

coderabbitai Bot commented Mar 5, 2026

Copy link
Copy Markdown
Contributor

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: 8dceb340-6608-4a5c-bf4a-ead16f1c7670

📥 Commits

Reviewing files that changed from the base of the PR and between dbc1799 and 3c6240e.

📒 Files selected for processing (3)
  • docs/src/user-docs/guides-docker-compose-deployment.md
  • tools/deployment/package-helm/Chart.yaml
  • tools/deployment/package-helm/values.yaml
💤 Files with no reviewable changes (1)
  • tools/deployment/package-helm/values.yaml

Walkthrough

Updated Helm chart version from 0.2.0-dev.1 to 0.2.0-dev.2, removed unused directory configuration entries from Helm values for archive and stream storage, and corrected the documentation to reflect the updated storage configuration path structure.

Changes

Cohort / File(s) Summary
Documentation
docs/src/user-docs/guides-docker-compose-deployment.md
Updated local filesystem storage configuration path from logs_input.storage.directory to logs_input.directory in the multi-host CLP deployment guide.
Helm Deployment
tools/deployment/package-helm/Chart.yaml, tools/deployment/package-helm/values.yaml
Bumped Helm chart version to 0.2.0-dev.2 and removed unused directory configuration entries under archive_output.storage and stream_output.storage in clpConfig.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related issues

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title directly and specifically describes the main change: removing unused directory fields from archive_output.storage and stream_output.storage in values.yaml.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@junhaoliao junhaoliao added this to the February 2026 milestone Mar 5, 2026
@junhaoliao junhaoliao requested a review from hoophalab March 5, 2026 21:39
@junhaoliao junhaoliao merged commit 1cdef86 into y-scope:main Mar 6, 2026
23 checks passed
@junhaoliao junhaoliao deleted the helm-remove-dangling-config branch May 7, 2026 19:46
junhaoliao added a commit to junhaoliao/clp that referenced this pull request May 17, 2026
…age` and `stream_output.storage` in `values.yaml` (fixes y-scope#2074). (y-scope#2075)
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.

2 participants