1
0
mirror of https://github.com/openshift/openshift-docs.git synced 2026-02-07 00:48:01 +01:00
Files
openshift-docs/modules/olm-package-schema.adoc
2024-02-19 17:14:32 +00:00

35 lines
661 B
Plaintext

// Module included in the following assemblies:
//
// * operators/understanding/olm-packaging-format.adoc
[id="olm-package-schema_{context}"]
= olm.package schema
The `olm.package` schema defines package-level metadata for an Operator. This includes its name, description, default channel, and icon.
.`olm.package` schema
[%collapsible]
====
[source,go]
----
#Package: {
schema: "olm.package"
// Package name
name: string & !=""
// A description of the package
description?: string
// The package's default channel
defaultChannel: string & !=""
// An optional icon
icon?: {
base64data: string
mediatype: string
}
}
----
====