Documentation ¶
Overview ¶
This package defines the valid Operator manifests directory format by exposing a set of Validator's to verify a directory and its constituent manifests. A manifests directory consists of a package manifest and a set of versioned Bundles. Each Bundle contains a ClusterServiceVersion and one or more CustomResourceDefinition's.
Errors and warnings, both represented by the Error type, are returned by exported functions for missing mandatory and optional fields, respectively. Each Error implements the error interface.
Bundle format: https://github.com/operator-framework/operator-registry/#manifest-format ClusterServiceVersion documentation: https://github.com/operator-framework/operator-lifecycle-manager/blob/master/Documentation/design/building-your-csv.md Package manifest documentation: https://github.com/operator-framework/operator-lifecycle-manager#discovery-catalogs-and-automated-upgrades CustomResourceDefinition documentation: https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
Index ¶
Constants ¶
This section is empty.
Variables ¶
var AllValidators = interfaces.Validators{ PackageManifestValidator, ClusterServiceVersionValidator, CustomResourceDefinitionValidator, BundleValidator, OperatorHubValidator, ObjectValidator, OperatorGroupValidator, CommunityOperatorValidator, }
AllValidators implements Validator to validate all Operator manifest types.
var BundleValidator = internal.BundleValidator
BundleValidator implements Validator to validate Bundles.
var ClusterServiceVersionValidator = internal.CSVValidator
ClusterServiceVersionValidator implements Validator to validate ClusterServiceVersions.
var CommunityOperatorValidator = internal.CommunityOperatorValidator
CommunityOperatorValidator implements Validator to validate bundle objects for the Community Operator requirements.
var CustomResourceDefinitionValidator = internal.CRDValidator
CustomResourceDefinitionValidator implements Validator to validate CustomResourceDefinitions.
var DefaultBundleValidators = interfaces.Validators{ ClusterServiceVersionValidator, CustomResourceDefinitionValidator, BundleValidator, }
var ObjectValidator = internal.ObjectValidator
Object Validator validates various custom objects in the bundle like PDBs and SCCs. Object validation is optional and not a default-level validation.
var OperatorGroupValidator = internal.OperatorGroupValidator
OperatorGroupValidator implements Validator to validate OperatorGroup manifests
var OperatorHubValidator = internal.OperatorHubValidator
OperatorHubValidator implements Validator to validate bundle objects for OperatorHub.io requirements.
var PackageManifestValidator = internal.PackageManifestValidator
PackageManifestValidator implements Validator to validate package manifests.
Functions ¶
This section is empty.
Types ¶
This section is empty.