ClusterServiceVersion [operators.coreos.com/v1alpha1]

annotations

object (string)

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata.

apiservicedefinitions

object

APIServiceDefinitions declares all of the extension apis managed or required by an operator being ran by ClusterServiceVersion.

cleanup

object

Cleanup specifies the cleanup behaviour when the CSV gets deleted

customresourcedefinitions

object

CustomResourceDefinitions declares all of the CRDs managed or required by an operator being ran by ClusterServiceVersion. If the CRD is present in the Owned list, it is implicitly required.

description

string

Description of the operator. Can include the features, limitations or use-cases of the operator.

displayName

string

The name of the operator in display format.

icon

array

The icon for this operator.

icon[]

object

install

object

NamedInstallStrategy represents the block of an ClusterServiceVersion resource where the install strategy is specified.

installModes

array

InstallModes specify supported installation types

installModes[]

object

InstallMode associates an InstallModeType with a flag representing if the CSV supports it

keywords

array (string)

A list of keywords describing the operator.

labels

object (string)

Map of string keys and values that can be used to organize and categorize (scope and select) objects.

links

array

A list of links related to the operator.

links[]

object

maintainers

array

A list of organizational entities maintaining the operator.

maintainers[]

object

maturity

string

minKubeVersion

string

nativeAPIs

array

nativeAPIs[]

object

GroupVersionKind unambiguously identifies a kind. It doesn’t anonymously include GroupVersion to avoid automatic coercion. It doesn’t use a GroupVersion to avoid custom marshalling

provider

object

The publishing entity behind the operator.

relatedImages

array

List any related images, or other container images that your Operator might require to perform their functions. This list should also include operand images as well. All image references should be specified by digest (SHA) and not by tag. This field is only used during catalog creation and plays no part in cluster runtime.

relatedImages[]

object

replaces

string

The name of a CSV this one replaces. Should match the metadata.Name field of the old CSV.

selector

object

Label selector for related resources.

skips

array (string)

The name(s) of one or more CSV(s) that should be skipped in the upgrade graph. Should match the metadata.Name field of the CSV that should be skipped. This field is only used during catalog creation and plays no part in cluster runtime.

version

string

webhookdefinitions

array

webhookdefinitions[]

object

WebhookDescription provides details to OLM about required webhooks

owned

array

owned[]

object

APIServiceDescription provides details to OLM about apis provided via aggregation

required

array

required[]

object

APIServiceDescription provides details to OLM about apis provided via aggregation

actionDescriptors

array

actionDescriptors[]

object

ActionDescriptor describes a declarative action that can be performed on a custom resource instance

containerPort

integer

deploymentName

string

description

string

displayName

string

group

string

kind

string

name

string

resources

array

resources[]

object

APIResourceReference is a reference to a Kubernetes resource type that the referrer utilizes.

specDescriptors

array

specDescriptors[]

object

SpecDescriptor describes a field in a spec block of a CRD so that OLM can consume it

statusDescriptors

array

statusDescriptors[]

object

StatusDescriptor describes a field in a status block of a CRD so that OLM can consume it

version

string

description

string

displayName

string

path

string

value

string

RawMessage is a raw encoded JSON value. It implements Marshaler and Unmarshaler and can be used to delay JSON decoding or precompute a JSON encoding.

x-descriptors

array (string)

kind

string

Kind of the referenced resource type.

name

string

Plural name of the referenced resource type (CustomResourceDefinition.Spec.Names[].Plural). Empty string if the referenced resource type is not a custom resource.

version

string

API Version of the referenced resource type.

description

string

displayName

string

path

string

value

string

RawMessage is a raw encoded JSON value. It implements Marshaler and Unmarshaler and can be used to delay JSON decoding or precompute a JSON encoding.

x-descriptors

array (string)

description

string

displayName

string

path

string

value

string

RawMessage is a raw encoded JSON value. It implements Marshaler and Unmarshaler and can be used to delay JSON decoding or precompute a JSON encoding.

x-descriptors

array (string)

actionDescriptors

array

actionDescriptors[]

object

ActionDescriptor describes a declarative action that can be performed on a custom resource instance

containerPort

integer

deploymentName

string

description

string

displayName

string

group

string

kind

string

name

string

resources

array

resources[]

object

APIResourceReference is a reference to a Kubernetes resource type that the referrer utilizes.

specDescriptors

array

specDescriptors[]

object

SpecDescriptor describes a field in a spec block of a CRD so that OLM can consume it

statusDescriptors

array

statusDescriptors[]

object

StatusDescriptor describes a field in a status block of a CRD so that OLM can consume it

version

string

description

string

displayName

string

path

string

value

string

RawMessage is a raw encoded JSON value. It implements Marshaler and Unmarshaler and can be used to delay JSON decoding or precompute a JSON encoding.

x-descriptors

array (string)

kind

string

Kind of the referenced resource type.

name

string

Plural name of the referenced resource type (CustomResourceDefinition.Spec.Names[].Plural). Empty string if the referenced resource type is not a custom resource.

version

string

API Version of the referenced resource type.

description

string

displayName

string

path

string

value

string

RawMessage is a raw encoded JSON value. It implements Marshaler and Unmarshaler and can be used to delay JSON decoding or precompute a JSON encoding.

x-descriptors

array (string)

description

string

displayName

string

path

string

value

string

RawMessage is a raw encoded JSON value. It implements Marshaler and Unmarshaler and can be used to delay JSON decoding or precompute a JSON encoding.

x-descriptors

array (string)

enabled

boolean

owned

array

owned[]

object

CRDDescription provides details to OLM about the CRDs

required

array

required[]

object

CRDDescription provides details to OLM about the CRDs

actionDescriptors

array

actionDescriptors[]

object

ActionDescriptor describes a declarative action that can be performed on a custom resource instance

description

string

displayName

string

kind

string

name

string

resources

array

resources[]

object

APIResourceReference is a reference to a Kubernetes resource type that the referrer utilizes.

specDescriptors

array

specDescriptors[]

object

SpecDescriptor describes a field in a spec block of a CRD so that OLM can consume it

statusDescriptors

array

statusDescriptors[]

object

StatusDescriptor describes a field in a status block of a CRD so that OLM can consume it

version

string

description

string

displayName

string

path

string

value

string

RawMessage is a raw encoded JSON value. It implements Marshaler and Unmarshaler and can be used to delay JSON decoding or precompute a JSON encoding.

x-descriptors

array (string)

kind

string

Kind of the referenced resource type.

name

string

Plural name of the referenced resource type (CustomResourceDefinition.Spec.Names[].Plural). Empty string if the referenced resource type is not a custom resource.

version

string

API Version of the referenced resource type.

description

string

displayName

string

path

string

value

string

RawMessage is a raw encoded JSON value. It implements Marshaler and Unmarshaler and can be used to delay JSON decoding or precompute a JSON encoding.

x-descriptors

array (string)

description

string

displayName

string

path

string

value

string

RawMessage is a raw encoded JSON value. It implements Marshaler and Unmarshaler and can be used to delay JSON decoding or precompute a JSON encoding.

x-descriptors

array (string)

actionDescriptors

array

actionDescriptors[]

object

ActionDescriptor describes a declarative action that can be performed on a custom resource instance

description

string

displayName

string

kind

string

name

string

resources

array

resources[]

object

APIResourceReference is a reference to a Kubernetes resource type that the referrer utilizes.

specDescriptors

array

specDescriptors[]

object

SpecDescriptor describes a field in a spec block of a CRD so that OLM can consume it

statusDescriptors

array

statusDescriptors[]

object

StatusDescriptor describes a field in a status block of a CRD so that OLM can consume it

version

string

description

string

displayName

string

path

string

value

string

RawMessage is a raw encoded JSON value. It implements Marshaler and Unmarshaler and can be used to delay JSON decoding or precompute a JSON encoding.

x-descriptors

array (string)

kind

string

Kind of the referenced resource type.

name

string

Plural name of the referenced resource type (CustomResourceDefinition.Spec.Names[].Plural). Empty string if the referenced resource type is not a custom resource.

version

string

API Version of the referenced resource type.

description

string

displayName

string

path

string

value

string

RawMessage is a raw encoded JSON value. It implements Marshaler and Unmarshaler and can be used to delay JSON decoding or precompute a JSON encoding.

x-descriptors

array (string)

description

string

displayName

string

path

string

value

string

RawMessage is a raw encoded JSON value. It implements Marshaler and Unmarshaler and can be used to delay JSON decoding or precompute a JSON encoding.

x-descriptors

array (string)

base64data

string

mediatype

string

spec

object

StrategyDetailsDeployment represents the parsed details of a Deployment InstallStrategy.

strategy

string

clusterPermissions

array

clusterPermissions[]

object

StrategyDeploymentPermissions describe the rbac rules and service account needed by the install strategy

deployments

array

deployments[]

object

StrategyDeploymentSpec contains the name, spec and labels for the deployment ALM should create

permissions

array

permissions[]

object

StrategyDeploymentPermissions describe the rbac rules and service account needed by the install strategy

rules

array

rules[]

object

PolicyRule holds information that describes a policy rule, but does not contain information about who the rule applies to or which namespace the rule applies to.

serviceAccountName

string

apiGroups

array (string)

APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of the enumerated resources in any API group will be allowed. "" represents the core API group and "*" represents all API groups.

nonResourceURLs

array (string)

NonResourceURLs is a set of partial urls that a user should have access to. *s are allowed, but only as the full, final step in the path Since non-resource URLs are not namespaced, this field is only applicable for ClusterRoles referenced from a ClusterRoleBinding. Rules can either apply to API resources (such as "pods" or "secrets") or non-resource URL paths (such as "/api"), but not both.

resourceNames

array (string)

ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.

resources

array (string)

Resources is a list of resources this rule applies to. '*' represents all resources.

verbs

array (string)

Verbs is a list of Verbs that apply to ALL the ResourceKinds contained in this rule. '*' represents all verbs.

label

object (string)

Set is a map of label:value. It implements Labels.

name

string

spec

object

DeploymentSpec is the specification of the desired behavior of the Deployment.

minReadySeconds

integer

Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready)

paused

boolean

Indicates that the deployment is paused.

progressDeadlineSeconds

integer

The maximum time in seconds for a deployment to make progress before it is considered to be failed. The deployment controller will continue to process failed deployments and a condition with a ProgressDeadlineExceeded reason will be surfaced in the deployment status. Note that progress will not be estimated during the time a deployment is paused. Defaults to 600s.

replicas

integer

Number of desired pods. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1.

revisionHistoryLimit

integer

The number of old ReplicaSets to retain to allow rollback. This is a pointer to distinguish between explicit zero and not specified. Defaults to 10.

selector

object

Label selector for pods. Existing ReplicaSets whose pods are selected by this will be the ones affected by this deployment. It must match the pod template’s labels.

strategy

object

The deployment strategy to use to replace existing pods with new ones.

template

object

Template describes the pods that will be created. The only allowed template.spec.restartPolicy value is "Always".

matchExpressions

array

matchExpressions is a list of label selector requirements. The requirements are ANDed.

matchExpressions[]

object

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

matchLabels

object (string)

matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

key

string

key is the label key that the selector applies to.

operator

string

operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values

array (string)

values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

rollingUpdate

object

Rolling update config params. Present only if DeploymentStrategyType = RollingUpdate. --- TODO: Update this to follow our convention for oneOf, whatever we decide it to be.

type

string

Type of deployment. Can be "Recreate" or "RollingUpdate". Default is RollingUpdate.

maxSurge

integer-or-string

The maximum number of pods that can be scheduled above the desired number of pods. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). This can not be 0 if MaxUnavailable is 0. Absolute number is calculated from percentage by rounding up. Defaults to 25%. Example: when this is set to 30%, the new ReplicaSet can be scaled up immediately when the rolling update starts, such that the total number of old and new pods do not exceed 130% of desired pods. Once old pods have been killed, new ReplicaSet can be scaled up further, ensuring that total number of pods running at any time during the update is at most 130% of desired pods.

maxUnavailable

integer-or-string

The maximum number of pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). Absolute number is calculated from percentage by rounding down. This can not be 0 if MaxSurge is 0. Defaults to 25%. Example: when this is set to 30%, the old ReplicaSet can be scaled down to 70% of desired pods immediately when the rolling update starts. Once new pods are ready, old ReplicaSet can be scaled down further, followed by scaling up the new ReplicaSet, ensuring that the total number of pods available at all times during the update is at least 70% of desired pods.

metadata