fix: Add volumeMounts only if defaultStorage is enabled

[jackylamhk]

Motivation and context

These volume mounts are conditionally enabled in one initContainers but not others. When using a custom PVC, disabling defaultStorage will not prevent these volumes from being mounted. This causes an issue where the mountPath keys are not enabled when we add the custom VMs under additionalVolumeMounts.

How has this been tested?

Checklist

• I submit my changes into the develop branch
• I have created a changelog fragment
• I have updated the documentation accordingly
• I have added tests to cover my changes
• I have linked related issues (see GitHub docs)
• I have increased versions of npm packages if it is necessary
  (cvat-canvas,
  cvat-core,
  cvat-data and
  cvat-ui)

License

• I submit my code changes under the same MIT License that covers the project.
  Feel free to contact the maintainers if that's a concern.

Summary by CodeRabbit

• Bug Fixes

  • Introduced conditional volume mounts in deployment configurations to ensure proper mounting only when defaultStorage is enabled.

• Chores

  • Updated Helm chart version from 0.13.0 to 0.13.1.
  • Added documentation in values.yaml regarding manual volume mounting when defaultStorage is disabled.

[coderabbitai]

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The recent updates to the Helm chart introduce conditional volume mounts based on configuration settings, specifically focusing on whether defaultStorage is enabled. This change ensures that volume mounts are added only if the relevant storage configuration is active. The version number in Chart.yaml has also been incremented from 0.13.0 to 0.13.1.

Changes

File Path	Change Summary
changelog.d/20240518_021532_jacky.lam_helm_defaultstorage.md	Added a fix for Helm chart to conditionally add volumeMounts based on defaultStorage configuration.
helm-chart/Chart.yaml	Updated version number from 0.13.0 to 0.13.1.
helm-chart/templates/cvat_backend/server/deployment.yml	Introduced conditional volume mounts based on .Values.cvat.backend.defaultStorage.enabled.
helm-chart/templates/cvat_backend/utils/deployment.yml	Added conditional volume mounts in the deployment YAML based on storage configuration values.
helm-chart/templates/cvat_backend/worker_annotation/deployment.yml	Added conditional logic for volume mounts based on .Values.cvat.backend.defaultStorage.enabled.
helm-chart/templates/cvat_backend/worker_export/deployment.yml	Introduced conditional volume mounts based on cvat.backend.defaultStorage.enabled and disableDistinctCachePerService.
helm-chart/templates/cvat_backend/worker_import/deployment.yml	Added conditions for volume mounts based on cvat.backend.defaultStorage.enabled and disableDistinctCachePerService.
helm-chart/values.yaml	Updated notes regarding manual volume mounting if defaultStorage is disabled; commented out some configurations.

Poem

In the land of Helm, where charts do dwell,
A change was made, a tale to tell.
With volumes mounted, only if they should,
Configured by settings, as it would.
Version bumped, a minor leap,
Conditional logic, now runs deep.
🐇✨

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

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 as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[azhavoro]

Please update chart version

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 59e31b3 and f45e7ab.

Files selected for processing (8)

• changelog.d/20240518_021532_jacky.lam_helm_defaultstorage.md (1 hunks)
• helm-chart/Chart.yaml (1 hunks)
• helm-chart/templates/cvat_backend/server/deployment.yml (2 hunks)
• helm-chart/templates/cvat_backend/utils/deployment.yml (2 hunks)
• helm-chart/templates/cvat_backend/worker_annotation/deployment.yml (2 hunks)
• helm-chart/templates/cvat_backend/worker_export/deployment.yml (2 hunks)
• helm-chart/templates/cvat_backend/worker_import/deployment.yml (2 hunks)
• helm-chart/values.yaml (1 hunks)

Files skipped from review due to trivial changes (3)

• changelog.d/20240518_021532_jacky.lam_helm_defaultstorage.md
• helm-chart/Chart.yaml
• helm-chart/templates/cvat_backend/utils/deployment.yml

Additional comments not posted (5)

helm-chart/templates/cvat_backend/server/deployment.yml (1)

Line range hint 68-85: The conditional logic for volume mounts is correctly implemented based on the defaultStorage.enabled and disableDistinctCachePerService settings. This ensures that volume mounts are only added when necessary, aligning with the PR's objectives to prevent unnecessary volume mounts when defaultStorage is disabled.

helm-chart/templates/cvat_backend/worker_export/deployment.yml (1)

Line range hint 64-84: The conditional volume mounts in the worker export deployment are correctly implemented. This change ensures that the volume mounts are consistent with the defaultStorage.enabled and disableDistinctCachePerService settings, which is crucial for maintaining the integrity and isolation of data across different services.
[APROVED]

helm-chart/templates/cvat_backend/worker_import/deployment.yml (1)

Line range hint 64-84: The implementation of conditional volume mounts in the worker import deployment mirrors the changes in other components, maintaining consistency across the board. This is essential for ensuring that volume mounts are handled correctly based on the configuration settings provided in values.yaml.

helm-chart/templates/cvat_backend/worker_annotation/deployment.yml (1)

Line range hint 64-84: The conditional volume mounts for the annotation worker are implemented in line with the changes in other deployment files. This consistency is key to ensuring that all components behave predictably under the same configuration conditions, particularly concerning volume management.

helm-chart/values.yaml (1)

270-275: The comments added to the defaultStorage configuration provide clear guidance on the implications of disabling defaultStorage. This is a valuable addition for users who need to manually manage volume mounts, ensuring they are aware of the necessary steps to maintain functionality.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud