api

module

v0.10.4 Latest Latest Go to latest Published: Jul 22, 2021 License: Apache-2.0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/operator-framework/api

Links

Open Source Insights

README ¶

api

Contains the API definitions used by Operator Lifecycle Manager (OLM) and Marketplace Operator

`pkg/validation`: Operator Manifest Validation

pkg/validation exposes a convenient set of interfaces to validate Kubernetes object manifests, primarily for use in an Operator project.

Usage

You can install the operator-verify tool from source using:

$ make install

To verify your ClusterServiceVersion yaml,

$ operator-verify manifests /path/to/filename.yaml

Directories ¶

Path	Synopsis
cmd
operator-verify
operator-verify/manifests
crds Package crds contains CustomResourceDefinition manifests for operator-framework APIs.	Package crds contains CustomResourceDefinition manifests for operator-framework APIs.
pkg
apis/scorecard/v1alpha3 Package v1alpha3 contains resources types for version v1alpha3 of the scorecard.operatorframework.com API group.	Package v1alpha3 contains resources types for version v1alpha3 of the scorecard.operatorframework.com API group.
lib/version
manifests
operators Package operators contains all resource types of the operators.coreos.com API group.	Package operators contains all resource types of the operators.coreos.com API group.
operators/install
operators/reference
operators/v1 Package v1 contains resources types for version v1 of the operators.coreos.com API group.	Package v1 contains resources types for version v1 of the operators.coreos.com API group.
operators/v1alpha1 Package v1alpha1 contains resources types for version v1alpha1 of the operators.coreos.com API group.	Package v1alpha1 contains resources types for version v1alpha1 of the operators.coreos.com API group.
operators/v1alpha2 Package v1alpha2 contains resources types for version v1alpha2 of the operators.coreos.com API group.	Package v1alpha2 contains resources types for version v1alpha2 of the operators.coreos.com API group.
operators/v2 Package v2 contains resources types for version v2 of the operators.coreos.com API group.	Package v2 contains resources types for version v2 of the operators.coreos.com API group.
validation This package defines the valid Operator manifests directory format by exposing a set of Validator's to verify a directory and its constituent manifests.	This package defines the valid Operator manifests directory format by exposing a set of Validator's to verify a directory and its constituent manifests.
validation/errors
validation/interfaces
validation/internal

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL

README ¶

api

pkg/validation: Operator Manifest Validation

Usage

Directories ¶

`pkg/validation`: Operator Manifest Validation