tf-provider 0.2.2

Plugin framework for Terraform and ToFu
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56

syntax = "proto3";
package plugin;
option go_package = "plugin";
// https://github.com/hashicorp/go-plugin/blob/master/internal/plugin/grpc_broker.proto
message ConnInfo {
    uint32 service_id = 1;
    string network = 2;
    string address = 3;
    message Knock {
        bool knock = 1;
        bool ack = 2;
        string error = 3;
    }
    Knock knock = 4;
}

service GRPCBroker {
    rpc StartStream(stream ConnInfo) returns (stream ConnInfo);
}

// https://github.com/hashicorp/go-plugin/blob/master/internal/plugin/grpc_controller.proto
message Empty {
}

// The GRPCController is responsible for telling the plugin server to shutdown.
service GRPCController {
    rpc Shutdown(Empty) returns (Empty);
}

// https://github.com/hashicorp/go-plugin/blob/master/internal/plugin/grpc_stdio.proto
import "google/protobuf/empty.proto";

// GRPCStdio is a service that is automatically run by the plugin process
// to stream any stdout/err data so that it can be mirrored on the plugin
// host side.
service GRPCStdio {
  // StreamStdio returns a stream that contains all the stdout/stderr.
  // This RPC endpoint must only be called ONCE. Once stdio data is consumed
  // it is not sent again.
  //
  // Callers should connect early to prevent blocking on the plugin process.
  rpc StreamStdio(google.protobuf.Empty) returns (stream StdioData);
}

// StdioData is a single chunk of stdout or stderr data that is streamed
// from GRPCStdio.
message StdioData {
  enum Channel {
    INVALID = 0;
    STDOUT = 1;
    STDERR = 2;
  }

  Channel channel = 1;
  bytes data = 2;
}