commands

Documentation

Index

• func CreateDomains(args CreateDomainsArgs) error
• func ExecuteDSL(args ExecuteDSLArgs) (*models.DNSConfig, error)
• func GetCerts(args GetCertsArgs) error
• func GetDNSConfig(args GetDNSConfigArgs) (*models.DNSConfig, error)
• func GetZone(args GetZoneArgs) error
• func InitializeProviders(credsFile string, cfg *models.DNSConfig, notifyFlag bool) (notify notifications.Notifier, err error)
• func Preview(args PreviewArgs) error
• func PrintIR(args PrintIRArgs) error
• func PrintJSON(args PrintJSONArgs, config *models.DNSConfig) (err error)
• func PrintValidationErrors(errs []error) (fatal bool)
• func Push(args PushArgs) error
• func Run(v string) int
• type CreateDomainsArgs
• type ExecuteDSLArgs
• type FilterArgs
• type GetCertsArgs
• type GetCredentialsArgs
• type GetDNSConfigArgs
• type GetZoneArgs
• type PreviewArgs
• type PrintIRArgs
• type PrintJSONArgs
• type PushArgs

Functions

func CreateDomains

func CreateDomains(args CreateDomainsArgs) error

CreateDomains contains all data/flags needed to run create-domains, independently of CLI.

func ExecuteDSL

func ExecuteDSL(args ExecuteDSLArgs) (*models.DNSConfig, error)

ExecuteDSL executes the dnsconfig.js contents.

func GetCerts

func GetCerts(args GetCertsArgs) error

GetCerts implements the get-certs command.

func GetDNSConfig

func GetDNSConfig(args GetDNSConfigArgs) (*models.DNSConfig, error)

GetDNSConfig reads the json-formatted IR file. Or executes javascript. All depending on flags provided.

func GetZone

func GetZone(args GetZoneArgs) error

GetZone contains all data/flags needed to run get-zones, independently of CLI.

func InitializeProviders

func InitializeProviders(credsFile string, cfg *models.DNSConfig, notifyFlag bool) (notify notifications.Notifier, err error)

InitializeProviders takes a creds file path and a DNSConfig object. Creates all providers with the proper types, and returns them. nonDefaultProviders is a list of providers that should not be run unless explicitly asked for by flags.

func Preview

func Preview(args PreviewArgs) error

Preview implements the preview subcommand.

func PrintIR

func PrintIR(args PrintIRArgs) error

PrintIR implements the print-ir subcommand.

func PrintJSON

func PrintJSON(args PrintJSONArgs, config *models.DNSConfig) (err error)

PrintJSON outputs/prettyprints the IR data.

func PrintValidationErrors

func PrintValidationErrors(errs []error) (fatal bool)

PrintValidationErrors formats and prints the validation errors and warnings.

func Push

func Push(args PushArgs) error

Push implements the push subcommand.

func Run

func Run(v string) int

Run will execute the CLI

Types

type CreateDomainsArgs

type CreateDomainsArgs struct {
	GetDNSConfigArgs
	GetCredentialsArgs
}

CreateDomainsArgs args required for the create-domain subcommand.

type ExecuteDSLArgs

type ExecuteDSLArgs struct {
	JSFile   string
	JSONFile string
	DevMode  bool
}

ExecuteDSLArgs are used anytime we need to read and execute dnscontrol DSL

type FilterArgs

type FilterArgs struct {
	Providers string
	Domains   string
}

FilterArgs encapsulates the flags/args for sub-commands that can filter by provider or domain.

type GetCertsArgs

type GetCertsArgs struct {
	GetDNSConfigArgs
	GetCredentialsArgs

	ACMEServer     string
	CertsFile      string
	RenewUnderDays int
	CertDirectory  string
	Email          string
	AgreeTOS       bool
	Verbose        bool
	Vault          bool
	VaultPath      string
	Only           string

	Notify bool

	IgnoredProviders string
}

GetCertsArgs stores the flags and arguments common to cert commands

type GetCredentialsArgs

type GetCredentialsArgs struct {
	CredsFile string
}

GetCredentialsArgs encapsulates the flags/args for sub-commands that use the creds.json file.

type GetDNSConfigArgs

type GetDNSConfigArgs struct {
	ExecuteDSLArgs
	JSONFile string
}

GetDNSConfigArgs contains what we need to get a valid dns config. Could come from parsing js, or from stored json

type GetZoneArgs

type GetZoneArgs struct {
	GetCredentialsArgs          // Args related to creds.json
	CredName           string   // key in creds.json
	ProviderName       string   // provider name: BIND, GANDI_V5, etc or "-"
	ZoneNames          []string // The zones to get
	OutputFormat       string   // Output format
	OutputFile         string   // Filename to send output ("" means stdout)
	DefaultTTL         int      // default TTL for providers where it is unknown
}

GetZoneArgs args required for the create-domain subcommand.

type PreviewArgs

type PreviewArgs struct {
	GetDNSConfigArgs
	GetCredentialsArgs
	FilterArgs
	Notify      bool
	WarnChanges bool
}

PreviewArgs contains all data/flags needed to run preview, independently of CLI

type PrintIRArgs

type PrintIRArgs struct {
	GetDNSConfigArgs
	PrintJSONArgs
	Raw bool
}

PrintIRArgs encapsulates the flags/arguments for the print-ir command.

type PrintJSONArgs

type PrintJSONArgs struct {
	Pretty bool
	Output string
}

PrintJSONArgs are used anytime a command may print some json

type PushArgs

type PushArgs struct {
	PreviewArgs
	Interactive bool
}

PushArgs contains all data/flags needed to run push, independently of CLI