dns

Documentation

Index

• Variables
• func CheckDNSObject(obj client.Object) error
• func NewEntry(logger logrus.FieldLogger, client client.Client, namespace string, ...) component.DeployWaiter
• func NewOwner(client client.Client, namespace string, values *OwnerValues) component.DeployWaiter
• func NewProvider(logger logrus.FieldLogger, client client.Client, namespace string, ...) component.DeployWaiter
• type EntryValues
• type ErrorWithDNSState
• type IncludeExclude
• type Object
  • func Accessor(obj client.Object) (Object, error)
• type OwnerValues
• type ProviderValues

Variables

var TimeNow = time.Now

TimeNow returns the current time. Exposed for testing.

Functions

func CheckDNSObject

func CheckDNSObject(obj client.Object) error

CheckDNSObject is similar to health.CheckExtensionObject, but implements the special handling for DNS objects as they don't implement extensionsv1alpha1.Object.

func NewEntry

func NewEntry(
	logger logrus.FieldLogger,
	client client.Client,
	namespace string,
	values *EntryValues,
) component.DeployWaiter

NewEntry creates a new instance of DeployWaiter for a specific DNSEntry.

func NewOwner

func NewOwner(client client.Client, namespace string, values *OwnerValues) component.DeployWaiter

NewOwner creates a new instance of DeployWaiter for a specific DNSOwner.

func NewProvider

func NewProvider(
	logger logrus.FieldLogger,
	client client.Client,
	namespace string,
	values *ProviderValues,
) component.DeployWaiter

NewProvider creates a new instance of DeployWaiter for a specific DNSProvider.

Types

type EntryValues

type EntryValues struct {
	Name    string
	DNSName string
	Targets []string
	OwnerID string
	TTL     int64
}

EntryValues contains the values used to create a DNSEntry

type ErrorWithDNSState

type ErrorWithDNSState interface {
	error

	// DNSState returns the state of the DNS object this error is about.
	DNSState() string
}

ErrorWithDNSState is an error annotated with the state of a DNS object.

type IncludeExclude

type IncludeExclude struct {
	Include []string
	Exclude []string
}

IncludeExclude contain slices of excluded and included domains/zones.

type Object

type Object interface {
	client.Object

	GetObservedGeneration() int64
	SetObservedGeneration(observedGeneration int64)
	GetState() string
	SetState(state string)
	GetMessage() *string
	SetMessage(message *string)
}

Object is an interface for accessing common fields across DNS objects. It is similar to extensionsv1alpha1.Object but special, as the DNS objects don't have the same structure as all other extension objects and thus don't implement extensionsv1alpha1.Object.

func Accessor

func Accessor(obj client.Object) (Object, error)

Accessor returns an Object implementation for the given obj.

type OwnerValues

type OwnerValues struct {
	Name    string
	OwnerID string
	Active  *bool
}

OwnerValues contains the values used for DNSOwner creation

type ProviderValues

type ProviderValues struct {
	Name        string
	Purpose     string
	Provider    string
	Labels      map[string]string
	Annotations map[string]string
	SecretData  map[string][]byte
	Domains     *IncludeExclude
	Zones       *IncludeExclude
}

ProviderValues contains the values used to create a DNSProvider.