constraints

Documentation

Index

• func EntityTypeName[T typeWithName]() string
• func EntityTypeNameForObj[T typeWithName](obj T) string
• type EntityType
• type EntityWithKonnectAPIAuthConfigurationRef
• type SupportedKonnectEntityPluginReferenceableType
• type SupportedKonnectEntityType

Functions

func EntityTypeName

func EntityTypeName[T typeWithName]() string

EntityTypeName returns the name of the entity type.

func EntityTypeNameForObj

func EntityTypeNameForObj[T typeWithName](obj T) string

EntityTypeNameForObj returns the name of the provided entity.

Types

type EntityType

type EntityType[T SupportedKonnectEntityType] interface {
	*T
	// Kubernetes Object methods
	GetObjectMeta() metav1.Object
	client.Object

	// Additional methods which are used in reconciling Konnect entities.
	GetConditions() []metav1.Condition
	SetConditions([]metav1.Condition)
	GetKonnectStatus() *konnectv1alpha1.KonnectEntityStatus
	SetKonnectID(string)
	GetTypeName() string
}

EntityType is an interface that all Konnect entity types must implement. Separating this from constraints.SupportedKonnectEntityType allows us to use EntityType where client.Object is required, since it embeds client.Object and uses pointer to refer to the constraints.SupportedKonnectEntityType.

type EntityWithKonnectAPIAuthConfigurationRef

type EntityWithKonnectAPIAuthConfigurationRef interface {
	GetKonnectAPIAuthConfigurationRef() konnectv1alpha1.KonnectAPIAuthConfigurationRef
}

EntityWithKonnectAPIAuthConfigurationRef is an interface that all Konnect entity types that reference a KonnectAPIAuthConfiguration must implement. More specifically Konnect's ControlPlane does implement that, while all the other Konnect entities that are defined within a ControlPlane do not because their KonnectAPIAuthConfigurationRef is defined in the referenced ControlPlane.

type SupportedKonnectEntityPluginReferenceableType

type SupportedKonnectEntityPluginReferenceableType interface {
	configurationv1alpha1.KongService |
		configurationv1alpha1.KongRoute |
		configurationv1.KongConsumer |
		configurationv1beta1.KongConsumerGroup

	GetTypeName() string
}

SupportedKonnectEntityPluginReferenceableType is an interface that all Konnect entity types that can be referenced by a KonnectPluginBinding must implement.

type SupportedKonnectEntityType

type SupportedKonnectEntityType interface {
	konnectv1alpha1.KonnectGatewayControlPlane |
		configurationv1alpha1.KongService |
		configurationv1alpha1.KongRoute |
		configurationv1.KongConsumer |
		configurationv1beta1.KongConsumerGroup |
		configurationv1alpha1.KongPluginBinding |
		configurationv1alpha1.KongCredentialBasicAuth |
		configurationv1alpha1.KongCredentialAPIKey |
		configurationv1alpha1.KongCredentialACL |
		configurationv1alpha1.KongCredentialJWT |
		configurationv1alpha1.KongCredentialHMAC |
		configurationv1alpha1.KongUpstream |
		configurationv1alpha1.KongCACertificate |
		configurationv1alpha1.KongCertificate |
		configurationv1alpha1.KongTarget |
		configurationv1alpha1.KongVault |
		configurationv1alpha1.KongKey |
		configurationv1alpha1.KongKeySet |
		configurationv1alpha1.KongSNI |
		configurationv1alpha1.KongDataPlaneClientCertificate

	GetTypeName() string
}

SupportedKonnectEntityType is an interface that all Konnect entity types must implement.