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.

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

RFC | Helm Import #1271

Closed
10 of 11 tasks
vinayak-kukreja opened this issue Apr 5, 2023 · 2 comments · Fixed by #1272
Closed
10 of 11 tasks

RFC | Helm Import #1271

vinayak-kukreja opened this issue Apr 5, 2023 · 2 comments · Fixed by #1272
Assignees
Labels
rfc/implementing RFC is being implemented

Comments

@vinayak-kukreja
Copy link
Contributor

vinayak-kukreja commented Apr 5, 2023

Description

Currently cdk8s supports adding helm charts as construct with the helm construct. This approach does not take into consideration data types for the values that the helm chart can accept.

This RFC is proposing to enable users to import a helm chart as a construct using cdk8s import. This would auto generate a construct for the user and if a values.schema.json is present in the helm chart, then the values properties would have appropriate types associated with them.

Roles

Role User
Proposed by @vinayak-kukreja
Author(s) @vinayak-kukreja
API Bar Raiser @iliapolo
Stakeholders @cdk8s-team/cdk8s-team

See RFC Process for details

Workflow

  • Tracking issue created (label: rfc/proposed)
  • API bar raiser assigned (ping us at #cdk8s if needed)
  • Kick off meeting
  • RFC pull request submitted (label: rfc/review)
  • Community reach out (via Slack and/or Twitter)
  • API signed-off (label rfc/api-approved applied to pull request)
  • Final comments period (label: rfc/final-comments-period)
  • Approved and merged (label: rfc/approved)
  • Execution plan submitted (label: rfc/planning)
  • Plan approved and merged (label: rfc/implementing)
  • Implementation complete (label: rfc/done)

Author is responsible to progress the RFC according to this checklist, and
apply the relevant labels to this issue so that the RFC table in README gets
updated.

@vinayak-kukreja vinayak-kukreja added the rfc/proposed RFC proposed label Apr 5, 2023
@udaypant udaypant linked a pull request May 24, 2023 that will close this issue
@yuriy-yarosh
Copy link

I've made a basic helm charts import with codegen over imported k8s structs, using prerendered helm template charts, for golang. The issue I've faced is that it required a stacked codegen to reduce the boilerplate for golang specifically. I could contribute the respective JSII bindings as well, but the user still would need to provide a values.yaml for the helm template somewhere.

@iliapolo
Copy link
Member

@yuriy-yarosh the values will still be provided as normal. But instead of providing it to a generic Helm construct, they will provide it to a specific Airflow construct (for example), where the values dictionary will now be typed.

Im not sure I understand what you mean by stacked codegen, do you have an example to show?

@iliapolo iliapolo added rfc/implementing RFC is being implemented and removed rfc/proposed RFC proposed labels Aug 21, 2023
@mergify mergify bot closed this as completed in #1272 Aug 21, 2023
mergify bot pushed a commit that referenced this issue Aug 21, 2023
@iliapolo iliapolo reopened this Aug 21, 2023
mergify bot pushed a commit that referenced this issue Oct 5, 2023
Adding docs for helm import feature.

Tracking Issue: #1271

Needs cdk8s-team/cdk8s-cli#1202
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
rfc/implementing RFC is being implemented
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants