# Functions
No description provided by the author
No description provided by the author
No description provided by the author
Kind takes an unqualified kind and returns back a Group qualified GroupKind.
NewInstallModeSet returns an InstallModeSet instantiated from the given list of InstallModes.
NewInstallPlanReference returns an InstallPlanReference for the given ObjectReference.
No description provided by the author
Resource takes an unqualified resource and returns a Group qualified GroupResource.
# Constants
AllCatalogSourcesHealthy is a reason string for Subscriptions that transitioned due to all CatalogSources being healthy.
No description provided by the author
No description provided by the author
BundleLookupFailed describes conditions types for when BundleLookups fail.
BundleLookupPending describes BundleLookups that are not complete.
CatalogSourceConfigMapError denotes when there is an issue extracting manifests from the specified ConfigMap.
No description provided by the author
CatalogSourceIntervalInvalidError denotes if the registry polling interval is invalid.
No description provided by the author
CatalogSourceRegistryServerError denotes when there is an issue querying the specified registry server.
CatalogSourcesAdded is a reason string for Subscriptions that transitioned due to CatalogSources being added.
CatalogSourcesDeleted is a reason string for Subscriptions that transitioned due to CatalogSources being removed.
CatalogSourceSpecInvalidError denotes when fields on the spec of the CatalogSource are not valid.
CatalogSourcesUpdated is a reason string for Subscriptions that transitioned due to CatalogSource being updated.
No description provided by the author
No description provided by the author
ConditionsLengthLimit is the maximum length of Status.Conditions of a given ClusterServiceVersion object.
ConversionWebhook is for conversion webhooks.
No description provided by the author
CSVPhaseAny matches all other phases in CSV queries.
CSVPhaseDeleting means that a CSV has been replaced by a new one and will be checked for safety before being deleted.
CSVPhaseFailed means that the install strategy could not be successfully completed.
CSVPhaseInstalling means that the install strategy has been initiated but not completed.
CSVPhaseInstallReady means that the requirements are met but the install strategy has not been run.
These are the valid phases of ClusterServiceVersion.
CSVPhasePending means the csv has been accepted by the system, but the install strategy has not been attempted.
CSVPhaseReplacing means that a newer CSV has been created and the csv's resources will be transitioned to a new owner.
CSVPhaseSucceeded means that the resources in the CSV were created successfully.
CSVPhaseUnknown means that for some reason the state of the csv could not be obtained.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
GroupName is the group name used in this package.
GroupVersion is the group version used in this package.
InstallModeTypeAllNamespaces indicates that the operator can be a member of an `OperatorGroup` that selects all namespaces (target namespace set is the empty string "").
InstallModeTypeMultiNamespace indicates that the operator can be a member of an `OperatorGroup` that selects more than one namespace.
InstallModeTypeOwnNamespace indicates that the operator can be a member of an `OperatorGroup` that selects its own namespace.
InstallModeTypeSingleNamespace indicates that the operator can be a member of an `OperatorGroup` that selects one namespace.
No description provided by the author
InstallPlanFailed is a reason string for Subscriptions that transitioned due to a referenced InstallPlan failing without setting an explicit failure condition.
No description provided by the author
No description provided by the author
InstallPlanNotYetReconciled is a reason string for Subscriptions that transitioned due to a referenced InstallPlan not being reconciled yet.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
MutatingAdmissionWebhook is for mutating admission webhooks.
NoCatalogSourcesFound is a reason string for Subscriptions with unhealthy CatalogSources due to none being available.
No description provided by the author
ReferencedInstallPlanNotFound is a reason string for Subscriptions that transitioned due to a referenced InstallPlan not being found.
The CRD is present but the Established condition is False (not available).
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
SourceTypeConfigmap specifies a CatalogSource that generates a configmap-server registry.
SourceTypeGrpc specifies a CatalogSource that can use an operator registry image to generate a registry-server or connect to a pre-existing registry at an address.
SourceTypeInternal (deprecated) specifies a CatalogSource of type SourceTypeConfigmap.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
SubscriptionOperatorDeprecated indicates that the Bundle currently installed with this Subscription has been deprecated.
SubscriptionBundleUnpackFailed indicates that the unpack job failed.
SubscriptionBundleUnpacking indicates that the unpack job is currently running.
SubscriptionCatalogSourcesUnhealthy indicates that some or all of the CatalogSources to be used in resolution are unhealthy.
SubscriptionOperatorDeprecated indicates that the Channel used with this Subscription has been deprecated.
No description provided by the author
SubscriptionDeprecated is a roll-up condition which indicates that the Operator currently installed with this Subscriptionhas been deprecated.
SubscriptionInstallPlanFailed indicates that the installation of a Subscription's InstallPlan has failed.
SubscriptionInstallPlanMissing indicates that a Subscription's InstallPlan is missing.
SubscriptionInstallPlanPending indicates that a Subscription's InstallPlan is pending installation.
No description provided by the author
SubscriptionOperatorDeprecated indicates that the Package currently installed with this Subscription has been deprecated.
No description provided by the author
No description provided by the author
SubscriptionResolutionFailed indicates that the dependency resolution in the namespace in which the subscription is created has failed.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
UnhealthyCatalogSourceFound is a reason string for Subscriptions that transitioned because an unhealthy CatalogSource was found.
ValidatingAdmissionWebhook is for validating admission webhooks.
# Variables
AddToScheme is a global function that registers this API group & version to a scheme.
ErrInvalidInstallPlan is the error returned by functions that operate on InstallPlans when the InstallPlan does not contain totally valid data.
SchemeBuilder initializes a scheme builder.
SchemeGroupVersion is group version used to register these objects.
# Structs
ActionDescriptor describes a declarative action that can be performed on a custom resource instance +k8s:openapi-gen=true.
APIResourceReference is a reference to a Kubernetes resource type that the referrer utilizes.
APIServiceDefinitions declares all of the extension apis managed or required by an operator being ran by ClusterServiceVersion.
APIServiceDescription provides details to OLM about apis provided via aggregation +k8s:openapi-gen=true.
+k8s:openapi-gen=true.
BundleLookup is a request to pull and unpackage the content of a bundle to the cluster.
No description provided by the author
CatalogSource is a repository of CSVs, CRDs, and operator packages.
CatalogSourceList is a repository of CSVs, CRDs, and operator packages.
No description provided by the author
No description provided by the author
+k8s:openapi-gen=true.
CleanupStatus represents information about the status of cleanup while a CSV is pending deletion +k8s:openapi-gen=true.
ClusterServiceVersion is a Custom Resource of type `ClusterServiceVersionSpec`.
Conditions appear in the status as a record of state transitions on the ClusterServiceVersion +k8s:openapi-gen=true.
ClusterServiceVersionList represents a list of ClusterServiceVersions.
ClusterServiceVersionSpec declarations tell OLM how to install an operator that can manage apps for a given version.
ClusterServiceVersionStatus represents information about the status of a CSV.
No description provided by the author
CRDDescription provides details to OLM about the CRDs +k8s:openapi-gen=true.
CustomResourceDefinitions declares all of the CRDs managed or required by an operator being ran by ClusterServiceVersion.
DependentStatus is the status for a dependent requirement (to prevent infinite nesting) +k8s:openapi-gen=true.
ExtractContentConfig configures context extraction from a file-based catalog index image.
No description provided by the author
GrpcPodConfig contains configuration specified for a catalog source.
+k8s:openapi-gen=true.
InstallMode associates an InstallModeType with a flag representing if the CSV supports it +k8s:openapi-gen=true.
InstallPlan defines the installation of a set of operators.
InstallPlanCondition represents the overall status of the execution of an InstallPlan.
InstallPlanList is a list of InstallPlan resources.
No description provided by the author
InstallPlanSpec defines a set of Application resources to be installed.
InstallPlanStatus represents the information about the status of steps required to complete installation.
+k8s:openapi-gen=true.
NamedInstallStrategy represents the block of an ClusterServiceVersion resource where the install strategy is specified.
No description provided by the author
No description provided by the author
+k8s:openapi-gen=true.
+k8s:openapi-gen=true.
+k8s:openapi-gen=true.
ResourceList represents a list of resources which are of the same Group/Kind +k8s:openapi-gen=true.
SpecDescriptor describes a field in a spec block of a CRD so that OLM can consume it +k8s:openapi-gen=true.
StatusDescriptor describes a field in a status block of a CRD so that OLM can consume it +k8s:openapi-gen=true.
Step represents the status of an individual step in an InstallPlan.
StepResource represents the status of a resource to be tracked by an InstallPlan.
StrategyDeploymentPermissions describe the rbac rules and service account needed by the install strategy +k8s:openapi-gen=true.
StrategyDeploymentSpec contains the name, spec and labels for the deployment ALM should create +k8s:openapi-gen=true.
StrategyDetailsDeployment represents the parsed details of a Deployment InstallStrategy.
Subscription keeps operators up to date by tracking changes to Catalogs.
SubscriptionCatalogHealth describes the health of a CatalogSource the Subscription knows about.
SubscriptionCondition represents the latest available observations of a Subscription's state.
SubscriptionConfig contains configuration specified for a subscription.
SubscriptionList is a list of Subscription resources.
SubscriptionSpec defines an Application that can be installed.
No description provided by the author
UpdateStrategy holds all the different types of catalog source update strategies Currently only registry polling strategy is implemented.
WebhookDescription provides details to OLM about required webhooks +k8s:openapi-gen=true.
# Type aliases
Approval is the user approval policy for an InstallPlan.
BundleLookupConditionType is a category of the overall state of a BundleLookup.
ClusterServiceVersionPhase is a label for the condition of a ClusterServiceVersion at the current time.
ConditionReason is a camelcased reason for the state transition.
InstallModeSet is a mapping of unique InstallModeTypes to whether they are supported.
InstallModeType is a supported type of install mode for CSV installation.
ConditionReason is a camelcased reason for the state transition.
InstallPlanConditionType describes the state of an InstallPlan at a certain point as a whole.
InstallPlanPhase is the current status of a InstallPlan as a whole.
No description provided by the author
SourceType indicates the type of backing store for a CatalogSource.
StatusReason is a camelcased reason for the status of a RequirementStatus or DependentStatus.
StepStatus is the current status of a particular resource an in InstallPlan.
SubscriptionConditionType indicates an explicit state condition about a Subscription in "abnormal-true" polarity form (see https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#typical-status-properties).
SubscriptionState tracks when updates are available, installing, or service is up to date.
WebhookAdmissionType is the type of admission webhooks supported by OLM.