feat: expose extra env variables for more flexible infra tuning

[ab-smith]

Summary by CodeRabbit

• Configuration Improvements
  • Added environment variable support for Huey task queue file path configuration
  • Introduced configurable Gunicorn server parameters via environment variables
  • Enhanced deployment flexibility by allowing dynamic server and task queue settings

[coderabbitai]

Walkthrough

The pull request introduces configuration flexibility for the Huey task queue and Gunicorn server in the CISO Assistant backend. In settings.py, a new environment variable HUEY_FILE_PATH allows dynamic specification of the Huey database file path. Similarly, in startup.sh, environment variables GUNICORN_WORKERS, GUNICORN_TIMEOUT, and GUNICORN_KEEPALIVE are added to configure Gunicorn server parameters, enabling more adaptable deployment configurations.

Changes

File	Change Summary
backend/ciso_assistant/settings.py	Added HUEY_FILE_PATH environment variable with default path, updated Huey configuration to use dynamic file path
backend/startup.sh	Introduced default environment variables for Gunicorn: GUNICORN_WORKERS, GUNICORN_TIMEOUT, GUNICORN_KEEPALIVE

Possibly related PRs

• feat: task runner enabler with huey #1422: Changes to Huey task queue configuration in settings.py
• perf: multiple optimizations for gunicorn and expose pg's CONN_MAX_AGE #1424: Modifications to PostgreSQL settings in the same settings file

Suggested labels

perf

Suggested reviewers

• eric-intuitem
• nas-tabchiche

Poem

🐰 Configs dance with freedom's grace,
Environment vars now take their place,
Huey and Gunicorn flex and bend,
Flexibility becomes our friend!
Deployment magic, smooth and light,
Rabbit's config brings pure delight! 🚀

✨ Finishing Touches

• 📝 Generate Docstrings (Beta)

---

🪧 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 @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 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 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 generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

backend/ciso_assistant/settings.py (1)

421-428: LGTM! Consider adding a comment about the environment variable.

The implementation correctly allows for flexible Huey database path configuration while maintaining backward compatibility.

Consider adding a brief comment explaining the HUEY_FILE_PATH environment variable usage:

 ## Huey settings
+# HUEY_FILE_PATH: Optional environment variable to specify the Huey database file location
+# Defaults to BASE_DIR/db/huey.db if not set
 HUEY_FILE_PATH = os.environ.get("HUEY_FILE_PATH", BASE_DIR / "db" / "huey.db")

backend/startup.sh (1)

29-35: Consider adding documentation about the environment variables.

The Gunicorn configuration is now more flexible, but users need to know about these options.

Add a comment block explaining the available environment variables:

 # Set default values for Gunicorn configuration
+# Environment variables:
+# - GUNICORN_WORKERS: Number of worker processes (default: 3)
+# - GUNICORN_TIMEOUT: Worker timeout in seconds (default: 100)
+# - GUNICORN_KEEPALIVE: Keep-alive timeout in seconds (default: 30)
 GUNICORN_WORKERS=${GUNICORN_WORKERS:-3}
 GUNICORN_TIMEOUT=${GUNICORN_TIMEOUT:-100}
 GUNICORN_KEEPALIVE=${GUNICORN_KEEPALIVE:-30}

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 10c950f and 531ed06.

📒 Files selected for processing (2)

• backend/ciso_assistant/settings.py (1 hunks)
• backend/startup.sh (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (11)

• GitHub Check: startup-docker-compose-test
• GitHub Check: enterprise-startup-functional-test (3.12)
• GitHub Check: functional-tests (3.12, chromium)
• GitHub Check: enterprise-startup-docker-compose-test
• GitHub Check: Analyze (python)
• GitHub Check: startup-functional-test (3.12)
• GitHub Check: ruff (3.12)
• GitHub Check: enterprise-functional-tests (3.12, chromium)
• GitHub Check: test (3.12)
• GitHub Check: build (3.12)
• GitHub Check: Analyze (javascript-typescript)

🔇 Additional comments (1)

backend/startup.sh (1)

24-28: LGTM! The default values are reasonable.

The implementation properly exposes Gunicorn configuration through environment variables with sensible defaults:

• GUNICORN_WORKERS: 3 workers (good for most deployments)
• GUNICORN_TIMEOUT: 100 seconds (suitable for most operations)
• GUNICORN_KEEPALIVE: 30 seconds (standard keepalive value)

[eric-intuitem]

LGTM