validation

Documentation

Overview

- CustomResourceDefinition documentation: https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/

Index

• Variables

Variables

var AllValidators = interfaces.Validators{
	PackageManifestValidator,
	ClusterServiceVersionValidator,
	CustomResourceDefinitionValidator,
	BundleValidator,
	OperatorHubV2Validator,
	StandardCategoriesValidator,
	StandardCapabilitiesValidator,
	ObjectValidator,
	OperatorGroupValidator,
	CommunityOperatorValidator,
	AlphaDeprecatedAPIsValidator,
	GoodPracticesValidator,
	MultipleArchitecturesValidator,
}

AllValidators implements Validator to validate all Operator manifest types.

var AlphaDeprecatedAPIsValidator = internal.AlphaDeprecatedAPIsValidator

AlphaDeprecatedAPIsValidator implements Validator to validate bundle objects for API deprecation requirements.

Note that this validator looks at the manifests. If any removed APIs for the mapped k8s versions are found, it raises a warning.

This validator only raises an error when the deprecated API found is removed in the specified k8s version informed via the optional key `k8s-version`.

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.

Deprecated - The checks made for this validator were moved to the external one: https://github.com/redhat-openshift-ecosystem/ocp-olm-catalog-validator. Please no longer use this check it will be removed in the next releases.

var CustomResourceDefinitionValidator = internal.CRDValidator

CustomResourceDefinitionValidator implements Validator to validate CustomResourceDefinitions.

var DefaultBundleValidators = interfaces.Validators{
	ClusterServiceVersionValidator,
	CustomResourceDefinitionValidator,
	BundleValidator,
}

var GoodPracticesValidator = internal.GoodPracticesValidator

GoodPracticesValidator implements Validator to validate the criteria defined as good practices

var MultipleArchitecturesValidator = internal.MultipleArchitecturesValidator

MultipleArchitecturesValidator implements Validator to validate MultipleArchitectures configuration. For further information check: https://olm.operatorframework.io/docs/advanced-tasks/ship-operator-supporting-multiarch/

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 OperatorHubV2Validator = internal.OperatorHubV2Validator

OperatorHubV2Validator implements Validator to validate bundle objects for OperatorHub.io requirements.

var OperatorHubValidator = internal.OperatorHubValidator

OperatorHubValidator implements Validator to validate bundle objects for OperatorHub.io requirements.

Deprecated: Use OperatorHubV2Validator, StandardCapabilitiesValidator and StandardCategoriesValidator for equivalent functionality.

var PackageManifestValidator = internal.PackageManifestValidator

PackageManifestValidator implements Validator to validate package manifests.

var StandardCapabilitiesValidator = internal.StandardCapabilitiesValidator

StandardCapabilitiesValidator implements Validator to validate bundle objects for OperatorHub.io requirements around UI capability metadata

var StandardCategoriesValidator = internal.StandardCategoriesValidator

StandardCategoriesValidator implements Validator to validate bundle objects for OperatorHub.io requirements around UI category metadata