Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support existingSecret for redis configuration #81

Closed
wants to merge 6 commits into from

Conversation

sebastiansterk
Copy link
Contributor

@sebastiansterk sebastiansterk commented Mar 1, 2024

Introduces scaling.redis.existingSecret and scaling.redis.existingSecretKey to enable referencing an existing secret containing the Redis password. This aligns with the Bitnami Redis chart, allowing both to use the same secret.

Summary by CodeRabbit

  • New Features
    • Introduced new configuration options that allow users to integrate existing Kubernetes secrets for Redis, providing enhanced flexibility and improved security for managing credentials.
  • Documentation
    • Updated the guidance to help users understand how to enable these new configuration options in their deployments.

@sebastiansterk sebastiansterk requested a review from a team as a code owner March 1, 2024 07:33
README.md Outdated Show resolved Hide resolved
Copy link
Member

@Vad1mo Vad1mo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will merge, after resolving the discussion.

values.yaml Outdated Show resolved Hide resolved
@@ -280,6 +280,8 @@ scaling:
redis:
host:
password:
existingSecret:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you uncomment those two lines, as they are optional.
Also you can add a comment above explaining the purpose of those two entries.

@gitmonster
Copy link

Is there any progress with this merger? This feature is highly appreciated.

@Vad1mo
Copy link
Member

Vad1mo commented Jul 18, 2024

Will merge, after resolving the discussion.

yes, see #81 (review)

@gitmonster
Copy link

Will merge, after resolving the discussion.

yes, see #81 (review)

So @sebastiansterk are you able to set the commenting?

Copy link

coderabbitai bot commented Feb 10, 2025

Walkthrough

The pull request introduces additional configuration options for Redis secret management within the Helm chart. Two new fields, existingSecret and existingSecretPasswordKey, are added to the README and as commented options in the values file, allowing users to specify an existing Kubernetes secret. In addition, the templates file has been updated to conditionally set the QUEUE_BULL_REDIS_PASSWORD environment variable based on these new configurations. This update maintains all existing functionality while expanding configuration flexibility for managing Redis credentials.

Changes

File(s) Change Summary
README.md, values.yaml Added new configuration fields (existingSecret and existingSecretPasswordKey) under the redis section to allow specification of an existing Kubernetes secret.
(In values.yaml, the options are provided as commented-out lines.)
templates/_helpers.tpl Introduced a conditional block that checks for scaling.redis.existingSecret and scaling.redis.existingSecretPasswordKey to set the QUEUE_BULL_REDIS_PASSWORD environment variable, which retrieves its value from the specified Kubernetes secret.

Sequence Diagram(s)

sequenceDiagram
    participant U as User
    participant H as Helm Chart Renderer
    participant T as Template Engine
    participant K as Kubernetes Cluster

    U->>H: Provide Redis secret configuration values
    H->>T: Process Helm templates with the new secret fields
    Note right of T: Check if 'existingSecret' and 'existingSecretPasswordKey' are provided
    T->>T: Set 'QUEUE_BULL_REDIS_PASSWORD' environment variable based on secret lookup
    T->>K: Deploy updated configuration to Kubernetes
Loading

Suggested reviewers

  • Vad1mo

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
🪧 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.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
README.md (1)

283-284: Add descriptions for the new Redis secret configuration options.

To improve documentation, add descriptions explaining the purpose of these fields and their relationship with the Bitnami Redis chart.

Apply this diff:

-    existingSecret:
-    existingSecretPasswordKey:
+    existingSecret:         # Name of the existing Kubernetes secret containing the Redis password
+    existingSecretPasswordKey:    # Key in the existing secret that contains the Redis password
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between e9f17df and 5487065.

📒 Files selected for processing (3)
  • README.md (1 hunks)
  • templates/_helpers.tpl (1 hunks)
  • values.yaml (1 hunks)
🔇 Additional comments (2)
templates/_helpers.tpl (1)

95-101: LGTM! Well-structured implementation for Redis secret management.

The implementation correctly follows Kubernetes best practices for secret management and maintains consistency with other secret references in the file.

values.yaml (1)

324-325: Add documentation and uncomment the optional fields.

Based on previous review feedback, please:

  1. Add a comment explaining the purpose of these fields
  2. Uncomment the fields as they are optional configurations

Apply this diff:

-    # existingSecret:
-    # existingSecretPasswordKey:
+    # Use an existing Kubernetes secret for Redis password
+    existingSecret:
+    existingSecretPasswordKey:

@sebastiansterk
Copy link
Contributor Author

I am closing this PR as these changes have now been added into the main branch.

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.

4 participants