improvement(helm): add additional instructions for AWS deployments#851
improvement(helm): add additional instructions for AWS deployments#851waleedlatif1 merged 1 commit intostagingfrom
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
There was a problem hiding this comment.
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
| **Prerequisites for AWS:** | ||
| ```bash | ||
| # Install EBS CSI driver add-on | ||
| aws eks create-addon --cluster-name your-cluster --addon-name aws-ebs-csi-driver |
There was a problem hiding this comment.
style: Consider adding a note that your-cluster should be replaced with the actual EKS cluster name
| 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 |
Summary
Add additional instructions for AWS deployments
Type of Change
Testing
N/A
Checklist