options

Documentation

Overview

Package options contains the options (and default values) used to configure DNS and Certificate management

Index

• Variables
• type Option
  • func WithLogger(logger logging.Logger) Option
  • func WithOptions(options Options) Option
  • func WithStorage(storage storage.Storage) Option
  • func WithTrustedNameservers(trustedNameservers []string) Option
• type Options
  • func LoadOptions(options ...Option) *Options

Variables

var DefaultLogger logging.Logger

DefaultLogger is the default Logger

var DefaultStorage storage.Storage

DefaultStorage is the default Storage

var DefaultTrustedNameServers = []string{
	"8.8.8.8:53",
	"8.8.4.4:53",
	"1.1.1.1:53",
	"1.0.0.1:53",
}

DefaultTrustedNameServers is the default TrustedNameServers

Types

type Option

type Option func(opts *Options)

Option is used to generate options internally

func WithLogger

func WithLogger(logger logging.Logger) Option

WithLogger sets the logger

func WithOptions

func WithOptions(options Options) Option

WithOptions allows users to pass in an Options struct

func WithStorage

func WithStorage(storage storage.Storage) Option

WithStorage sets the storage

func WithTrustedNameservers

func WithTrustedNameservers(trustedNameservers []string) Option

WithTrustedNameservers sets the TrustedNameservers

type Options

type Options struct {
	Logger             logging.Logger
	Storage            storage.Storage
	TrustedNameServers []string
}

Options is used to provide configuration options.

Default Values:

	options := Options {
		Logger: DefaultLogger,
     Storage: DefaultStorage,
	    TrustedNameServers: DefaultTrustedNameServers,
	}

func LoadOptions

func LoadOptions(options ...Option) *Options

LoadOptions takes a variadic number of Option variables and returns a *Options struct that contains default sanitized values.