provider

Documentation

Index

• func GetExternalAddresses(endpoint *externaldns.Endpoint, dnsRecord *v1alpha1.DNSRecord) (externalAddresses []string)
• func GetISO3166Alpha2Codes() []string
• func IsExternalAddress(address string, dnsRecord *v1alpha1.DNSRecord) bool
• func IsISO3166Alpha2Code(code string) bool
• func RegisterProvider(name string, c ProviderConstructor)
• func SanitizeError(err error) error
• type CachedHealthCheckReconciler
  • func NewCachedHealthCheckReconciler(provider Provider, reconciler HealthCheckReconciler) *CachedHealthCheckReconciler
  • func (r *CachedHealthCheckReconciler) Delete(ctx context.Context, endpoint *externaldns.Endpoint, ...) (HealthCheckResult, error)
  • func (r *CachedHealthCheckReconciler) Reconcile(ctx context.Context, spec HealthCheckSpec, endpoint *externaldns.Endpoint, ...) HealthCheckResult
• type Config
• type Factory
  • func NewFactory(c client.Client) Factory
• type FakeHealthCheckReconciler
  • func (*FakeHealthCheckReconciler) Delete(_ context.Context, _ *externaldns.Endpoint, _ *v1alpha1.HealthCheckStatusProbe) (HealthCheckResult, error)
  • func (*FakeHealthCheckReconciler) Reconcile(_ context.Context, _ HealthCheckSpec, _ *externaldns.Endpoint, ...) HealthCheckResult
• type HealthCheckProtocol
• type HealthCheckReconciler
• type HealthCheckReconciliationResult
• type HealthCheckResult
  • func NewHealthCheckResult(result HealthCheckReconciliationResult, id, ipaddress, host string, ...) HealthCheckResult
• type HealthCheckSpec
• type ManagedZoneOutput
• type Provider
• type ProviderConstructor
• type ProviderSpecificLabels

Functions

func GetExternalAddresses

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

func GetISO3166Alpha2Codes

func GetISO3166Alpha2Codes() []string

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 RegisterProvider

func RegisterProvider(name string, c ProviderConstructor)

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.

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 CachedHealthCheckReconciler

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

func NewCachedHealthCheckReconciler

func NewCachedHealthCheckReconciler(provider Provider, reconciler HealthCheckReconciler) *CachedHealthCheckReconciler

func (*CachedHealthCheckReconciler) Delete

func (r *CachedHealthCheckReconciler) Delete(ctx context.Context, endpoint *externaldns.Endpoint, probeStatus *v1alpha1.HealthCheckStatusProbe) (HealthCheckResult, error)

Delete implements HealthCheckReconciler

func (*CachedHealthCheckReconciler) Reconcile

func (r *CachedHealthCheckReconciler) Reconcile(ctx context.Context, spec HealthCheckSpec, endpoint *externaldns.Endpoint, probeStatus *v1alpha1.HealthCheckStatusProbe, address string) HealthCheckResult

Reconcile implements HealthCheckReconciler

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 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) Factory

NewFactory returns a new provider factory with the given client.

type FakeHealthCheckReconciler

type FakeHealthCheckReconciler struct{}

func (*FakeHealthCheckReconciler) Delete

func (*FakeHealthCheckReconciler) Delete(_ context.Context, _ *externaldns.Endpoint, _ *v1alpha1.HealthCheckStatusProbe) (HealthCheckResult, error)

func (*FakeHealthCheckReconciler) Reconcile

func (*FakeHealthCheckReconciler) Reconcile(_ context.Context, _ HealthCheckSpec, _ *externaldns.Endpoint, _ *v1alpha1.HealthCheckStatusProbe, _ string) HealthCheckResult

type HealthCheckProtocol

type HealthCheckProtocol string

const HealthCheckProtocolHTTP HealthCheckProtocol = "HTTP"

const HealthCheckProtocolHTTPS HealthCheckProtocol = "HTTPS"

type HealthCheckReconciler

type HealthCheckReconciler interface {
	Reconcile(ctx context.Context, spec HealthCheckSpec, endpoint *externaldns.Endpoint, probeStatus *v1alpha1.HealthCheckStatusProbe, address string) HealthCheckResult
	Delete(ctx context.Context, endpoint *externaldns.Endpoint, probeStatus *v1alpha1.HealthCheckStatusProbe) (HealthCheckResult, error)
}

type HealthCheckReconciliationResult

type HealthCheckReconciliationResult string

const (
	HealthCheckCreated HealthCheckReconciliationResult = "Created"
	HealthCheckUpdated HealthCheckReconciliationResult = "Updated"
	HealthCheckDeleted HealthCheckReconciliationResult = "Deleted"
	HealthCheckNoop    HealthCheckReconciliationResult = "Noop"
	HealthCheckFailed  HealthCheckReconciliationResult = "Failed"
)

type HealthCheckResult

type HealthCheckResult struct {
	Result    HealthCheckReconciliationResult
	ID        string
	IPAddress string
	Host      string
	Condition metav1.Condition
}

func NewHealthCheckResult

func NewHealthCheckResult(result HealthCheckReconciliationResult, id, ipaddress, host string, condition metav1.Condition) HealthCheckResult

type HealthCheckSpec

type HealthCheckSpec struct {
	Id               string
	Name             string
	Port             *int64
	FailureThreshold *int64
	Protocol         *HealthCheckProtocol
	Host             *string
	Path             string
}

type ManagedZoneOutput

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

type Provider

type Provider interface {
	externaldnsprovider.Provider

	// Ensure will create or update a managed zone, returns an array of NameServers for that zone.
	EnsureManagedZone(managedZone *v1alpha1.ManagedZone) (ManagedZoneOutput, error)

	// Delete will delete a managed zone.
	DeleteManagedZone(managedZone *v1alpha1.ManagedZone) error

	// Get an instance of HealthCheckReconciler for this provider
	HealthCheckReconciler() HealthCheckReconciler

	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
}