Feat/helm extra env from

[fbuchmeier-abi]

Description

This PR adds two additional options to allow additional environment variables (with env and envFrom) to be added to the appsmith container.

We use this to add additional secrets generated by our controllers (e.g. crossplane aws-provider) as environment variables into the appsmith container.

An example values.yaml could look like this:

extraEnv:
- name: APPSMITH_MAIL_USERNAME
  valueFrom:
    secretKeyRef:
      name: smtp-credentials
      key: username
- name: APPSMITH_MAIL_PASSWORD
  valueFrom:
    secretKeyRef:
      name: smtp-credentials
      key: password

If you have any suggestions or questions please let me know.

Best regards,
Florian.

Summary by CodeRabbit

• New Features
  • Enhanced deployment customization with additional options for update strategies.
  • Introduced flexible settings allowing users to add extra volumes, volume mounts, environment variables, and additional configuration sources to tailor deployments.

[coderabbitai]

Walkthrough

This pull request enhances the Helm chart deployment template by introducing conditional logic to include additional configuration options. The deployment template now conditionally adds rolling update parameters if the strategy type is set to "RollingUpdate". In addition, the container configuration is extended to conditionally include extra volumes, volume mounts, environment variables, and environment variable sources. The accompanying values.yaml file is updated to introduce new parameters to support these additional settings.

Changes

File(s)	Summary
deploy/helm/templates/.../deployment.yaml	Added conditional blocks for the strategy section to include rolling update parameters and for the container spec to conditionally render extra volume mounts, environment variables, and environment variable sources. Also updated the volumes section to include extraVolumes if specified.
deploy/helm/values.yaml	Introduced new configuration options (extraVolumes, extraVolumeMounts, extraEnv, and extraEnvFrom) initialized as empty lists for more flexible deployment configurations.

Sequence Diagram(s)

sequenceDiagram
    participant Helm
    participant DeploymentTemplate
    participant Values
    Helm->>Values: Load configuration from values.yaml
    Values-->>Helm: Return strategy, extraVolumes, extraEnv, etc.
    Helm->>DeploymentTemplate: Evaluate strategyType condition
    alt RollingUpdate
        DeploymentTemplate->>DeploymentTemplate: Add rollingUpdate (maxSurge, maxUnavailable)
    else Default
        DeploymentTemplate->>DeploymentTemplate: Proceed with default strategy
    end
    DeploymentTemplate->>DeploymentTemplate: Conditionally add extraVolumes, extraVolumeMounts, extraEnv, extraEnvFrom
    DeploymentTemplate-->>Helm: Generate final deployment manifest

Loading

Poem

In YAML's realm the settings sing,
Conditional paths make the bells ring.
Extra volumes and env blend with cheer,
Rolling updates whisper, "Change is here!"
Our Helm chart dances with code so clear.
🚀✨

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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>, 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.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

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.

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.

[fbuchmeier-abi]

Any updates or change requests?

[github-actions]

This PR has not seen activitiy for a while. It will be closed in 7 days unless further activity is detected.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (5)

deploy/helm/values.yaml (4)

387-391: extraVolumes parameter
Introduces an empty list for users to add custom Kubernetes volumes. Consider documenting this field in the chart README to guide users.

---

392-397: extraVolumeMounts parameter
Allows mounting those extra volumes into the container. Please add usage examples to the chart documentation for clarity.

---

460-469: extraEnv parameter
Enables injection of additional environment variables. Recommend updating README to include this new option and its schema.

---

470-474: extraEnvFrom parameter
Supports referencing entire ConfigMaps or Secrets as envFrom sources. Don't forget to document this in the chart's README.

deploy/helm/templates/deployment.yaml (1)

21-25: Conditional rollingUpdate block
Properly includes rollingUpdate only when strategyType is "RollingUpdate". To complete this feature, consider adding an updateStrategy section in values.yaml for users to configure maxSurge/maxUnavailable.

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 988537f and c9d6728.

📒 Files selected for processing (2)

• deploy/helm/templates/deployment.yaml (4 hunks)
• deploy/helm/values.yaml (3 hunks)

🔇 Additional comments (4)

deploy/helm/templates/deployment.yaml (4)

132-134: Inject extraVolumeMounts
Correctly renders additional volume mounts in the pod spec.

---

152-154: Inject extraEnv
Appears to correctly merge user-defined environment variables into the container.

---

170-172: Inject extraEnvFrom
Properly appends envFrom entries for ConfigMaps/Secrets.

---

178-180: Inject extraVolumes
Correctly adds user-specified volumes to the pod.

[github-actions]

This PR has been closed because of inactivity.