Feat: add helm chart
Provide Helm chart to install on kubernetes
Summary by CodeRabbit
-
New Features
- Introduced a comprehensive Helm chart for deploying the "wren" application, including configurations for API, frontend, engine, and server components.
- Added support for dynamic generation of Kubernetes resources such as Deployments, Services, ConfigMaps, Secrets, and PersistentVolumeClaims.
- Implemented ingress configurations for traffic routing with TLS support.
-
Documentation
- Updated environment configuration files to include essential variables for application operation and database connections.
-
Chores
- Added various configuration sections in the Helm values file to enhance deployment flexibility and management.
@wwwy3y3 do you want to take a look?
@grieve54706 yeah, currently checking. We had some discussions on discord.
do you need any more information ? i have retry but without success i need more log to investigate futher
i have updated the branch
Walkthrough
This pull request introduces a comprehensive Helm chart configuration for a multi-component application named "wren". The deployment includes templates for various Kubernetes resources such as Deployments, Services, Ingress, ConfigMaps, Secrets, and PersistentVolumeClaims. The chart supports configurable deployments for API, frontend, engine, and server components, with flexible settings for image repositories, ports, scaling, and environment configurations. The implementation provides a robust and customizable deployment strategy for a complex application architecture.
Changes
| File | Change Summary |
|---|---|
deployment/helm/Chart.yaml |
Added Helm chart configuration with PostgreSQL dependency |
deployment/helm/templates/_helpers.tpl |
Added template helper functions for naming, labeling, and metadata generation |
deployment/helm/templates/configmaps.yaml |
Added template for generating ConfigMaps from .env and other files |
deployment/helm/templates/deployment-*.yaml |
Added Deployment templates for API, frontend, engine, and server components |
deployment/helm/templates/ingress.yaml |
Added Ingress resource template with dynamic configuration |
deployment/helm/templates/pvc.yaml |
Added PersistentVolumeClaim template for storage management |
deployment/helm/templates/secrets.yaml |
Added Secrets template for managing sensitive configurations |
deployment/helm/templates/service-*.yaml |
Added Service templates for API, frontend, engine, and server |
deployment/helm/templates/serviceaccount.yaml |
Added ServiceAccount template |
deployment/helm/values.yaml |
Added comprehensive values configuration for deployment |
deployment/helm/values/home/app.env |
Added environment variables for application configuration |
deployment/helm/values/home/secrets/postgres.env |
Added PostgreSQL credentials |
deployment/helm/values/home/secrets/secrets.env |
Added secret environment variables |
deployment/helm/values/home/values.yaml |
Added additional values configuration |
Sequence Diagram
sequenceDiagram
participant Helm as Helm Chart
participant K8s as Kubernetes Cluster
participant DB as PostgreSQL
Helm->>K8s: Deploy ServiceAccount
Helm->>K8s: Create Secrets
Helm->>K8s: Create ConfigMaps
Helm->>DB: Configure PostgreSQL Dependency
Helm->>K8s: Deploy Deployments
Helm->>K8s: Create Services
Helm->>K8s: Configure Ingress
Poem
🐰 Helm's Magical Deployment Dance
With templates crisp and values bright, Our wren app takes its Kubernetes flight. Secrets whisper, services sing, Deployments dance on cloud's own wing!
🚀 Kubernetes magic, oh so neat! 🌈
🪧 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
@coderabbitaiin 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
@coderabbitaiin 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 pauseto pause the reviews on a PR. -
@coderabbitai resumeto resume the paused reviews. -
@coderabbitai reviewto trigger an incremental review. This is useful when automatic reviews are disabled for the repository. -
@coderabbitai full reviewto do a full review from scratch and review all the files again. -
@coderabbitai summaryto regenerate the summary of the PR. -
@coderabbitai generate docstringsto generate docstrings for this PR. (Beta) -
@coderabbitai resolveresolve all the CodeRabbit review comments. -
@coderabbitai configurationto show the current CodeRabbit configuration for the repository. -
@coderabbitai helpto get help.
Other keywords and placeholders
- Add
@coderabbitai ignoreanywhere in the PR description to prevent this PR from being reviewed. - Add
@coderabbitai summaryto generate the high-level summary at a specific location in the PR description. - Add
@coderabbitaianywhere in the PR title to generate the title automatically.
CodeRabbit Configuration File (.coderabbit.yaml)
- You can programmatically configure CodeRabbit by adding a
.coderabbit.yamlfile 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.