providers

Documentation

Index

• func CreateDsps(d *models.DNSConfig, providerConfigs map[string]map[string]string) (map[string]DNSServiceProvider, error)
• func CreateRegistrars(d *models.DNSConfig, providerConfigs map[string]map[string]string) (map[string]Registrar, error)
• func RegisterDomainServiceProviderType(name string, init DspInitializer)
• func RegisterRegistrarType(name string, init RegistrarInitializer)
• type DNSServiceProvider
• type DomainCreator
• type DspInitializer
• type None
  • func (n None) GetDomainCorrections(dc *models.DomainConfig) ([]*models.Correction, error)
  • func (n None) GetNameservers(string) ([]*models.Nameserver, error)
  • func (n None) GetRegistrarCorrections(dc *models.DomainConfig) ([]*models.Correction, error)
• type Registrar
• type RegistrarInitializer

Functions

func CreateDsps

func CreateDsps(d *models.DNSConfig, providerConfigs map[string]map[string]string) (map[string]DNSServiceProvider, error)

func CreateRegistrars

func CreateRegistrars(d *models.DNSConfig, providerConfigs map[string]map[string]string) (map[string]Registrar, error)

CreateRegistrars will load all registrars from the dns config, and create instances of the correct type using data from the provider config to load relevant keys and options.

func RegisterDomainServiceProviderType

func RegisterDomainServiceProviderType(name string, init DspInitializer)

RegisterDomainServiceProviderType adds a dsp to the registry with the given initialization function.

func RegisterRegistrarType

func RegisterRegistrarType(name string, init RegistrarInitializer)

RegisterRegistrarType adds a registrar type to the registry by providing a suitable initialization function.

Types

type DNSServiceProvider

type DNSServiceProvider interface {
	GetNameservers(domain string) ([]*models.Nameserver, error)
	GetDomainCorrections(dc *models.DomainConfig) ([]*models.Correction, error)
}

DNSServiceProvider is able to generate a set of corrections that need to be made to correct records for a domain

type DomainCreator

type DomainCreator interface {
	EnsureDomainExists(domain string) error
}

DomainCreator should be implemented by providers that have the ability to add domains to an account. the create-domains command can be run to ensure all domains are present before running preview/push

type DspInitializer

type DspInitializer func(map[string]string, json.RawMessage) (DNSServiceProvider, error)

DspInitializer is a function to create a registrar. Function will be passed the unprocessed json payload from the configuration file for the given provider.

type None

type None struct{}

None is a basivc provider type that does absolutely nothing. Can be useful as a placeholder for third parties or unimplemented providers.

func (None) GetDomainCorrections

func (n None) GetDomainCorrections(dc *models.DomainConfig) ([]*models.Correction, error)

func (None) GetNameservers

func (n None) GetNameservers(string) ([]*models.Nameserver, error)

func (None) GetRegistrarCorrections

func (n None) GetRegistrarCorrections(dc *models.DomainConfig) ([]*models.Correction, error)

type Registrar

type Registrar interface {
	GetRegistrarCorrections(dc *models.DomainConfig) ([]*models.Correction, error)
}

Registrar is an interface for a domain registrar. It can return a list of needed corrections to be applied in the future.

type RegistrarInitializer

type RegistrarInitializer func(map[string]string) (Registrar, error)

RegistrarInitializer is a function to create a registrar. Function will be passed the unprocessed json payload from the configuration file for the given provider.