package
1.20.0-rc.0
Repository: https://github.com/crossplane/crossplane-runtime.git
Documentation: pkg.go.dev

# Packages

Package fake provides fake Crossplane resources for use in tests.
Package unstructured contains utilities unstructured Kubernetes objects.

# Functions

AllowUpdateIf will only update the current object if the supplied fn returns true.
AsProtobufStruct converts the given object to a structpb.Struct for usage with gRPC connections.
CommonCredentialExtractor extracts credentials from common sources.
ConnectionSecretFor creates a connection for the supplied ConnectionSecretOwner, assumed to be of the supplied kind.
ConnectionSecretMustBeControllableBy requires that the current object is a connection secret that is controllable by an object with the supplied UID.
DesiredStateChanged accepts objects that have changed their desired state, i.e.
ExtractEnv extracts credentials from an environment variable.
ExtractFs extracts credentials from the filesystem.
ExtractSecret extracts credentials from a Kubernetes secret.
FirstNAndSomeMore returns a string that contains the first n names in the supplied slice, followed by ", and <count> more" if there are more than n.
GetExternalTags returns the identifying tags to be used to tag the external resource in provider API.
GetKind returns the GroupVersionKind of the supplied object.
Ignore any errors that satisfy the supplied ErrorIs function by returning nil.
IgnoreAny ignores errors that satisfy any of the supplied ErrorIs functions by returning nil.
IgnoreNotFound returns the supplied error, or nil if the error indicates a Kubernetes resource was not found.
IsAPIError returns true if the given error's type is of Kubernetes API error.
IsAPIErrorWrapped returns true if err is a K8s API error, or recursively wraps a K8s API error.
IsConditionTrue returns if condition status is true.
IsMissingReference returns true if an error indicates that a managed resource is missing a required reference..
IsNotAllowed returns true if the supplied error indicates that an operation was not allowed.
IsNotControllable returns true if the supplied error indicates that a resource is not controllable - i.e.
LocalConnectionSecretFor creates a connection secret in the namespace of the supplied LocalConnectionSecretOwner, assumed to be of the supplied kind.
MustBeControllableBy requires that the current object is controllable by an object with the supplied UID.
MustCreateObject returns a new Object of the supplied kind.
MustGetKind returns the GroupVersionKind of the supplied object.
NewAPIFinalizer returns a new APIFinalizer.
NewAPIPatchingApplicator returns an Applicator that applies changes to an object by either creating or patching it in a Kubernetes API server.
NewAPIUpdatingApplicator returns an Applicator that applies changes to an object by either creating or updating it in a Kubernetes API server.
NewApplicatorWithRetry returns an ApplicatorWithRetry for the specified applicator and with the specified retry function.
NewLateInitializer returns a new instance of *LateInitializer.
NewNopFinalizer returns a Finalizer that does nothing.
NewNotAllowed returns a new NotAllowed error.
NewPredicates returns a set of Funcs that are all satisfied by the supplied PredicateFn.
NewProviderConfigUsageTracker creates a ProviderConfigUsageTracker.
StableNAndSomeMore is like FirstNAndSomeMore, but sorts the names before.
StoreCurrentRV stores the resource version of the current object in the supplied string pointer.
UpdateFn returns an ApplyOption that is used to modify the current object to match fields of the desired.

# Constants

DefaultFirstN is the default number of names to return in FirstNAndSomeMore.
External resources are tagged/labelled with the following keys in the cloud provider API if the type supports.
External resources are tagged/labelled with the following keys in the cloud provider API if the type supports.
External resources are tagged/labelled with the following keys in the cloud provider API if the type supports.
Reference statuses.
Reference statuses.
Reference statuses.
Reference statuses.
SecretTypeConnection is the type of Crossplane connection secrets.

# Structs

AnnotationChangedPredicate implements a default update predicate function on annotation change by ignoring the given annotation keys, if any.
An APIFinalizer adds and removes finalizers to and from a resource.
An APIPatchingApplicator applies changes to an object by either creating or patching it in a Kubernetes API server.
An APIUpdatingApplicator applies changes to an object by either creating or updating it in a Kubernetes API server.
An ApplicatorWithRetry applies changes to an object, retrying on transient failures.
A ClientApplicator may be used to build a single 'client' that satisfies both client.Client and Applicator.
EnqueueRequestForProviderConfig enqueues a reconcile.Request for a referenced ProviderConfig.
A FinalizerFns satisfy the Finalizer interface.
LateInitializer contains functions to late initialize two fields with varying types.
ProviderConfigKinds contains the type metadata for a kind of provider config.
A ProviderConfigUsageTracker tracks usages of a ProviderConfig by creating or updating the appropriate ProviderConfigUsage.
ReferenceStatus has the name and status of a reference.

# Interfaces

An Applicator applies changes to an object.
An AttributeReferencer resolves cross-resource attribute references.
A ClaimReferencer may reference a resource claim.
Composed resources can be a composed into a Composite resource.
A ComposedResourcesReferencer may reference the resources it composes.
A Composite resource composes one or more Composed resources.
A CompositeClaim for a Composite resource.
A CompositeResourceDeleter creates a composite, and controls the policy used to delete the composite.
A CompositeResourceReferencer can reference a composite resource.
A CompositionReferencer may reference a composition of resources.
A CompositionRevisionReferencer may reference a specific revision of a composition of resources.
A CompositionRevisionSelector may reference a set of composition revisions.
A CompositionSelector may select a composition of resources.
A CompositionUpdater uses a composition, and may update which revision of that composition it uses.
A Conditioned may have conditions set or retrieved.
A ConnectionDetailsPublishedTimer can record the last time its connection details were published.
A ConnectionDetailsPublisherTo may write a connection details secret to a secret store.
A ConnectionSecretOwner is a Kubernetes object that owns a connection secret.
A ConnectionSecretWriterTo may write a connection secret to an arbitrary namespace.
An EnvironmentConfigReferencer references a list of EnvironmentConfigs.
A Finalizer manages the finalizers on the resource.
A LocalConnectionSecretOwner may create and manage a connection secret in its own namespace.
A LocalConnectionSecretWriterTo may write a connection secret to its own namespace.
A Manageable resource may specify a ManagementPolicies.
A Managed is a Kubernetes object representing a concrete managed resource (e.g.
A ManagedList is a list of managed resources.
A ManagedResourceReferencer may reference a concrete managed resource.
An Object is a Kubernetes object.
An Orphanable resource may specify a DeletionPolicy.
A ProviderConfig configures a Crossplane provider.
A ProviderConfigReferencer may reference a provider config resource.
A ProviderConfigUsage indicates a usage of a Crossplane provider config.
A ProviderConfigUsageList is a list of provider config usages.
ReconciliationObserver can track data observed by resource reconciler.
A RequiredProviderConfigReferencer may reference a provider config resource.
A RequiredTypedResourceReferencer can reference a resource.
A Tracker tracks managed resources.
A UserCounter can count how many users it has.

# Type aliases

An ApplyFn is a function that satisfies the Applicator interface.
An ApplyOption is called before patching the current object to match the desired object.
A CanReference is a resource that can reference another resource in its spec in order to automatically resolve corresponding spec field values by inspecting the referenced resource.
A CompositeClaimKind contains the type metadata for a kind of composite resource claim.
A CompositeKind contains the type metadata for a kind of composite resource.
EnvLookupFn looks up an environment variable.
An ErrorIs function returns true if an error satisfies a particular condition.
A ManagedKind contains the type metadata for a kind of managed resource.
A PredicateFn returns true if the supplied object should be reconciled.
ReferenceStatusType is an enum type for the possible values for a Reference Status.
A TrackerFn is a function that tracks managed resources.