Repository navigation
Support KRM in Kustomize plugin - TemplateTransformer #6
Description
Intro
Kustomize (the official tool to create K8s IaC) adopted the new Kubernetes declarative configurations known as KRM Functions. The new style is used as a unified way to interact with Kustomize plugins. There are 2 ways to use KRM in the plugins: Containerized KRM Functions and Exec KRM functions.
Not all Kustomize plugins adopted the new format; hence the goal of this task is to support the new method in existing plugins, namely, TemplateTransformer.
Acquired Skills
By doing this task, you will gain the following skills:
- Golang coding skills.
- Kustomize plugin ecosystem.
- Unerstanding of Kubernetes Resource Model (KRM).
The Challange
Support KRM in [TemplateTransformer](https://github.com/joshdk/template-transformer Kustomize plugin.
The Task
- Create an issue in TemplateTransformer to propose supporting KRM.
- Fork the TemplateTransformer repo and create a new branch to work on the task.
- Create a PR in the forked repo and assign me (@aabouzaid) as a reviewer.
Notes and Tips
- Get into KRM: Kustomize Enhancement with KRM Functions
- There are 2 libs to support KRM, kpt-functions-sdk/go/fn from Google and another kyaml/fn/framework from the Kustomize project. Please use the one from Kustomize. It makes it easy to write KRM functions.
- A good example of using
kyaml/fn/framework(the one from Kustomize) is kustomize-kubeconformvalidator.
Related Links
- TBA
Activity
ibrahimabdelkhaleq commentedon Jun 25, 2023
@aabouzaid I will handle it
hamza-m-masood commentedon Aug 9, 2024
@aabouzaid
Thank you for creating this task. I am happy to take this issue.
I am still understanding what KRM functions mean but I see it is still in alpha phase and there has not been much progress on developing this feature further for quite some time now. So does it still make sense to open an issue on the repo to implement KRM functions?
hamza-m-masood commentedon Aug 11, 2024
I have a good idea of what KRM functions are by reading these blog posts:
hamza-m-masood commentedon Aug 24, 2024
I am facing problems running this plugin on mac. There is even an open issue on this as well: joshdk/template-transformer#25
hamza-m-masood commentedon Aug 24, 2024
I just got it working on mac. I mentioned the steps in the issue.
Maybe I will open another PR to enhance the readme, so it's clear for other people on mac.