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

How to integrate Cyphernetes in a Go project? (Karpor) #146

Closed
elliotxx opened this issue Nov 19, 2024 · 7 comments
Closed

How to integrate Cyphernetes in a Go project? (Karpor) #146

elliotxx opened this issue Nov 19, 2024 · 7 comments

Comments

@elliotxx
Copy link

We're interested in integrating Cyphernetes as a query engine in our Kubernetes visualization tool Karpor (KusionStack/karpor#644).

  • Do you provide any Go SDK or client library for integration?
  • Is there any integration documentation or examples we could reference?
  • What would be your suggestions to get started with this integration?

Thanks for your help!

@AvitalTamir
Copy link
Owner

AvitalTamir commented Nov 19, 2024

Hey @elliotxx thanks for opening the issue - I'm super excited about having Karpor support the Cyphernetes language and will work hard to push this effort forward!

The Cyphernetes monorepo contains a package called parser (which should probably be renamed to core) - this package contains the language parser, the relationship engine and the Kubernetes query engine.
The three Cyphernetes programs currently in existence (the CLI, web client and operator framework) all consume this package.
EDIT: It is currently not documented at all how to use this package. The CLI, web and operator apps are the only place to get any code reference. I'm prioritizing to improve this in the short term.

I think there's some work cut out for us here though - I think Karpor will be the first time integrating this into an existing program that provides its own K8s client.

I will reach out to you directly and let's try to set up a call after I get back to the related code and get an effort estimate.

@elliotxx
Copy link
Author

Thank you for your awesome support! Let me get familiar with Cyphernetes first. Because I am still working on other iterations, it may not be so fast. Let's keep in touch! 🔥

@AvitalTamir
Copy link
Owner

AvitalTamir commented Nov 19, 2024

Excellent, in the meantime I'll familiarize myself with the Karpor codebase and wrap my head around the effort

@AvitalTamir
Copy link
Owner

Closing this, an effort to provide a clean interface to the language engine has been merged, a migration guide has been added and we'll continue the conversation re. Karpor in other channels 💪

@elliotxx
Copy link
Author

@AvitalTamir Bro, just shipped Karpor on PH - mind dropping by? 🙌 And, I think we can collaborate on PH in the future!
https://www.producthunt.com/posts/karpor

@AvitalTamir
Copy link
Owner

Definitely, going to support you guys there now :)

@elliotxx
Copy link
Author

@AvitalTamir Thank you, brother. Please feel free to contact me if you need anything

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants