dnsplugin

Documentation

Overview

Auto-generated file. Do not edit.

Index

• Constants
• Variables
• func Serve()
• type DnsPlugin
  • func (p *DnsPlugin) GRPCClient(ctx context.Context, broker *plugin.GRPCBroker, c *grpc.ClientConn) (interface{}, error)
  • func (p *DnsPlugin) GRPCServer(broker *plugin.GRPCBroker, s *grpc.Server) error
• type DnsProviderClient
  • func (m *DnsProviderClient) CleanUp(domain, token, keyAuth string) error
  • func (m *DnsProviderClient) Configure(providerName string, config map[string]string, recursiveNameservers []string) error
  • func (m *DnsProviderClient) IsSequential() (time.Duration, bool)
  • func (m *DnsProviderClient) Present(domain, token, keyAuth string) error
  • func (m *DnsProviderClient) Timeout() (time.Duration, time.Duration)
• type DnsProviderServer
  • func (m *DnsProviderServer) CleanUp(ctx context.Context, req *dnspluginproto.CleanUpRequest) (*dnspluginproto.CleanUpResponse, error)
  • func (s *DnsProviderServer) Configure(ctx context.Context, req *dnspluginproto.ConfigureRequest) (*dnspluginproto.ConfigureResponse, error)
  • func (m *DnsProviderServer) IsSequential(ctx context.Context, req *dnspluginproto.IsSequentialRequest) (*dnspluginproto.IsSequentialResponse, error)
  • func (m *DnsProviderServer) Present(ctx context.Context, req *dnspluginproto.PresentRequest) (*dnspluginproto.PresentResponse, error)
  • func (m *DnsProviderServer) Timeout(ctx context.Context, req *dnspluginproto.TimeoutRequest) (*dnspluginproto.TimeoutResponse, error)
• type NewClientResult
  • func NewClient(providerName string, config map[string]string, recursiveNameservers []string) (NewClientResult, error)

Constants

const (
	ProtocolVersion  = 1
	MagicCookieKey   = "TERRAFORM_PROVIDER_ACME_MAGIC_COOKIE_KEY"
	MagicCookieValue = "990EF127-D8AA-43D3-9196-9493C2D6C475"
	PluginName       = "dnsplugin"
	PluginArg        = "-dnsplugin"
)

Variables

var Handshake = plugin.HandshakeConfig{
	ProtocolVersion:  ProtocolVersion,
	MagicCookieKey:   MagicCookieKey,
	MagicCookieValue: MagicCookieValue,
}

Functions

func Serve

func Serve()

Serve serves the DNS plugin. This function does not retun and will cause the process to exit after the plugin is finished running.

Types

type DnsPlugin

type DnsPlugin struct {
	plugin.Plugin
}

DnsPlugin the gRPC plugin for serving the DNS plugin that has been set.

func (*DnsPlugin) GRPCClient

func (p *DnsPlugin) GRPCClient(ctx context.Context, broker *plugin.GRPCBroker, c *grpc.ClientConn) (interface{}, error)

func (*DnsPlugin) GRPCServer

func (p *DnsPlugin) GRPCServer(broker *plugin.GRPCBroker, s *grpc.Server) error

type DnsProviderClient

type DnsProviderClient struct {
	// contains filtered or unexported fields
}

func (*DnsProviderClient) CleanUp

func (m *DnsProviderClient) CleanUp(domain, token, keyAuth string) error

func (*DnsProviderClient) Configure

func (m *DnsProviderClient) Configure(providerName string, config map[string]string, recursiveNameservers []string) error

func (*DnsProviderClient) IsSequential

func (m *DnsProviderClient) IsSequential() (time.Duration, bool)

func (*DnsProviderClient) Present

func (m *DnsProviderClient) Present(domain, token, keyAuth string) error

func (*DnsProviderClient) Timeout

func (m *DnsProviderClient) Timeout() (time.Duration, time.Duration)

type DnsProviderServer

type DnsProviderServer struct {
	dnspluginproto.UnimplementedDNSProviderServiceServer
	// contains filtered or unexported fields
}

func (*DnsProviderServer) CleanUp

func (m *DnsProviderServer) CleanUp(ctx context.Context, req *dnspluginproto.CleanUpRequest) (*dnspluginproto.CleanUpResponse, error)

func (*DnsProviderServer) Configure

func (s *DnsProviderServer) Configure(ctx context.Context, req *dnspluginproto.ConfigureRequest) (*dnspluginproto.ConfigureResponse, error)

func (*DnsProviderServer) IsSequential

func (m *DnsProviderServer) IsSequential(ctx context.Context, req *dnspluginproto.IsSequentialRequest) (*dnspluginproto.IsSequentialResponse, error)

func (*DnsProviderServer) Present

func (m *DnsProviderServer) Present(ctx context.Context, req *dnspluginproto.PresentRequest) (*dnspluginproto.PresentResponse, error)

func (*DnsProviderServer) Timeout

func (m *DnsProviderServer) Timeout(ctx context.Context, req *dnspluginproto.TimeoutRequest) (*dnspluginproto.TimeoutResponse, error)

type NewClientResult

type NewClientResult struct {
	Provider           challenge.ProviderTimeout
	Closer             func()
	IsSequential       bool
	SequentialInterval time.Duration
}

func NewClient

func NewClient(
	providerName string,
	config map[string]string,
	recursiveNameservers []string,
) (NewClientResult, error)

NewClient creates a new DNS provider instance by dispatching to itself via go-plugin. The client for the new provider is returned, along with a closer function that should be called when done to shut down the plugin.

The plugin is initialized with the settings passed in:

• The environment is set with the config map.
• If supplied, the global recursive nameservers are also set (via the dns01 package - some providers use these facilities).