automatic generation of terraform provider

[Jean-Baptiste-Lasselle]

I wan to try and setup a full tool chain which generates the terraform provider, based on the OpenAPI OAS v3.0:

• based on informations in README.md of https://github.com/NaverCloudPlatform/terraform-plugin-codegen-openapi
• with the following requiements:
  • I need the Circle CI pipeline that I designed in the present repository: and the Circle CI pipeline has an automatic way to upgrade version of golang, version of all tools used to run commands in the pipline, eg golangci-lint goreleaser
  • the generated code is submitter via an automatically created Pull Request:
  • In that pull request, the Circle CI pipeline will execute tests: build a snapshot of the provider, and runnign the example, against a deployed version of the new release version of the REST API, also running the basic unit tests of the golang code.
  • the automated code generation is triggered by a new API release event

Well we'll see what we can do there.

Questions to answer:

• Should such a code generation process be used only to initiate a source code ?
• Should such a code generation process be used only when a minor version change happens in the REST API release? (not for minor updates)?
• Should the Circle CI pipeline implementing the code generation be triggered only when we create pull request on a git branch which name matches a given regex, eg regenerate/for/api/<api release version here>/* ?

[Jean-Baptiste-Lasselle]

Eventually, I would like to also automate code generation of :

• the golang client / sdk
• the CLI associated to the golang client
• together with the terraform provider.
• and of the documentation for the whoe of the above three assets

An experiments I woud like to conduct:

• generating a terraform provider for vmware vcenter vsphere :
  • https://williamlam.com/2023/11/is-there-a-vsphere-rest-api-for.html
  • https://developer.broadcom.com/xapis/vsphere-web-services-api/8.0U2/
  • all REST APIs references: https://developer.broadcom.com/xapis/vsphere-automation-api/latest/
  • https://github.com/vmware/govmomi
  • Forthe moment, I found nowhere, any OpenAPI specs published for each version of any vmware REST API, except perrhaps:
  • https://docs.vmware.com/fr/vSphere-Replication/8.7/com.vmware.vsphere.replication-admin.doc/GUID-6CCE02B9-72FE-4AD6-9C9E-9CBC01D02515.html
• generating a terraform provider for Oracle Cloud, based on the OPEN API Json schema specs published by oracle
• generating a terraform provider for anycloud provider who publishes the Open API specs (json schema) of its REST API