controllers

Documentation

Index

• type DataPlane
• type DataPlaneClient
• type DataPlaneStatusClient
• type OptionalNamespacedName
  • func NewOptionalNamespacedName(onn mo.Option[k8stypes.NamespacedName]) OptionalNamespacedName
  • func (onn OptionalNamespacedName) Get() (k8stypes.NamespacedName, bool)
  • func (onn OptionalNamespacedName) IsPresent() bool
  • func (onn OptionalNamespacedName) Matches(obj client.Object) bool
  • func (onn OptionalNamespacedName) MatchesNN(nn k8stypes.NamespacedName) bool
• type Reconciler

Types

type DataPlane

type DataPlane interface {
	DataPlaneClient
	DataPlaneStatusClient

	Listeners(ctx context.Context) ([]kong.ProxyListener, []kong.StreamListener, error)
}

DataPlane is a common interface that is used by reconcilers to interact with the Kong dataplane.

type DataPlaneClient

type DataPlaneClient interface {
	UpdateObject(obj client.Object) error
	DeleteObject(obj client.Object) error
	ObjectExists(obj client.Object) (bool, error)
}

DataPlaneClient is a common client interface that is used by reconcilers to interact with the Kong dataplane to perform CRUD operations on provided objects.

type DataPlaneStatusClient

type DataPlaneStatusClient interface {
	AreKubernetesObjectReportsEnabled() bool
	KubernetesObjectConfigurationStatus(obj client.Object) k8sobj.ConfigurationStatus
	KubernetesObjectIsConfigured(obj client.Object) bool
}

type OptionalNamespacedName

type OptionalNamespacedName struct {
	mo.Option[k8stypes.NamespacedName]
}

OptionalNamespacedName is a wrapper around mo.Option[k8stypes.NamespacedName] that provides additional Matches and MatchesNN methods for matching against client.Object and k8stypes.NamespacedName.

func NewOptionalNamespacedName

func NewOptionalNamespacedName(onn mo.Option[k8stypes.NamespacedName]) OptionalNamespacedName

NewOptionalNamespacedName creates a new OptionalNamespacedName with the provided value.

func (OptionalNamespacedName) Get

func (onn OptionalNamespacedName) Get() (k8stypes.NamespacedName, bool)

Get calls the underlying mo.Option.Get.

func (OptionalNamespacedName) IsPresent

func (onn OptionalNamespacedName) IsPresent() bool

IsPresent calls the underlying mo.Option.IsPresent.

func (OptionalNamespacedName) Matches

func (onn OptionalNamespacedName) Matches(obj client.Object) bool

Matches returns true if the OptionalNamespacedName is present and the provided object's namespace and name match the OptionalNamespacedName's namespace and name. It also returns true if the OptionalNamespacedName is not present as it is considered to match everything.

func (OptionalNamespacedName) MatchesNN

func (onn OptionalNamespacedName) MatchesNN(nn k8stypes.NamespacedName) bool

MatchesNN returns true if the OptionalNamespacedName is present and the provided k8stypes.NamespacedName matches the OptionalNamespacedName's namespace and name. It also returns true if the OptionalNamespacedName is not present as it is considered to match everything.

type Reconciler

type Reconciler interface {
	SetupWithManager(ctrl.Manager) error
	SetLogger(logr.Logger)
}