fix: Generate secret key in initContainer instead of python code

[mathijscarlu]

This PR adds a cvat.backend.initSecretKey.enabled flag, which enables an initContainer on the cvat-backend-server deployment. This replaces the need for the generate_secret_key function when deploying via Helm.

Motivation and context

This PR fixes #8002 by creating the /home/django/keys/secret_key.py file in an initContainer, which makes it unnecessary to create it from one of the backend Pods.

How has this been tested?

This has only been tested on AKS by deploying it.

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

• New Features
  • Introduced an option to automatically generate a secret key for the CVAT backend server during deployment.
  • Added a new configuration option initSecretKey to enable or disable secret key generation.

[coderabbitai]

Walkthrough

A new feature has been added to the cvat_backend server's Helm chart to address secret key generation issues when deploying on Kubernetes (AKS). This feature conditionally generates a secret key using busybox if enabled in the configuration. This aims to ensure that the backend Pods can successfully create the necessary secret key file.

Changes

File	Change Summary
helm-chart/templates/.../deployment.yml	Added a conditional block to generate a secret key if .Values.cvat.backend.initSecretKey.enabled is true.
helm-chart/values.yaml	Introduced a new configuration option initSecretKey with enabled: false under the cvat section.

Assessment against linked issues

Objective (Issue #)	Addressed	Explanation
Secret key generation fails when deploying via Helm (#8002)	✅
Add initContainer to create secret key file (#8002)	✅

Poem

In the realm of code and Kubernetes,
A rabbit hops with joyful grins,
Secret keys now born with ease,
Busybox hums, no more unease.
Helm charts guide, deployments thrive,
In AKS, our apps arrive! 🚀🐇

---

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.

[sonarcloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

[coderabbitai]

Actionable comments posted: 0

Outside diff range and nitpick comments (2)

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

119-133: The implementation of the initContainer for secret key generation looks correct and aligns with the PR objectives.

However, consider adding error handling or logging to ensure that the secret key generation process is traceable and debuggable.

helm-chart/values.yaml (1)

122-123: The addition of the initSecretKey configuration with a default value of false is appropriate and provides flexibility for enabling this feature.

Consider documenting this new configuration in the Helm chart's README to help users understand its purpose and how to enable it.

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between b08c1a2 and eff69e4.

Files selected for processing (2)

• helm-chart/templates/cvat_backend/server/deployment.yml (1 hunks)
• helm-chart/values.yaml (1 hunks)