provisionersdk
packageThis package is not in the latest version of its module.
Details
Validgo.mod file
The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license
Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version
Modules with tagged versions give importers more predictable builds.
Stable version
When a project reaches major version v1 it is considered stable.
- Learn more about best practices
Repository
Links
Documentation¶
Index¶
- Constants
- func AgentScriptEnv() map[string]string
- func DirHasLockfile(dir string) (bool, error)
- func MemTransportPipe() (drpc.Conn, net.Listener)
- func MultiplexedConn(session *yamux.Session) drpc.Conn
- func ProvisionerJobLogsNotifyChannel(jobID uuid.UUID) string
- func Serve(ctx context.Context, server proto.DRPCProvisionerServer, options *ServeOptions) error
- func Tar(w io.Writer, directory string, limit int64) error
- func Untar(directory string, r io.Reader) error
- type ProvisionerJobLogsNotifyMessage
- type ServeOptions
Constants¶
const (// MaxMessageSize is the maximum payload size that can be// transported without error.MaxMessageSize = 4 << 20)
const (// TemplateArchiveLimit represents the maximum size of a template in bytes.TemplateArchiveLimit = 1 << 20)
Variables¶
This section is empty.
Functions¶
funcAgentScriptEnv¶
AgentScriptEnv returns a key-pair of scripts that are consumedby the Coder Terraform Provider. See:https://github.com/coder/terraform-provider-coder/blob/main/internal/provider/provider.go#L97
funcDirHasLockfile¶added inv0.25.0
funcMultiplexedConn¶added inv0.13.0
MultiplexedConn returns a multiplexed dRPC connection from a yamux session.
funcProvisionerJobLogsNotifyChannel¶added inv0.24.0
ProvisionerJobLogsNotifyChannel is the PostgreSQL NOTIFY channelto publish updates to job logs on.
funcServe¶
func Serve(ctxcontext.Context, serverproto.DRPCProvisionerServer, options *ServeOptions)error
Serve starts a dRPC connection for the provisioner and transport provided.
Types¶
typeProvisionerJobLogsNotifyMessage¶added inv0.24.0
type ProvisionerJobLogsNotifyMessage struct {CreatedAfterint64 `json:"created_after"`EndOfLogsbool `json:"end_of_logs,omitempty"`}
ProvisionerJobLogsNotifyMessage is the payload published onthe provisioner job logs notify channel.
typeServeOptions¶
type ServeOptions struct {// Conn specifies a custom transport to serve the dRPC connection.Listenernet.Listener}
ServeOptions are configurations to serve a provisioner.