https://github.com/brandonc/tfpgen

Experimental, exploratory, do not use
https://github.com/brandonc/tfpgen

Last synced: 3 months ago
JSON representation

Experimental, exploratory, do not use

• Host: GitHub
• URL: https://github.com/brandonc/tfpgen
• Owner: brandonc
• Created: 2022-01-22T16:53:10.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2023-02-12T14:41:06.000Z (over 2 years ago)
• Last Synced: 2024-12-28T16:26:35.638Z (5 months ago)
• Language: Go
• Homepage: https://brandoncroft.com/notes/tfpgen
• Size: 180 KB
• Stars: 1
• Watchers: 6
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# tfpgen

An experimental OpenAPI → Terraform Provider generator that does not yet function. The goal is to allow developers to incrementally generate and maintain their own simple [Terraform Provider](https://www.terraform.io/registry/providers) using an [OpenAPI 3 specification](https://en.wikipedia.org/wiki/OpenAPI_Specification).

- [x] Examine an OpenAPI spec, identify RESTful resource groups `tfpgen examine spec.yaml`

- [x] Generate a config file for each discovered resource/data source `tfpgen init spec.yaml`

- [ ] Using a combination of the spec and config, generate the provider `tfpgen generate`

  - [ ] Generate [Terraform plugin framework](https://github.com/hashicorp/terraform-plugin-framework) code for each resource/datasource

  - [ ] Generate http client code and caller code for each resource/datasource

  - [x] Generate Terraform framework provider code to describe resource schema

  - [ ] Generate acceptance tests

## Other Solutions

- [terraform-provider-openapi](https://github.com/dikhan/terraform-provider-openapi)

A single provider that configures itself _at runtime_ given an OpenAPI specification. This is incredibly cool. However, in the author's opinion, given that the underlying state AND the specification can drift away from the stored Terraform state, operating this provider can give unpredictable results.

- [terraform-provider-restapi](https://github.com/Mastercard/terraform-provider-restapi)

Manage a RESTful resource as a terraform resource. Another neat approach, but it requires that you define the API as Terraform config. The state of the object is completely dependent on the raw response of the endpoint.

## Usage

`tfpgen [--version] [--help]  []`

### Available commands are:

| command  | description                                                                                                     |

|----------|-----------------------------------------------------------------------------------------------------------------|

| examine  | Examine an openapi 3 specification and display a list of possible data sources and resources                    |

| init     | Create an initial configuration based on a spec. This file is meant to be edited in order to compose a provider |

| generate | Generate Terraform provider using the configuration                                                             |

## Try it:

`go run main.go examine examples/openapi3/petstore.yaml`