https://github.com/lukekaalim/terraform-plugin-node-sdk

This project is an npm package that provides tools for building Terraform Plugins
https://github.com/lukekaalim/terraform-plugin-node-sdk

grpc-server nodejs sdk terraform terraform-plugins

Last synced: 7 days ago
JSON representation

This project is an npm package that provides tools for building Terraform Plugins

• Host: GitHub
• URL: https://github.com/lukekaalim/terraform-plugin-node-sdk
• Owner: lukekaalim
• Created: 2020-03-04T08:34:48.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2022-12-12T02:13:58.000Z (almost 2 years ago)
• Last Synced: 2024-10-14T03:21:37.755Z (24 days ago)
• Topics: grpc-server, nodejs, sdk, terraform, terraform-plugins
• Language: JavaScript
• Homepage: https://lukekaalim.github.io/terraform-plugin-node-SDK
• Size: 427 KB
• Stars: 6
• Watchers: 2
• Forks: 1
• Open Issues: 22
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
---

title: Home

layout: default

nav_order: 1

permalink: ./

---

# ![Terraform Plugin Node SDK Logo](./assets/logo.png "Node Terraform")

This project is collection of npm packages that provides tools for building [Terraform](https://www.terraform.io/) Plugins.

Terraform plugins can be used to leverage and extend terraform capabilities, allowing new providers and resource types.

> ⚠️ This is a non-serious implementation, and has 0% test coverage. Use at your own risk.

## Getting Started

Take a look at our [Getting Started Guide](./docs/getting-started), which will run you though project setup. 

Following that, try the [Cat API Guide](./docs/guides/CatSDK), which runs through a fictional API and shows off some of the functions of the terraform plugin sdk.

## Packages

 - [`@lukekaalim/terraform-plugin`](./terraform-plugin/README)

 - [`@lukekaalim/terraform-service`](./terraform-service/README)

 - [`@lukekaalim/hashicorp-go-plugin`](./hashicorp-go-plugin/README)

 - [`@lukekaalim/terraform-cli`](./terraform-cli/README)

## What's a Plugin?

All of terraform's ability to interact with API's comes from [_plugins_](https://www.terraform.io/docs/plugins/index.html). Terraform manages the configuration, orchestration, and dependency resolution on the resources you create, but it's a terraform plugin that allows it to interact with the world.

A plugin composes of an _executable file_ that perform a hashicorp/go-plugin handshake and then opens up a GRPC server.

That GRPC server then implements the terraform-plugin prototypes, providing a Schema (which is a declaration of the provider and all resources that provider manages) and some functions that terraform calls to create or apply terraform plans.

The Terraform Plugin SDK allows you to create plugins declaratively, allowing you create a plugin without needing to perform all the boilerplate work.

## Why create Plugins?

Terraform has a wealth of plugins available to it already created that allow you to manage a vast amount of resources in an interconnected graph, but it doesn't have all of them.

When using terraform, you may wish to:

- Create resources that talk to a proprietary or internal API

- Create resource for an API that doesn't have a provider yet

- Manage a resource for an existing provider that doesn't provide certain functionality

- Disagree with the implementation of an API and want to give yourself greater flexibility

- Model existing build scripts as declarative structures