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

feat: add envfrom into deployments to enable loading entire secrets or configMaps into container ENV_VARs #109

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

marcel-dias
Copy link

@marcel-dias marcel-dias commented Jul 16, 2024

feat: add envFrom into deployments to enable loading entire secrets or configMaps into container ENV_VARs

Scenario:

I use ExternalSecrets to fetch ENV_VARs from AWS SSM ParameterStore and create k8s secrets. Using envFrom is possible to load the entire secret without mapping key by key.

Summary by CodeRabbit

  • New Features

    • Streamlined environment variable management by sourcing from ConfigMaps or Secrets in the webhooks, worker, and main deployment configurations. This enhances security and simplifies configuration.
  • Chores

    • Updated deployment configurations to improve readability and maintainability by reorganizing environment variable setup.

…r configMaps into container ENV_VARs

Signed-off-by: Marcel Dias <[email protected]>
@marcel-dias marcel-dias requested a review from a team as a code owner July 16, 2024 22:26
Copy link

coderabbitai bot commented Jul 16, 2024

Walkthrough

The changes involve adding envFrom blocks across various Kubernetes deployment templates to source environment variables from ConfigMaps or Secrets. This reflects a reorganization aimed at streamlining environment variable management and ensuring sensitive information is securely handled.

Changes

Files Change Summary
charts/n8n/templates/deployment.webhooks.yaml Added envFrom block within the deployment webhooks configuration to source environment variables.
charts/n8n/templates/deployment.worker.yaml Added envFrom block with values from .Values.envFrom in the worker container's spec to source environment variables.
charts/n8n/templates/deployment.yaml Added envFrom block under the env section in the deployment configuration to source environment variables.
charts/n8n/values.yaml Removed the envFrom section that included a commented-out secretRef block and related comments.

Poem

In the realm of YAML files,
Secrets flow in gentle styles.
ConfigMaps now take their place,
Environment sourced with grace.
Variables in harmony,
Kubernetes sings with glee.
🌱🐇


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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between d10683b and c22f1b1.

Files selected for processing (4)
  • charts/n8n/templates/deployment.webhooks.yaml (1 hunks)
  • charts/n8n/templates/deployment.worker.yaml (1 hunks)
  • charts/n8n/templates/deployment.yaml (1 hunks)
  • charts/n8n/values.yaml (1 hunks)
Additional comments not posted (4)
charts/n8n/templates/deployment.webhooks.yaml (1)

59-62: Review of envFrom block addition

The addition of the envFrom block to load environment variables from external sources like ConfigMaps or Secrets is implemented correctly. This change should help in reducing the boilerplate needed to map each environment variable individually and supports better secrets management practices.

charts/n8n/templates/deployment.worker.yaml (1)

59-62: Review of envFrom block addition in worker deployment

The envFrom block has been correctly added to the worker deployment template, allowing for the seamless integration of environment variables from ConfigMaps or Secrets. This change aligns with best practices for managing environment variables in Kubernetes deployments.

charts/n8n/templates/deployment.yaml (1)

70-73: Review of envFrom block addition in main deployment

The envFrom block has been correctly integrated into the main deployment template. This facilitates the loading of all keys from a ConfigMap or Secret as environment variables, which is particularly useful when dealing with multiple environment variables that are managed externally.

charts/n8n/values.yaml (1)

119-122: Review of envFrom section removal

The removal of the envFrom section from the values.yaml file simplifies the Helm chart by removing unused or commented-out configurations. This change should make the chart cleaner and reduce confusion. However, it's important to ensure that all necessary configurations are still possible through other means provided in the Helm chart.

@Vad1mo
Copy link
Member

Vad1mo commented Sep 10, 2024

update of readme is needed, to indicated this possibility.

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.

2 participants