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.

Sign up for GitHub

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

Jump to bottom

67 create helm chart templates for refarch components #87

Draft
wants to merge 7 commits into
base: main
Choose a base branch
from
Draft

67 create helm chart templates for refarch components #87

wants to merge 7 commits into from

Conversation

langehm
Copy link

@langehm langehm commented Feb 20, 2025

Description

Short description or comments

Reference

Issues #67

@langehm langehm linked an issue Feb 20, 2025 that may be closed by this pull request
Create Helm Chart Templates for RefArch Components #67
Open
@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 20, 2025

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

🪧 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. (Beta)
  • @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.

hupling
hupling reviewed Feb 20, 2025
View reviewed changes
charts/refarch/Chart.yaml
@@ -0,0 +1,24 @@
apiVersion: v2
name: refarch
Copy link
Contributor

Choose a reason for hiding this comment

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

i would name it refarch-template

Copy link
Author

Choose a reason for hiding this comment

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

This is currently a pre-draft version - many things may change.
But I would discourage you from calling it refarch-template, as it will be used by various other applications that differ from the original template, but are still built in the "refarch way".

Copy link
Contributor

Choose a reason for hiding this comment

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

Ich habe jetzt immer noch nicht verstanden, was das Template macht.

  • Möglichkeit 1: die Projekte kopieren sich das Template komplett und machen anpassungen
  • Möglichkeit 2: die Projekte holen sich die Templates als Dependency rein und machen nur Anpassungen in ihrer values.yml

Copy link
Member

Choose a reason for hiding this comment

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

Wir streben definitiv Möglichkeit 2 an.

@langehm
Copy link
Author

langehm commented Feb 20, 2025

The plan of this after a meeting with @devtobi and @simonhir will a kind of module based approach.
There will be only one deployment template etc. and everything will be created as a list of modules.
Frontend, Backend etc. do not differ that much. Seperate template probably wont be needed.

@hupling hupling mentioned this pull request Feb 21, 2025
Open
@hupling
Copy link
Contributor

hupling commented Feb 21, 2025

grafik

Das ist natürlich ungünstig ein Meeting zu machen, an dem ich nicht dabei bin. Ich habe das erste Beispiel mit der neuen Referenz- Architektur in Openshift deployt.

Soll man jetzt quasi solche Templates machen und die Charts als Dependency in der Chart.yml importiert? Das Image und Konfig wird dann in der values.yml angepasst.

@hupling
Copy link
Contributor

hupling commented Feb 21, 2025

grafik

Das Repo existiert nur, damit alle Charts im Artifacthub unter derselben Organisation gelistet sind

ejcsid
ejcsid requested changes Feb 21, 2025
View reviewed changes
@langehm
Copy link
Author

langehm commented Feb 25, 2025

THIS IS CURRENTLY A DRAFT!!! Please hold on with your requests

@langehm
Copy link
Author

langehm commented Feb 26, 2025

@devtobi and I would like to propose the following solution:

We create a template that can be used as a dependency for other refarch projects. Projects that are very close to the default case will only need to configure some basics (e.g. image name, some environment variables). Resources, etc., are set via a default. These projects will only need one values.yaml file and nothing more (no additional templates).

This Helm project will include only one template (module) which is generic for any type of deployment (EAI, frontend, backend, ...). The end user will create a list of modules that describes all of the deployments, etc. There is no distinction between different deployments (backend, frontend, ...).

The advantage would be to avoid having copied-and-pasted Helm projects for each type of refarch application - only values.yaml files.

The goal is to build a Helm dependency that can be used for a refarch application. Our aim is to keep it as minimal as possible and avoid duplicating templates. Therefore, we propose using a module that iterates over a list.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@hupling hupling hupling left review comments

@devtobi devtobi devtobi left review comments

@ejcsid ejcsid ejcsid requested changes

Requested changes must be addressed to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Create Helm Chart Templates for RefArch Components
4 participants
@langehm @hupling @devtobi @ejcsid