is there a easy way to convert swagger / open api spec into pulumi provider?

@billowy-army-68599 i had a quick look, do you have a readme on how to use that project? README is not clear on how to use it

i don’t i’m afraid, @clever-sunset-76585 wrote it, maybe he can help

@gorgeous-microphone-34056 there are three providers that I have generated so far with that. Tailscale is the latest one: https://github.com/cloudy-sky-software/pulumi-tailscale-native/blob/main/provider/pkg/gen/schema.go#L144-L155

im trying to see steps required for converting a swagger spec into provider

like a usage guide tbh

The lines I linked above is literally how you would use the library. That's the best I've got so far. Other than that, the instructions in the README for

pulschema

tell you how to prepare the OpenAPI spec for a successful conversion. You can also look at the tests in the providers I've generated thus far: https://github.com/search?q=topic%3Apulumi-provider+org%3Acloudy-sky-software+fork%3Atrue&type=repositories

not a golang developer 🙂 so trying to wrap my head around this. i will take a look

Ah gotcha. Some familiarity around how Pulumi providers are generated is also necessary to be honest and the best place to start for that is Pulumi's own https://github.com/pulumi/pulumi-provider-boilerplate which teaches you how to structure a provider. Note that converting the API spec to a Pulumi schema spec is only half the work. The other half is to model the HTTP requests necessary to make it work. As you'll notice in the providers that I generated, I use my own private library (

pulumi-provider-framework

) that does the HTTP offloading. When it comes to that you'll be on your own but since it's just HTTP requests you can use whatever strategy you'd like and shouldn't be blocked by not having access to that private lib.

i will try to get familar with these repos

Yeah honestly starting to understand how a Pulumi provider is built is the first thing I would recommend (the Pulumi boilerplate repo) before even attempting to convert anything because that'll teach you the problem

pulschema

is trying to solve.

gotcha that make sense

pulschema

generates the

schema.json

file that you'll see referenced in the Pulumi provider boilerplate repo. If

pulschema

didn't exist, you'd have to manually author that JSON file which is what Pulumi uses to generate the language SDKs and docs.

make generate_schema

seems to be generating schema.json file which step are we using

pulschema

That

make

target calls into this

case

statement for the

gen

binary: https://github.com/cloudy-sky-software/pulumi-tailscale-native/blob/main/provider/cmd/pulumi-gen-tailscale-native/main.go#L89

got it, thank you

Sure, you can try that. That should work since you'd only be generating the SDKs. But like I said before,

pulumi-provider-framework

is private, so you'll encounter issues if you try to build the provider binary since it'll look for that repo.

gotcha, can you share that as zip / binary as you mentioned before?

gotcha, can you share that as zip / binary as you mentioned before?

Oh I said I would give a ZIP of the private template, not the

pulumi-provider-framework

🙂 sorry for not being clear. I'd be happy to DM the template to you.

gotcha

Posting here from our private conversation for posterity: I suggest starting with the Pulumi boilerplate repo and understand that first before tackling

pulschema

. It's easier to bring

pulschema

into their template due to the private module

pulumi-provider-framework

dependency that I have with my template.

pulumi-provider-framework

is an HTTP client. As long as you have a Pulumi

schema.json

generating successfully, you can build your own HTTP client library that interacts with the REST API as shown in Pulumi's own examples. At some point in the future, I might decide to make

pulumi-provider-framework

public but I haven't had the time to think about it and not certain about it just yet.