pullsubscription

Documentation

Overview

Package pullsubscription implements the Pub/Sub PullSubscription controllers.

Index

• type Base
  • func (r *Base) GetOrCreateReceiveAdapter(ctx context.Context, desired *appsv1.Deployment, ...) (*appsv1.Deployment, error)
  • func (r *Base) Reconcile(ctx context.Context, key string) error
  • func (r *Base) UpdateFromLoggingConfigMap(cfg *corev1.ConfigMap)
  • func (r *Base) UpdateFromMetricsConfigMap(cfg *corev1.ConfigMap)
  • func (r *Base) UpdateFromTracingConfigMap(cfg *corev1.ConfigMap)
• type ReconcileDataPlaneFunc

Types

type Base

type Base struct {
	*pubsub.PubSubBase
	// DeploymentLister index properties about deployments.
	DeploymentLister appsv1listers.DeploymentLister
	// PullSubscriptionLister index properties about pullsubscriptions.
	PullSubscriptionLister listers.PullSubscriptionLister

	UriResolver *resolver.URIResolver

	ReceiveAdapterImage string
	ControllerAgentName string
	FinalizerName       string

	LoggingConfig *logging.Config
	MetricsConfig *metrics.ExporterOptions
	TracingConfig *tracingconfig.Config

	// CreateClientFn is the function used to create the Pub/Sub client that interacts with Pub/Sub.
	// This is needed so that we can inject a mock client for UTs purposes.
	CreateClientFn gpubsub.CreateFn

	// ReconcileDataPlaneFn is the function used to reconcile the data plane resources.
	ReconcileDataPlaneFn ReconcileDataPlaneFunc
}

Base implements the core controller logic for pullsubscription.

func (*Base) GetOrCreateReceiveAdapter

func (r *Base) GetOrCreateReceiveAdapter(ctx context.Context, desired *appsv1.Deployment, src *v1alpha1.PullSubscription) (*appsv1.Deployment, error)

func (*Base) Reconcile

func (r *Base) Reconcile(ctx context.Context, key string) error

Reconcile compares the actual state with the desired, and attempts to converge the two. It then updates the Status block of the PullSubscription resource with the current status of the resource.

func (*Base) UpdateFromLoggingConfigMap

func (r *Base) UpdateFromLoggingConfigMap(cfg *corev1.ConfigMap)

func (*Base) UpdateFromMetricsConfigMap

func (r *Base) UpdateFromMetricsConfigMap(cfg *corev1.ConfigMap)

func (*Base) UpdateFromTracingConfigMap

func (r *Base) UpdateFromTracingConfigMap(cfg *corev1.ConfigMap)

type ReconcileDataPlaneFunc

type ReconcileDataPlaneFunc func(ctx context.Context, d *appsv1.Deployment, ps *v1alpha1.PullSubscription) error

ReconcileDataPlaneFunc is used to reconcile the data plane component(s).