cvat
cvat copied to clipboard
allow setting django secret with enironment variable
#8565
Motivation and context
In container deployment scenarios, it may be cleaner for an admin to provide an app secret via env vars.
This may also be a solution for #8002, if you don't want fix in #8003.
How has this been tested?
Ran this is k8s environment.
Checklist
- [x ] I submit my changes into the
developbranch - [ ] I have created a changelog fragment
- [ ] I have updated the documentation accordingly
- [ ] I have added tests to cover my changes
- [ x] 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
- [ x] 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
- Improved management of the
SECRET_KEYfor enhanced application security and robustness.
- Improved management of the
- Bug Fixes
- Adjusted logic for importing the
SECRET_KEYto prevent application errors if the key is missing.
- Adjusted logic for importing the
- Documentation
- Added comments for better clarity and understanding of the settings configuration.
Walkthrough
The changes made in the pull request focus on the cvat/settings/base.py file, specifically related to the management of the SECRET_KEY. A new line has been added to define SECRET_KEY, which retrieves its value from the DJANGO_APP_SECRET environment variable. The import logic for the SECRET_KEY has been modified to check its existence before attempting to import it, with a fallback to generate a new key if necessary. Minor formatting adjustments and comments have also been added for clarity.
Changes
| File | Change Summary |
|---|---|
| cvat/settings/base.py | Added SECRET_KEY variable that retrieves its value from DJANGO_APP_SECRET. Modified import logic to check for existence before importing and generate a new key if not found. Minor formatting and comment improvements. |
Poem
In the garden where secrets bloom,
A key was forged to chase the gloom.
From whispers of the night so deep,
A treasure found, our hearts to keep.
With each new dawn, our hopes take flight,
In code we trust, our future bright! 🐇✨
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?
🪧 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>, please review it.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
@coderabbitaiin 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
@coderabbitaiin 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.@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 using PR comments)
@coderabbitai pauseto pause the reviews on a PR.@coderabbitai resumeto resume the paused reviews.@coderabbitai reviewto trigger an incremental review. This is useful when automatic reviews are disabled for the repository.@coderabbitai full reviewto do a full review from scratch and review all the files again.@coderabbitai summaryto regenerate the summary of the PR.@coderabbitai resolveresolve all the CodeRabbit review comments.@coderabbitai configurationto show the current CodeRabbit configuration for the repository.@coderabbitai helpto get help.
Other keywords and placeholders
- Add
@coderabbitai ignoreanywhere in the PR description to prevent this PR from being reviewed. - Add
@coderabbitai summaryto generate the high-level summary at a specific location in the PR description. - Add
@coderabbitaianywhere in the PR title to generate the title automatically.
CodeRabbit Configuration File (.coderabbit.yaml)
- You can programmatically configure CodeRabbit by adding a
.coderabbit.yamlfile 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.
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
@sei-jmattson Thank you for the contribuition!
Please resolve the conflict and add a changelog note. https://github.com/cvat-ai/cvat/blob/develop/CHANGELOG.md?plain=1#L8-L15
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
Codecov Report
All modified and coverable lines are covered by tests :white_check_mark:
Project coverage is 73.83%. Comparing base (
291f3d2) to head (2e25b75).
Additional details and impacted files
@@ Coverage Diff @@
## develop #8566 +/- ##
===========================================
- Coverage 73.84% 73.83% -0.01%
===========================================
Files 417 417
Lines 44598 44598
Branches 4031 4031
===========================================
- Hits 32932 32931 -1
- Misses 11666 11667 +1
| Components | Coverage Δ | |
|---|---|---|
| cvat-ui | 78.25% <ø> (-0.01%) |
:arrow_down: |
| cvat-server | 70.08% <ø> (ø) |