dns

Documentation

Index

• Constants
• type ChartConfigBase
• type ChartsConfig
• type ClusterOrgIDGetter
• type ClusterUIDGetter
• type Config
  • func (c Config) Validate() error
• type ExternalDNSChartConfig
• type ExternalDNSChartValuesConfig
• type ExternalDNSChartValuesImageConfig
• type IntegratedServiceManager
  • func NewIntegratedServicesManager(clusterOrgIDGetter ClusterOrgIDGetter, clusterUIDGetter ClusterUIDGetter, ...) IntegratedServiceManager
  • func (m IntegratedServiceManager) GetOutput(ctx context.Context, clusterID uint, ...) (integratedservices.IntegratedServiceOutput, error)
  • func (IntegratedServiceManager) Name() string
  • func (m IntegratedServiceManager) PrepareSpec(ctx context.Context, clusterID uint, ...) (integratedservices.IntegratedServiceSpec, error)
  • func (IntegratedServiceManager) ValidateSpec(ctx context.Context, spec integratedservices.IntegratedServiceSpec) error
• type IntegratedServiceOperator
  • func MakeIntegratedServiceOperator(clusterGetter integratedserviceadapter.ClusterGetter, ...) IntegratedServiceOperator
  • func (op IntegratedServiceOperator) Apply(ctx context.Context, clusterID uint, ...) error
  • func (op IntegratedServiceOperator) Deactivate(ctx context.Context, clusterID uint, ...) error
  • func (op IntegratedServiceOperator) Name() string
• type Operator
  • func NewDNSISOperator(clusterGetter integratedserviceadapter.ClusterGetter, ...) Operator
  • func (o Operator) Apply(ctx context.Context, clusterID uint, ...) error
  • func (o Operator) Deactivate(ctx context.Context, clusterID uint, ...) error
  • func (o Operator) Name() string
• type OrgDomainService
• type OutputResolver
  • func (o OutputResolver) Resolve(ctx context.Context, instance v1alpha1.ServiceInstance) (integratedservices.IntegratedServiceOutput, error)
• type SecretMapper
  • func NewSecretMapper(secretStore services.SecretStore) *SecretMapper
  • func (s SecretMapper) ConvertSpec(ctx context.Context, service v1alpha1.ServiceInstance) (integratedservices.IntegratedServiceSpec, error)

Constants

const IntegratedServiceName = "dns"

const ReleaseName = "dns"

Types

type ChartConfigBase

type ChartConfigBase struct {
	Chart   string
	Version string
}

type ChartsConfig

type ChartsConfig struct {
	ExternalDNS ExternalDNSChartConfig
}

type ClusterOrgIDGetter

type ClusterOrgIDGetter interface {
	GetClusterOrgID(ctx context.Context, clusterID uint) (uint, error)
}

ClusterOrgIDGetter can be used to get the ID of the organization a cluster belongs to

type ClusterUIDGetter

type ClusterUIDGetter interface {
	GetClusterUID(ctx context.Context, clusterID uint) (string, error)
}

ClusterUIDGetter can be used to get the UID of a cluster

type Config

type Config struct {
	Namespace      string
	BaseDomain     string
	ProviderSecret string
	Charts         ChartsConfig
}

Config contains configuration for the dns integrated service.

func (Config) Validate

func (c Config) Validate() error

type ExternalDNSChartConfig

type ExternalDNSChartConfig struct {
	ChartConfigBase `mapstructure:",squash"`
	Values          ExternalDNSChartValuesConfig
}

type ExternalDNSChartValuesConfig

type ExternalDNSChartValuesConfig struct {
	Image ExternalDNSChartValuesImageConfig `chartConfig:"image"`
}

type ExternalDNSChartValuesImageConfig

type ExternalDNSChartValuesImageConfig struct {
	Registry   string `chartConfig:"registry"`
	Repository string `chartConfig:"repository"`
	Tag        string `chartConfig:"tag"`
}

type IntegratedServiceManager

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

IntegratedServiceManager implements the DNS integrated service manager

func NewIntegratedServicesManager

func NewIntegratedServicesManager(clusterOrgIDGetter ClusterOrgIDGetter, clusterUIDGetter ClusterUIDGetter, config Config) IntegratedServiceManager

NewIntegratedServicesManager returns a DNS integrated service manager

func (IntegratedServiceManager) GetOutput

func (m IntegratedServiceManager) GetOutput(ctx context.Context, clusterID uint, _ integratedservices.IntegratedServiceSpec) (integratedservices.IntegratedServiceOutput, error)

GetOutput returns the DNS integrated service's output

func (IntegratedServiceManager) Name

func (IntegratedServiceManager) Name() string

Name returns the integrated service's name

func (IntegratedServiceManager) PrepareSpec

func (m IntegratedServiceManager) PrepareSpec(ctx context.Context, clusterID uint, spec integratedservices.IntegratedServiceSpec) (integratedservices.IntegratedServiceSpec, error)

PrepareSpec makes certain preparations to the spec before it's sent to be applied

func (IntegratedServiceManager) ValidateSpec

func (IntegratedServiceManager) ValidateSpec(ctx context.Context, spec integratedservices.IntegratedServiceSpec) error

ValidateSpec validates a DNS integrated service specification

type IntegratedServiceOperator

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

IntegratedServiceOperator implements the DNS integrated service operator

func MakeIntegratedServiceOperator

func MakeIntegratedServiceOperator(
	clusterGetter integratedserviceadapter.ClusterGetter,
	clusterService integratedservices.ClusterService,
	helmService services.HelmService,
	logger common.Logger,
	orgDomainService OrgDomainService,
	secretStore services.SecretStore,
	config Config,
) IntegratedServiceOperator

MakeIntegratedServiceOperator returns a DNS integrated service operator

func (IntegratedServiceOperator) Apply

func (op IntegratedServiceOperator) Apply(ctx context.Context, clusterID uint, spec integratedservices.IntegratedServiceSpec) error

Apply applies the provided specification to the integrated service

func (IntegratedServiceOperator) Deactivate

func (op IntegratedServiceOperator) Deactivate(ctx context.Context, clusterID uint, _ integratedservices.IntegratedServiceSpec) error

Deactivate deactivates the integrated service

func (IntegratedServiceOperator) Name

func (op IntegratedServiceOperator) Name() string

Name returns the name of the DNS integrated service

type Operator

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

func NewDNSISOperator

func NewDNSISOperator(
	clusterGetter integratedserviceadapter.ClusterGetter,
	clusterService integratedservices.ClusterService,
	orgDomainService OrgDomainService,
	secretStore services.SecretStore,
	config Config,
	logger common.Logger,
) Operator

func (Operator) Apply

func (o Operator) Apply(ctx context.Context, clusterID uint, spec integratedservices.IntegratedServiceSpec) error

func (Operator) Deactivate

func (o Operator) Deactivate(ctx context.Context, clusterID uint, _ integratedservices.IntegratedServiceSpec) error

func (Operator) Name

func (o Operator) Name() string

type OrgDomainService

type OrgDomainService interface {
	// EnsureClusterDomain checks for the org related hosted zone, triggers the creation of it if required
	EnsureOrgDomain(ctx context.Context, clusterID uint) error
}

OrgDomainService interface for abstracting DNS provider related operations intended to be used in conjunction with the autoDNS integrated service in pipeline

type OutputResolver

type OutputResolver struct{}

func (OutputResolver) Resolve

func (o OutputResolver) Resolve(ctx context.Context, instance v1alpha1.ServiceInstance) (integratedservices.IntegratedServiceOutput, error)

type SecretMapper

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

func NewSecretMapper

func NewSecretMapper(secretStore services.SecretStore) *SecretMapper

func (SecretMapper) ConvertSpec

func (s SecretMapper) ConvertSpec(ctx context.Context, service v1alpha1.ServiceInstance) (integratedservices.IntegratedServiceSpec, error)