1
0
mirror of https://github.com/openshift/openshift-docs.git synced 2026-02-05 21:46:22 +01:00
Files
openshift-docs/modules/olm-csv.adoc
Jeff Peeler 9a55d97ae4 add clarification for OLM operator version syntax
It must be semantic version compliant.

BZ: 1724742
2019-07-18 21:50:23 +00:00

32 lines
1.1 KiB
Plaintext

// Module included in the following assemblies:
//
// * applications/operators/olm-understanding-olm.adoc
[id="olm-csv_{context}"]
= ClusterServiceVersions (CSVs)
A _ClusterServiceVersion_ (CSV) is a YAML manifest created from Operator
metadata that assists the OLM in running the Operator in a cluster. It is the
metadata that accompanies an Operator container image, used to populate user
interfaces with information like its logo, description, and version. It is also
a source of technical information needed to run the Operator, like the RBAC
rules it requires and which Custom Resources (CRs) it manages or depends on.
A CSV is composed of:
Metadata::
* Application metadata:
** Name, description, version (semver compliant), links, labels, icon, etc.
Install strategy::
* Type: Deployment
** Set of service accounts and required permissions
** Set of Deployments.
CRDs::
* Type
* Owned: Managed by this service
* Required: Must exist in the cluster for this service to run
* Resources: A list of resources that the Operator interacts with
* Descriptors: Annotate CRD spec and status fields to provide semantic information