tf5muxserver

Documentation

Overview

Package tf5muxserver combines multiple provider servers that implement protocol version 5, into a single server.

Supported protocol version 5 provider servers include any which implement the tfprotov5.ProviderServer (https://pkg.go.dev/github.com/hashicorp/terraform-plugin-go/tfprotov5#ProviderServer) interface, such as:

• https://pkg.go.dev/github.com/hashicorp/terraform-plugin-go/tfprotov5/tf5server
• https://pkg.go.dev/github.com/hashicorp/terraform-plugin-mux/tf6to5server
• https://pkg.go.dev/github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema

Refer to the NewMuxServer() function for creating a combined server.

Index

• func NewMuxServer(ctx context.Context, servers ...func() tfprotov5.ProviderServer) (muxServer, error)

Examples

• NewMuxServer

Functions

func NewMuxServer

func NewMuxServer(ctx context.Context, servers ...func() tfprotov5.ProviderServer) (muxServer, error)

NewMuxServer returns a muxed server that will route gRPC requests between tfprotov5.ProviderServers specified. The GetProviderSchema method of each is called to verify that the overall muxed server is compatible by ensuring:

• All provider schemas exactly match
• All provider meta schemas exactly match
• Only one provider implements each managed resource
• Only one provider implements each data source

The various schemas are cached and used to respond to the GetProviderSchema method of the muxed server.

Example

package main

import (
	"context"
	"log"

	"github.com/hashicorp/terraform-plugin-go/tfprotov5"
	"github.com/hashicorp/terraform-plugin-go/tfprotov5/tf5server"
	"github.com/hashicorp/terraform-plugin-mux/tf5muxserver"
)

func main() {
	ctx := context.Background()
	providers := []func() tfprotov5.ProviderServer{
		// Example terraform-plugin-sdk ProviderServer function
		// sdkprovider.New("version")().GRPCProvider,
		//
		// Example terraform-plugin-go ProviderServer function
		// goprovider.Provider(),
	}

	// requests will be routed to whichever server advertises support for
	// them in the GetSchema response. Only one server may advertise
	// support for any given resource, data source, or the provider or
	// provider_meta schemas. An error will be returned if more than one
	// server claims support.
	muxServer, err := tf5muxserver.NewMuxServer(ctx, providers...)

	if err != nil {
		log.Fatalln(err.Error())
	}

	// Use the result to start a muxed provider
	err = tf5server.Serve("registry.terraform.io/namespace/example", muxServer.ProviderServer)

	if err != nil {
		log.Fatalln(err.Error())
	}
}