provider

Documentation

Index

• Constants
• Variables
• func GetExternalAddresses(endpoint *externaldns.Endpoint, dnsRecord *v1alpha1.DNSRecord) (externalAddresses []string)
• func GetISO3166Alpha2Codes() []string
• func IsContinentCode(code string) bool
• func IsExternalAddress(address string, dnsRecord *v1alpha1.DNSRecord) bool
• func IsISO3166Alpha2Code(code string) bool
• func NameForProviderSecret(secret *v1.Secret) (string, error)
• func RegisterProvider(name string, c ProviderConstructor, asDefault bool)
• func RegisteredDefaultProviders() []string
• func SanitizeError(err error) error
• type Config
• type DNSZone
  • func FindDNSZoneForHost(ctx context.Context, host string, zones []DNSZone) (*DNSZone, error)
• type Factory
  • func NewFactory(c client.Client, p []string) (Factory, error)
• type Provider
• type ProviderConstructor
• type ProviderSpecificLabels

Constants

const (
	AWS_CONTINENT_CODE_AFRICA        = "AF"
	AWS_CONTINENT_CODE_ANTARTICA     = "AN"
	AWS_CONTINENT_CODE_ASIA          = "AS"
	AWS_CONTINENT_CODE_EUROPE        = "EU"
	AWS_CONTINENT_CODE_OCEANIA       = "OC"
	AWS_CONTINENT_CODE_NORTH_AMERICA = "NA"
	AWS_CONTINENT_CODE_SOUTH_AMERICA = "SA"
)

Variables

var AWSContinentCodes = []string{
	AWS_CONTINENT_CODE_AFRICA,
	AWS_CONTINENT_CODE_ANTARTICA,
	AWS_CONTINENT_CODE_ASIA,
	AWS_CONTINENT_CODE_EUROPE,
	AWS_CONTINENT_CODE_OCEANIA,
	AWS_CONTINENT_CODE_NORTH_AMERICA,
	AWS_CONTINENT_CODE_SOUTH_AMERICA,
}

var (
	ErrNoZoneForHost = fmt.Errorf("no zone for host")
)

Functions

func GetExternalAddresses

func GetExternalAddresses(endpoint *externaldns.Endpoint, dnsRecord *v1alpha1.DNSRecord) (externalAddresses []string)

func GetISO3166Alpha2Codes

func GetISO3166Alpha2Codes() []string

func IsContinentCode

func IsContinentCode(code string) bool

func IsExternalAddress

func IsExternalAddress(address string, dnsRecord *v1alpha1.DNSRecord) bool

func IsISO3166Alpha2Code

func IsISO3166Alpha2Code(code string) bool

IsISO3166Alpha2Code returns true if it's a valid ISO_3166 Alpha 2 country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)

func NameForProviderSecret

func NameForProviderSecret(secret *v1.Secret) (string, error)

func RegisterProvider

func RegisterProvider(name string, c ProviderConstructor, asDefault bool)

RegisterProvider will register a provider constructor, so it can be used within the application. 'name' should be unique, and should be used to identify this provider `asDefault` indicates if the provider should be added as a default provider and included in the default providers list.

func RegisteredDefaultProviders

func RegisteredDefaultProviders() []string

func SanitizeError

func SanitizeError(err error) error

SanitizeError removes request specific data from error messages in order to make them consistent across multiple similar requests to the provider. e.g AWS SDK Request ids `request id: 051c860b-9b30-4c19-be1a-1280c3e9fdc4`

Types

type Config

type Config struct {
	// only consider hosted zones managing domains ending in this suffix
	DomainFilter externaldnsendpoint.DomainFilter
	// filter for zones based on visibility
	ZoneTypeFilter externaldnsprovider.ZoneTypeFilter
	// only consider hosted zones ending with this zone id
	ZoneIDFilter externaldnsprovider.ZoneIDFilter
}

type DNSZone

type DNSZone struct {
	ID          string
	DNSName     string
	NameServers []*string
	RecordCount int64
}

func FindDNSZoneForHost

func FindDNSZoneForHost(ctx context.Context, host string, zones []DNSZone) (*DNSZone, error)

FindDNSZoneForHost finds the most suitable zone for the given host in the given list of DNSZones

type Factory

type Factory interface {
	ProviderFor(context.Context, v1alpha1.ProviderAccessor, Config) (Provider, error)
}

Factory is an interface that can be used to obtain Provider implementations. It determines which provider implementation to use by introspecting the given ProviderAccessor resource.

func NewFactory

func NewFactory(c client.Client, p []string) (Factory, error)

NewFactory returns a new provider factory with the given client and given providers enabled. Will return an error if any given provider has no registered provider implementation.

type Provider

type Provider interface {
	externaldnsprovider.Provider

	// DNSZones returns a list of dns zones accessible for this provider
	DNSZones(ctx context.Context) ([]DNSZone, error)

	// DNSZoneForHost returns the DNSZone that best matches the given host in the providers list of zones
	DNSZoneForHost(ctx context.Context, host string) (*DNSZone, error)

	ProviderSpecific() ProviderSpecificLabels
}

Provider knows how to manage DNS zones only as pertains to routing.

type ProviderConstructor

type ProviderConstructor func(context.Context, *v1.Secret, Config) (Provider, error)

ProviderConstructor constructs a provider given a Secret resource and a Context. An error will be returned if the appropriate provider is not registered.

type ProviderSpecificLabels

type ProviderSpecificLabels struct {
	Weight        string
	HealthCheckID string
}