Skip to content

improvement(helm): add additional instructions for AWS deployments#851

Merged
waleedlatif1 merged 1 commit intostagingfrom
improvement/helm
Aug 2, 2025
Merged

improvement(helm): add additional instructions for AWS deployments#851
waleedlatif1 merged 1 commit intostagingfrom
improvement/helm

Conversation

@waleedlatif1
Copy link
Collaborator

Summary

Add additional instructions for AWS deployments

Type of Change

  • Documentation

Testing

N/A

Checklist

  • Code follows project style guidelines
  • Self-reviewed my changes
  • Tests added/updated and passing
  • No new warnings introduced
  • I confirm that I have read and agree to the terms outlined in the Contributor License Agreement (CLA)

@vercel
Copy link

vercel bot commented Aug 2, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
docs 🔄 Building (Inspect) Visit Preview 💬 Add feedback Aug 2, 2025 9:56pm
sim 🔄 Building (Inspect) Visit Preview 💬 Add feedback Aug 2, 2025 9:56pm

@waleedlatif1 waleedlatif1 merged commit 6161bb8 into staging Aug 2, 2025
2 of 4 checks passed
@waleedlatif1 waleedlatif1 deleted the improvement/helm branch August 2, 2025 21:57
Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

Greptile Summary

This PR enhances the Helm chart documentation and deployment configuration specifically for AWS EKS environments. The changes address two key areas:

Documentation Enhancement: The README.md file has been updated to include AWS-specific prerequisites, particularly focusing on the EBS CSI driver requirement for persistent storage in EKS clusters. This addition provides users with concrete shell commands to install the EBS CSI driver as an EKS add-on and set up the necessary IAM roles, following the established pattern of platform-specific instructions already present for Azure and GCP.

Database Migration Configuration: The deployment template has been modified to change how the database migration initContainer handles environment variables. Instead of using Kubernetes' native environment variable mechanism, the migration now uses bash shell execution with inline script that exports the DATABASE_URL before running the migration command. This change ensures proper template expansion and variable resolution at runtime, which is particularly important for AWS deployments where the database URL contains password placeholders that need runtime substitution.

These changes integrate well with the existing Helm chart structure by maintaining consistency with other cloud provider documentation sections and following Kubernetes deployment best practices. The modifications address common AWS EKS deployment challenges while preserving the chart's multi-cloud compatibility.

Confidence score: 3/5

  • This PR has moderate risk due to the initContainer command change that could affect database migration reliability
  • Score reflects that while documentation changes are safe, the deployment template modification introduces execution environment changes that need careful validation
  • Pay close attention to the deployment-app.yaml file, specifically the database migration initContainer changes

2 files reviewed, 1 comment

Edit Code Review Bot Settings | Greptile

**Prerequisites for AWS:**
```bash
# Install EBS CSI driver add-on
aws eks create-addon --cluster-name your-cluster --addon-name aws-ebs-csi-driver
Copy link
Contributor

Choose a reason for hiding this comment

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

style: Consider adding a note that your-cluster should be replaced with the actual EKS cluster name

Suggested change
aws eks create-addon --cluster-name your-cluster --addon-name aws-ebs-csi-driver
# Install EBS CSI driver add-on (replace 'your-cluster' with your actual cluster name)
aws eks create-addon --cluster-name your-cluster --addon-name aws-ebs-csi-driver

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.

1 participant