registry

Documentation

Index

• type AWSSDRegistry
  • func NewAWSSDRegistry(provider provider.Provider, ownerID string) (*AWSSDRegistry, error)
  • func (sdr *AWSSDRegistry) AdjustEndpoints(endpoints []*endpoint.Endpoint) ([]*endpoint.Endpoint, error)
  • func (sdr *AWSSDRegistry) ApplyChanges(ctx context.Context, changes *plan.Changes) error
  • func (sdr *AWSSDRegistry) GetDomainFilter() endpoint.DomainFilter
  • func (im *AWSSDRegistry) OwnerID() string
  • func (sdr *AWSSDRegistry) Records(ctx context.Context) ([]*endpoint.Endpoint, error)
• type DynamoDBAPI
• type DynamoDBRegistry
  • func NewDynamoDBRegistry(provider provider.Provider, ownerID string, dynamodbAPI DynamoDBAPI, ...) (*DynamoDBRegistry, error)
  • func (im *DynamoDBRegistry) AdjustEndpoints(endpoints []*endpoint.Endpoint) ([]*endpoint.Endpoint, error)
  • func (im *DynamoDBRegistry) ApplyChanges(ctx context.Context, changes *plan.Changes) error
  • func (im *DynamoDBRegistry) GetDomainFilter() endpoint.DomainFilter
  • func (im *DynamoDBRegistry) OwnerID() string
  • func (im *DynamoDBRegistry) Records(ctx context.Context) ([]*endpoint.Endpoint, error)
• type NoopRegistry
  • func NewNoopRegistry(provider provider.Provider) (*NoopRegistry, error)
  • func (im *NoopRegistry) AdjustEndpoints(endpoints []*endpoint.Endpoint) ([]*endpoint.Endpoint, error)
  • func (im *NoopRegistry) ApplyChanges(ctx context.Context, changes *plan.Changes) error
  • func (im *NoopRegistry) GetDomainFilter() endpoint.DomainFilter
  • func (im *NoopRegistry) OwnerID() string
  • func (im *NoopRegistry) Records(ctx context.Context) ([]*endpoint.Endpoint, error)
• type Registry
• type TXTRegistry
  • func NewTXTRegistry(provider provider.Provider, txtPrefix, txtSuffix, ownerID string, ...) (*TXTRegistry, error)
  • func (im *TXTRegistry) AdjustEndpoints(endpoints []*endpoint.Endpoint) ([]*endpoint.Endpoint, error)
  • func (im *TXTRegistry) ApplyChanges(ctx context.Context, changes *plan.Changes) error
  • func (im *TXTRegistry) GetDomainFilter() endpoint.DomainFilter
  • func (im *TXTRegistry) OwnerID() string
  • func (im *TXTRegistry) Records(ctx context.Context) ([]*endpoint.Endpoint, error)

Types

type AWSSDRegistry

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

AWSSDRegistry implements registry interface with ownership information associated via the Description field of SD Service

func NewAWSSDRegistry

func NewAWSSDRegistry(provider provider.Provider, ownerID string) (*AWSSDRegistry, error)

NewAWSSDRegistry returns implementation of registry for AWS SD

func (*AWSSDRegistry) AdjustEndpoints

func (sdr *AWSSDRegistry) AdjustEndpoints(endpoints []*endpoint.Endpoint) ([]*endpoint.Endpoint, error)

AdjustEndpoints modifies the endpoints as needed by the specific provider

func (*AWSSDRegistry) ApplyChanges

func (sdr *AWSSDRegistry) ApplyChanges(ctx context.Context, changes *plan.Changes) error

ApplyChanges filters out records not owned the External-DNS, additionally it adds the required label inserted in the AWS SD instance as a CreateID field

func (*AWSSDRegistry) GetDomainFilter

func (sdr *AWSSDRegistry) GetDomainFilter() endpoint.DomainFilter

func (*AWSSDRegistry) OwnerID

func (im *AWSSDRegistry) OwnerID() string

func (*AWSSDRegistry) Records

func (sdr *AWSSDRegistry) Records(ctx context.Context) ([]*endpoint.Endpoint, error)

Records calls AWS SD API and expects AWS SD provider to provider Owner/Resource information as a serialized value in the AWSSDDescriptionLabel value in the Labels map

type DynamoDBAPI

type DynamoDBAPI interface {
	DescribeTableWithContext(ctx aws.Context, input *dynamodb.DescribeTableInput, opts ...request.Option) (*dynamodb.DescribeTableOutput, error)
	ScanPagesWithContext(ctx aws.Context, input *dynamodb.ScanInput, fn func(*dynamodb.ScanOutput, bool) bool, opts ...request.Option) error
	BatchExecuteStatementWithContext(aws.Context, *dynamodb.BatchExecuteStatementInput, ...request.Option) (*dynamodb.BatchExecuteStatementOutput, error)
}

DynamoDBAPI is the subset of the AWS Route53 API that we actually use. Add methods as required. Signatures must match exactly.

type DynamoDBRegistry

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

DynamoDBRegistry implements registry interface with ownership implemented via an AWS DynamoDB table.

func NewDynamoDBRegistry

func NewDynamoDBRegistry(provider provider.Provider, ownerID string, dynamodbAPI DynamoDBAPI, table string, txtPrefix, txtSuffix, txtWildcardReplacement string, managedRecordTypes, excludeRecordTypes []string, txtEncryptAESKey []byte, cacheInterval time.Duration) (*DynamoDBRegistry, error)

NewDynamoDBRegistry returns a new DynamoDBRegistry object.

func (*DynamoDBRegistry) AdjustEndpoints

func (im *DynamoDBRegistry) AdjustEndpoints(endpoints []*endpoint.Endpoint) ([]*endpoint.Endpoint, error)

AdjustEndpoints modifies the endpoints as needed by the specific provider.

func (*DynamoDBRegistry) ApplyChanges

func (im *DynamoDBRegistry) ApplyChanges(ctx context.Context, changes *plan.Changes) error

ApplyChanges updates the DNS provider and DynamoDB table with the changes.

func (*DynamoDBRegistry) GetDomainFilter

func (im *DynamoDBRegistry) GetDomainFilter() endpoint.DomainFilter

func (*DynamoDBRegistry) OwnerID

func (im *DynamoDBRegistry) OwnerID() string

func (*DynamoDBRegistry) Records

func (im *DynamoDBRegistry) Records(ctx context.Context) ([]*endpoint.Endpoint, error)

Records returns the current records from the registry.

type NoopRegistry

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

NoopRegistry implements registry interface without ownership directly propagating changes to dns provider

func NewNoopRegistry

func NewNoopRegistry(provider provider.Provider) (*NoopRegistry, error)

NewNoopRegistry returns new NoopRegistry object

func (*NoopRegistry) AdjustEndpoints

func (im *NoopRegistry) AdjustEndpoints(endpoints []*endpoint.Endpoint) ([]*endpoint.Endpoint, error)

AdjustEndpoints modifies the endpoints as needed by the specific provider

func (*NoopRegistry) ApplyChanges

func (im *NoopRegistry) ApplyChanges(ctx context.Context, changes *plan.Changes) error

ApplyChanges propagates changes to the dns provider

func (*NoopRegistry) GetDomainFilter

func (im *NoopRegistry) GetDomainFilter() endpoint.DomainFilter

func (*NoopRegistry) OwnerID

func (im *NoopRegistry) OwnerID() string

func (*NoopRegistry) Records

func (im *NoopRegistry) Records(ctx context.Context) ([]*endpoint.Endpoint, error)

Records returns the current records from the dns provider

type Registry

type Registry interface {
	Records(ctx context.Context) ([]*endpoint.Endpoint, error)
	ApplyChanges(ctx context.Context, changes *plan.Changes) error
	AdjustEndpoints(endpoints []*endpoint.Endpoint) ([]*endpoint.Endpoint, error)
	GetDomainFilter() endpoint.DomainFilter
	OwnerID() string
}

Registry is an interface which should enables ownership concept in external-dns Records() returns ALL records registered with DNS provider each entry includes owner information ApplyChanges(changes *plan.Changes) propagates the changes to the DNS Provider API and correspondingly updates ownership depending on type of registry being used

type TXTRegistry

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

TXTRegistry implements registry interface with ownership implemented via associated TXT records

func NewTXTRegistry

func NewTXTRegistry(provider provider.Provider, txtPrefix, txtSuffix, ownerID string, cacheInterval time.Duration, txtWildcardReplacement string, managedRecordTypes, excludeRecordTypes []string, txtEncryptEnabled bool, txtEncryptAESKey []byte) (*TXTRegistry, error)

NewTXTRegistry returns new TXTRegistry object

func (*TXTRegistry) AdjustEndpoints

func (im *TXTRegistry) AdjustEndpoints(endpoints []*endpoint.Endpoint) ([]*endpoint.Endpoint, error)

AdjustEndpoints modifies the endpoints as needed by the specific provider

func (*TXTRegistry) ApplyChanges

func (im *TXTRegistry) ApplyChanges(ctx context.Context, changes *plan.Changes) error

ApplyChanges updates dns provider with the changes for each created/deleted record it will also take into account TXT records for creation/deletion

func (*TXTRegistry) GetDomainFilter

func (im *TXTRegistry) GetDomainFilter() endpoint.DomainFilter

func (*TXTRegistry) OwnerID

func (im *TXTRegistry) OwnerID() string

func (*TXTRegistry) Records

func (im *TXTRegistry) Records(ctx context.Context) ([]*endpoint.Endpoint, error)

Records returns the current records from the registry excluding TXT Records If TXT records was created previously to indicate ownership its corresponding value will be added to the endpoints Labels map