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

Epic: Golang SDK for building functions #1642

Open
mengqiy opened this issue Mar 30, 2021 · 4 comments
Open

Epic: Golang SDK for building functions #1642

mengqiy opened this issue Mar 30, 2021 · 4 comments
Labels
area/fn-sdk Typescript SDK enhancement New feature or request size/XXL 16 day triaged Issue has been triaged by adding an `area/` label
Milestone

Comments

@mengqiy
Copy link
Contributor

mengqiy commented Mar 30, 2021

Forking from GoogleContainerTools/kpt-functions-catalog#196 (comment)

We currently have a SDK for TS. We should have a similar SDK in golang.
IMO it may look like kubebuilder. It should provide

  • [WIP] Standard Go pkg for KRM function Design golang library for authoring KRM fn #2568
  • scaffolds source files (including tests). User only need to fill in the funcion logic.
  • a Dockerfile
  • a usage doc template
  • scaffold a Makefile that manages the build lifecycle including build binary, run tests, build and push images and etc.
  • utilities to convert the usage markdown file to code. We can either pre-generate before compiling or convert it at runtime.
@mengqiy mengqiy added enhancement New feature or request area/fn-sdk Typescript SDK triaged Issue has been triaged by adding an `area/` label labels Mar 30, 2021
@mikebz
Copy link
Contributor

mikebz commented Mar 31, 2021

@mengqiy any guess as to the size of this effort?

@mengqiy mengqiy added the size/XXL 16 day label Mar 31, 2021
@mengqiy
Copy link
Contributor Author

mengqiy commented Mar 31, 2021

This task needs to be designed first and then implemented. We may want to break this task to smaller ones and we can use this one as an umbrella issue.

@mengqiy mengqiy added this to the Q3-2021 milestone Aug 25, 2021
@mengqiy mengqiy self-assigned this Aug 25, 2021
@mengqiy mengqiy modified the milestones: Q3-2021, Q4-2021 Sep 22, 2021
@mengqiy mengqiy changed the title Golang SDK for building functions Epic: Golang SDK for building functions Oct 20, 2021
@mengqiy
Copy link
Contributor Author

mengqiy commented Oct 20, 2021

In Q4, we are focusing on improving the library (kyaml).

@khrisrichardson
Copy link

khrisrichardson commented Jan 13, 2022

IMO it may look like kubebuilder

@mengqiy FWIW, I love this idea so that the function code can be decorated to produce a CRD validation schema among other useful side-effects ala controller-tools

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/fn-sdk Typescript SDK enhancement New feature or request size/XXL 16 day triaged Issue has been triaged by adding an `area/` label
Projects
None yet
Development

No branches or pull requests

3 participants