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

Plugin SDK #7

Open
PI-Victor opened this issue Jul 10, 2024 · 3 comments
Open

Plugin SDK #7

PI-Victor opened this issue Jul 10, 2024 · 3 comments

Comments

@PI-Victor
Copy link
Member

PI-Victor commented Jul 10, 2024

Context

Instead of implementing the raw generated Guest trait from witbindgen, skyforge should offer its own plugin SDK.

Description

The plugin SDK should offer users the ability to communicate through a function hook system and interface with the rust CLI, seamlessly.
It should make plugins as easy to write as possible so that users can focus on the implementation details of the cloud provider and not have to worry about things like:

  • Interpreting starlark structures and functions (at all if possible)
  • Worrying about having to implement the raw wit_bindgen generated Guest trait. These details can be hidden under the hood.

Acceptance Criteria

This is an EPIC, and as such is hard to specifically point to an acceptance criteria since the initial interface still needs to be defined. However, we can outline a few key points.

  • Initially, add a structure to the SDK with a procedural macro that can generate implementations that hide the Guest trait implementation under the hood.
  • Define the interface of the plugin and its methods both for interpreting starlark code and for parsing and creating resources.
  • Users should not have to worry about starlark interpretation of their commands, these things should be generated by a proc macro
Copy link

linear bot commented Jul 10, 2024

CLO-62 [EPIC] Plugin SDK

@PI-Victor
Copy link
Member Author

/triage
/assing
/label Feature

@PI-Victor
Copy link
Member Author

/retitle Plugin SDK

@oscar-automaton oscar-automaton bot changed the title [EPIC] Plugin SDK Plugin SDK Jul 13, 2024
@PI-Victor PI-Victor linked a pull request Jul 28, 2024 that will close this issue
@PI-Victor PI-Victor removed a link to a pull request Jul 28, 2024
@PI-Victor PI-Victor removed the epic label Aug 3, 2024
@oscar-automaton oscar-automaton bot added the epic label Aug 3, 2024
@PI-Victor PI-Victor removed the epic label Aug 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

No branches or pull requests

1 participant