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

Ease Runtime Extension implementation by providing exported util packages #6720

Closed
sbueringer opened this issue Jun 24, 2022 · 4 comments · Fixed by #6753
Closed

Ease Runtime Extension implementation by providing exported util packages #6720

sbueringer opened this issue Jun 24, 2022 · 4 comments · Fixed by #6753
Assignees
Labels
kind/feature Categorizes issue or PR as related to a new feature.

Comments

@sbueringer
Copy link
Member

sbueringer commented Jun 24, 2022

Goal of this issue is to make it easier to implement RuntimeExtensions by exporting useful packages.

Note: We gathered some experience writing RuntimeExtensions by implementing a test extension for our e2e tests.

I would propose to:

  • move internal/runtime/catalog to exp/runtime/catalog
    • I think catalog is stable enough to be exported.
  • move test/extension/server to exp/runtime/server
    • While the server package is pretty new, I think we can still iterate on it given the API guarantees for the exp package.
    • By exporting the package now we can gather feedback from RuntimeExtension authors and evolve it over time.

By moving these packages it becomes a lot easier to implement RuntimeExtensions. In fact looking at our test extension it would be enough to implement a Runtime Extension for lifecycle hooks.

It should also help to implement RuntimeExtensions for topology mutation but I think we need a follow-up to:

  • export a package which makes it easy to work with variables
  • export a package (possibly the same) which helps folks to deal with the topology mutation hook requests/responses and generate patches. The basis for this can be: the variable package and lib.go from our test extension.

/kind feature

@k8s-ci-robot k8s-ci-robot added the kind/feature Categorizes issue or PR as related to a new feature. label Jun 24, 2022
@sbueringer
Copy link
Member Author

@fabriziopandini @chrischdi @ykakarap @killianmuldoon Opinions?

@fabriziopandini
Copy link
Member

I'm +1 because this will allow user feedback on those packages
The catalog is ~stable since first prototypes, Server we can iterate given experimental contract.

@killianmuldoon
Copy link
Contributor

+1 I think we should make the experimental contract very explicit, and after that try to offer as much functionality (in as few public methods) as possible. +1 to both catalog and the test extension.

@ykakarap
Copy link
Contributor

+1 to moving both the packages. Would simplify implementing an extension if we access to catalog and the server libraries.

I have some bandwidth and I am happy to help with the refactoring.

/assign

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/feature Categorizes issue or PR as related to a new feature.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants