Documentation
¶
Overview ¶
Package initializingworkspaces provides a sigs.k8s.io/multicluster-runtime provider implementation for interacting with initializing virtual workspace exposed by a kcp instance. This provider can be used for writing controllers that reconcile Workspaces in the Initializing phase.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Options ¶
type Options struct {
// Scheme is the scheme to use for the provider. If this is nil, it defaults
// to the client-go scheme.
Scheme *runtime.Scheme
// Log is the logger to use for the provider. If this is nil, it defaults
// to the controller-runtime default logger.
Log *logr.Logger
// ObjectToWatch is the object type that the provider watches via a /clusters/*
// wildcard endpoint to extract information about logical clusters joining and
// leaving the "fleet" of (logical) clusters in kcp. If this is nil, it defaults
// to [kcpcorev1alpha1.LogicalCluster]. This might be useful when using this provider
// against custom virtual workspaces that are not the APIExport one but share
// the same endpoint semantics.
ObjectToWatch client.Object
// Handlers are lifecycle handlers, ran for each logical cluster in the provider represented
// by LogicalCluster object.
Handlers handlers.Handlers
}
Options are the options for creating a new instance of the initializing workspaces provider.
type Provider ¶
Provider is a sigs.k8s.io/multicluster-runtime/pkg/multicluster.Provider that represents each logical cluster (in the kcp sense) having a specific initializer and exposed via the initializingworkspaces virtual workspace endpoint as a cluster in the sigs.k8s.io/multicluster-runtime sense.