Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type HostOperator ¶
type HostOperator interface {
queueinformer.ObservableOperator
queueinformer.ExtensibleOperator
Informers() map[string]*Informers
}
HostOperator is an extensible and observable operator that hosts the plug-in, i.e. which the plug-in is extending
type Informers ¶ added in v0.26.0
type Informers struct {
CSVInformer operatorsv1alpha1informers.ClusterServiceVersionInformer
CopiedCSVInformer cache.SharedIndexInformer
CopiedCSVLister metadatalister.Lister
OperatorGroupInformer operatorsv1informers.OperatorGroupInformer
OperatorConditionInformer operatorsv2informers.OperatorConditionInformer
SubscriptionInformer operatorsv1alpha1informers.SubscriptionInformer
DeploymentInformer appsv1informers.DeploymentInformer
RoleInformer rbacv1informers.RoleInformer
RoleBindingInformer rbacv1informers.RoleBindingInformer
SecretInformer corev1informers.SecretInformer
ServiceInformer corev1informers.ServiceInformer
ServiceAccountInformer corev1informers.ServiceAccountInformer
OLMConfigInformer operatorsv1informers.OLMConfigInformer
ClusterRoleInformer rbacv1informers.ClusterRoleInformer
ClusterRoleBindingInformer rbacv1informers.ClusterRoleBindingInformer
NamespaceInformer corev1informers.NamespaceInformer
APIServiceInformer apiregistrationv1informers.APIServiceInformer
CRDInformer cache.SharedIndexInformer
CRDLister metadatalister.Lister
}
Informers exposes informer caches that the host operator has already started, for re-use by plugins.
type OperatorConfig ¶
type OperatorConfig interface {
OperatorClient() operatorclient.ClientInterface
ExternalClient() versioned.Interface
ResyncPeriod() func() time.Duration
WatchedNamespaces() []string
Logger() *logrus.Logger
}
OperatorConfig gives access to required configuration from the host operator
type OperatorPlugInFactoryFunc ¶
type OperatorPlugInFactoryFunc func(ctx context.Context, config OperatorConfig, hostOperator HostOperator) (OperatorPlugin, error)
OperatorPlugInFactoryFunc factory function that returns a new instance of a plug-in
type OperatorPlugin ¶
type OperatorPlugin interface {
// Shutdown is called once the host operator is done
// to give the plug-in a change to clean up resources if necessary
Shutdown() error
}
OperatorPlugin provides a simple interface that can be used to extend the olm operator's functionality
Click to show internal directories.
Click to hide internal directories.