probe

Documentation

Index

• Constants
• func IsServiceCatalogCustomResourceDefinition(crd apiextensions.CustomResourceDefinition) bool
• type CRDProbe
  • func NewCRDProbe(apiextensionsClient apiextensionsclientset.Interface, delay int) *CRDProbe
  • func (r *CRDProbe) Check(req *http.Request) error
  • func (r *CRDProbe) IsReady(ctx context.Context) (bool, error)
  • func (r CRDProbe) Name() string

Constants

const (
	// CRDsAmount define the whole number of CRDs registered by the Service Catalog
	CRDsAmount = 8

	// ClusterServiceBroker define the name of the ClusterServiceBroker CRD
	ClusterServiceBroker = "clusterservicebrokers.servicecatalog.k8s.io"
	// ServiceBroker define the name of the ServiceBroker CRD
	ServiceBroker = "servicebrokers.servicecatalog.k8s.io"
	// ServiceClass define the name of the ServiceClass CRD
	ServiceClass = "serviceclasses.servicecatalog.k8s.io"
	// ClusterServiceClass define the name of the ClusterServiceClass CRD
	ClusterServiceClass = "clusterserviceclasses.servicecatalog.k8s.io"
	// ServicePlan define the name of the ServicePlan CRD
	ServicePlan = "serviceplans.servicecatalog.k8s.io"
	// ClusterServicePlan define the name of the ClusterServicePlan CRD
	ClusterServicePlan = "clusterserviceplans.servicecatalog.k8s.io"
	// ServiceInstance define the name of the ServiceInstance CRD
	ServiceInstance = "serviceinstances.servicecatalog.k8s.io"
	// ServiceBinding define the name of the ServiceBinding CRD
	ServiceBinding = "servicebindings.servicecatalog.k8s.io"

	// CRDProbeIterationGap - the number of iterations after which the CRD probe action is performed
	// All probes are run after the time period defined in the `periodSeconds` parameter in the chart
	// Time needed for the CRD Probe to execute is `periodSeconds` * CRDProbeIterationGap
	CRDProbeIterationGap = 60
)

Functions

func IsServiceCatalogCustomResourceDefinition

func IsServiceCatalogCustomResourceDefinition(crd apiextensions.CustomResourceDefinition) bool

IsServiceCatalogCustomResourceDefinition checks if CRD belongs to ServiceCatalog crd

Types

type CRDProbe

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

CRDProbe provides functionality that ensures that all ServiceCatalog CRDs are ready

func NewCRDProbe

func NewCRDProbe(apiextensionsClient apiextensionsclientset.Interface, delay int) *CRDProbe

NewCRDProbe returns pointer to CRDProbe

func (*CRDProbe) Check

func (r *CRDProbe) Check(req *http.Request) error

Check if all CRDs with specific label are ready

func (*CRDProbe) IsReady

func (r *CRDProbe) IsReady(ctx context.Context) (bool, error)

IsReady returns true if all required CRDs are ready

func (CRDProbe) Name

func (r CRDProbe) Name() string

Name returns name of CRD probe