k8s

type ConfigMapGetter ¶ added in v0.2.0

type ConfigMapGetter interface {
	Get(ctx context.Context, name string, opts metav1.GetOptions) (*corev1.ConfigMap, error)
}

ConfigMapGetter is a pared down version of a ConfigMapInterface (found here: https://pkg.go.dev/k8s.io/client-go@v0.21.3/kubernetes/typed/core/v1#ConfigMapInterface).

Pass this whenever possible to functions that only need to get individual ConfigMaps from Kubernetes, and nothing else.

type ConfigMapGetterWatcher ¶ added in v0.2.0

type ConfigMapGetterWatcher interface {
	ConfigMapGetter
	ConfigMapWatcher
}

ConfigMapGetterWatcher is a pared down version of a ConfigMapInterface (found here: https://pkg.go.dev/k8s.io/client-go@v0.21.3/kubernetes/typed/core/v1#ConfigMapInterface).

Pass this whenever possible to functions that only need to watch for ConfigMaps from Kubernetes, and nothing else.

type ConfigMapWatcher ¶ added in v0.2.0

type ConfigMapWatcher interface {
	Watch(ctx context.Context, opts metav1.ListOptions) (watch.Interface, error)
}

ConfigMapWatcher is a pared down version of a ConfigMapInterface (found here: https://pkg.go.dev/k8s.io/client-go@v0.21.3/kubernetes/typed/core/v1#ConfigMapInterface).

Pass this whenever possible to functions that only need to watch for ConfigMaps from Kubernetes, and nothing else.

type DeploymentCache ¶ added in v0.1.0

type DeploymentCache interface {
	json.Marshaler
	Get(name string) (appsv1.Deployment, error)
	Watch(name string) watch.Interface
}

type DeploymentLister ¶ added in v0.2.0

type DeploymentLister interface {
	List(ctx context.Context, options metav1.ListOptions) (*appsv1.DeploymentList, error)
}

type DeploymentListerWatcher ¶ added in v0.2.0

type DeploymentListerWatcher interface {
	DeploymentLister
	DeploymentWatcher
}

DeploymentListerWatcher knows how to list and watch deployments. This interface is implemented by Kubernetes client-go

type DeploymentWatcher ¶ added in v0.2.0

type DeploymentWatcher interface {
	Watch(ctx context.Context, options metav1.ListOptions) (watch.Interface, error)
}

DeploymentLister knows how to watch deployments. This interface is implemented by Kubernetes client-go

type FakeConfigMapGetter ¶ added in v0.2.0

type FakeConfigMapGetter struct {
	ConfigMap *corev1.ConfigMap
	Err       error
}

func (f FakeConfigMapGetter) Get(ctx context.Context, name string, opts metav1.GetOptions) (*corev1.ConfigMap, error)

type FakeDeploymentCache ¶ added in v0.2.0

type FakeDeploymentCache struct {
	json.Marshaler
	Mut      *sync.RWMutex
	Current  map[string]appsv1.Deployment
	Watchers map[string]*watch.RaceFreeFakeWatcher
}

FakeDeploymentCache is a fake implementation of DeploymentCache, suitable for testing interceptor-level logic, without requiring any real Kubernetes client or API interaction

func NewFakeDeploymentCache() *FakeDeploymentCache

func (f *FakeDeploymentCache) Get(name string) (appsv1.Deployment, error)

func (f *FakeDeploymentCache) MarshalJSON() ([]byte, error)

func (f *FakeDeploymentCache) Set(name string, deployment appsv1.Deployment)

func (f *FakeDeploymentCache) SetReplicas(name string, num int32) error

func (f *FakeDeploymentCache) SetWatcher(name string) *watch.RaceFreeFakeWatcher

func (f *FakeDeploymentCache) Watch(name string) watch.Interface

type FakeRuntimeClient ¶ added in v0.2.0

type FakeRuntimeClient struct {
	*FakeRuntimeClientReader
	*FakeRuntimeClientWriter
	*FakeRuntimeStatusClient
}

FakeRuntimeClient is a fake implementation of (k8s.io/controller-runtime/pkg/client).Client

func NewFakeRuntimeClient() *FakeRuntimeClient

type FakeRuntimeClientReader ¶ added in v0.2.0

type FakeRuntimeClientReader struct {
	GetCalls  []GetCall
	GetFunc   func() client.Object
	ListCalls []client.ObjectList
	ListFunc  func() client.ObjectList
}

FakeRuntimeClientReader is a fake implementation of (k8s.io/controller-runtime/pkg/client).ClientReader

func (f *FakeRuntimeClientReader) Get(
	ctx context.Context,
	key client.ObjectKey,
	obj client.Object,
) error

func (f *FakeRuntimeClientReader) List(
	ctx context.Context,
	list client.ObjectList,
	opts ...client.ListOption,
) error

func (f *FakeRuntimeClientReader) RESTMapper() meta.RESTMapper

type FakeRuntimeClientWriter ¶ added in v0.2.0

type FakeRuntimeClientWriter struct {
	Creates      []client.Object
	Deletes      []client.Object
	Updates      []client.Object
	Patches      []client.Object
	DeleteAllOfs []client.Object
}

FakeRuntimeClientWriter is a fake implementation of (k8s.io/controller-runtime/pkg/client).ClientWriter

It stores all method calls in the respective struct fields. Instances of FakeRuntimeClientWriter are not concurrency-safe

func (f *FakeRuntimeClientWriter) Create(
	ctx context.Context,
	obj client.Object,
	opts ...client.CreateOption,
) error

func (f *FakeRuntimeClientWriter) Delete(
	ctx context.Context,
	obj client.Object,
	opts ...client.DeleteOption,
) error

func (f *FakeRuntimeClientWriter) DeleteAllOf(
	ctx context.Context,
	obj client.Object,
	opts ...client.DeleteAllOfOption,
) error

func (f *FakeRuntimeClientWriter) Patch(
	ctx context.Context,
	obj client.Object,
	patch client.Patch,
	opts ...client.PatchOption,
) error

func (f *FakeRuntimeClientWriter) Update(
	ctx context.Context,
	obj client.Object,
	opts ...client.UpdateOption,
) error

type FakeRuntimeStatusClient ¶ added in v0.2.0

type FakeRuntimeStatusClient struct {
}

FakeRuntimeStatusClient is a fake implementation of (k8s.io/controller-runtime/pkg/client).StatusClient

func (f *FakeRuntimeStatusClient) Scheme() *runtime.Scheme

func (f *FakeRuntimeStatusClient) Status() client.StatusWriter

type GetCall ¶ added in v0.2.0

type GetCall struct {
	Key client.ObjectKey
	Obj client.Object
}

type GetEndpointsFunc ¶ added in v0.2.0

type GetEndpointsFunc func(
	ctx context.Context,
	namespace,
	serviceName string,
) (*v1.Endpoints, error)

GetEndpointsFunc is a type that represents a function that can fetch endpoints

func EndpointsFuncForControllerClient(
	cl client.Client,
) GetEndpointsFunc

func EndpointsFuncForK8sClientset(
	cl *kubernetes.Clientset,
) GetEndpointsFunc

type K8sDeploymentCache ¶ added in v0.1.0

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

func NewK8sDeploymentCache(
	ctx context.Context,
	lggr logr.Logger,
	cl DeploymentListerWatcher,
) (*K8sDeploymentCache, error)

func (k *K8sDeploymentCache) Get(name string) (appsv1.Deployment, error)

func (k *K8sDeploymentCache) MarshalJSON() ([]byte, error)

func (k *K8sDeploymentCache) StartWatcher(
	ctx context.Context,
	lggr logr.Logger,
	fetchTickDur time.Duration,
) error

func (k *K8sDeploymentCache) Watch(name string) watch.Interface

type MemoryDeploymentCache ¶ added in v0.1.0

type MemoryDeploymentCache struct {
	// RWM protects all accesses to either of Watchers or Deployments
	RWM *sync.RWMutex

	// Watchers holds watchers to be returned by calls to Watch. If Watch is called with a
	// name that has a key in this map, that function will panic. Otherwise, it will
	// return the corresponding value
	Watchers map[string]*watch.RaceFreeFakeWatcher

	// Deployments holds the deployments to be returned in calls to Get. If Get is called
	// with a name that exists as a key in this map, the corresponding value will be returned.
	// Otherwise, an error will be returned
	Deployments map[string]appsv1.Deployment
}

MemoryDeploymentCache is a purely in-memory DeploymentCache implementation.

To ensure this is concurrency-safe, be sure to use RWM properly to protect all accesses to either map in this struct.

func NewMemoryDeploymentCache(
	initialDeployments map[string]appsv1.Deployment,
) *MemoryDeploymentCache

func (m *MemoryDeploymentCache) Get(name string) (appsv1.Deployment, error)

func (m *MemoryDeploymentCache) MarshalJSON() ([]byte, error)

func (m *MemoryDeploymentCache) Watch(name string) watch.Interface