Documentation
¶
Index ¶
- func EntityTypeName[T typeWithName]() string
- func EntityTypeNameForObj[T typeWithName](obj T) string
- type EntityType
- type EntityTypeObject
- type EntityWithKonnectAPIAuthConfigurationRef
- type KongCredential
- type KonnectEntityTypeSupportingAdoption
- type SupportedCredentialType
- type SupportedGeneratedKonnectEntityType
- type SupportedHandwrittenKonnectEntityType
- type SupportedKonnectEntityPluginReferenceableType
- type SupportedKonnectEntityType
Constants ¶
This section is empty.
Variables ¶
This section is empty.
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 any] interface { EntityTypeObject[T] PersistsKonnectID() bool SetKonnectID(string) GetKonnectStatus() *konnectv1alpha2.KonnectEntityStatus }
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 EntityTypeObject ¶
type EntityTypeObject[T any] interface { *T GetObjectMeta() metav1.Object client.Object GetConditions() []metav1.Condition SetConditions([]metav1.Condition) GetTypeName() string }
EntityTypeObject is an interface that allows non Konnect types to be used in the Konnect reconciler and its helper functions.
type EntityWithKonnectAPIAuthConfigurationRef ¶
type EntityWithKonnectAPIAuthConfigurationRef interface {
client.Object
GetKonnectAPIAuthConfigurationRef() konnectv1alpha2.ControlPlaneKonnectAPIAuthConfigurationRef
}
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 KongCredential ¶
type KongCredential[T SupportedCredentialType] interface { *T client.Object GetConditions() []metav1.Condition SetConditions([]metav1.Condition) }
KongCredential is a generic type constraint that all Kong credential types must implement.
type KonnectEntityTypeSupportingAdoption ¶ added in v2.1.1
type KonnectEntityTypeSupportingAdoption interface {
GetTypeName() string
GetAdoptOptions() *commonv1alpha1.AdoptOptions
SetAdoptOptions(*commonv1alpha1.AdoptOptions)
}
KonnectEntityTypeSupportingAdoption are types supporting to adopt existing entities from Konnect.
type SupportedCredentialType ¶
type SupportedCredentialType interface {
configurationv1alpha1.KongCredentialBasicAuth |
configurationv1alpha1.KongCredentialAPIKey |
configurationv1alpha1.KongCredentialACL |
configurationv1alpha1.KongCredentialJWT |
configurationv1alpha1.KongCredentialHMAC
GetTypeName() string
}
SupportedCredentialType is a generic type constraint that all Kong credential types must implement.
type SupportedGeneratedKonnectEntityType ¶ added in v2.2.0
type SupportedGeneratedKonnectEntityType interface {
configurationv1alpha1.EventGatewayBackendCluster |
configurationv1alpha1.EventGatewayDataPlaneCertificate |
configurationv1alpha1.EventGatewayListener |
configurationv1alpha1.EventGatewayListenerPolicy |
configurationv1alpha1.EventGatewayVirtualCluster |
configurationv1alpha1.EventGatewayVirtualClusterConsumePolicy |
configurationv1alpha1.EventGatewayVirtualClusterPolicy |
configurationv1alpha1.EventGatewayVirtualClusterProducePolicy |
konnectv1alpha1.KonnectEventGateway |
konnectv1alpha1.Portal |
konnectv1alpha1.PortalCustomDomain |
konnectv1alpha1.PortalCustomization |
konnectv1alpha1.PortalEmailConfig |
konnectv1alpha1.PortalIPAllowList |
konnectv1alpha1.PortalIdentityProviderRequest |
konnectv1alpha1.PortalPage |
konnectv1alpha1.PortalTeam
}
SupportedGeneratedKonnectEntityType is the generated subset of constraints.SupportedKonnectEntityType.
type SupportedHandwrittenKonnectEntityType ¶ added in v2.2.0
type SupportedHandwrittenKonnectEntityType interface {
konnectv1alpha2.KonnectGatewayControlPlane |
konnectv1alpha1.KonnectCloudGatewayNetwork |
konnectv1alpha1.KonnectCloudGatewayDataPlaneGroupConfiguration |
konnectv1alpha1.KonnectCloudGatewayTransitGateway |
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 |
konnectv1alpha1.MCPServer
}
SupportedHandwrittenKonnectEntityType is the handwritten subset of Konnect entity types supported by the generic reconciler.
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 {
SupportedHandwrittenKonnectEntityType | SupportedGeneratedKonnectEntityType
GetTypeName() string
}
SupportedKonnectEntityType is an interface that all Konnect entity types must implement.
Source Files