Kubernetes Operators

Kubernetes Operators extend the Kubernetes API for managing complex stateful applications using custom resources and controllers. An Operator encodes the operational knowledge of a domain expert into software that automates the deployment, scaling, and management of Kubernetes applications.

Documentation Provider Profile APIs.io AsyncAPI GitHub

This event API exposes 5 operations across 5 channels, and defines 6 schemas. It is described by AsyncAPI 2.6.0, at version v1.32.0.

The API connects through a single server, https://kubernetes.default.svc (https).

5 operations 5 channels 6 schemas

Metadata

The identity and technical contract details declared by the specification.

Specification

AsyncAPI 2.6.0

API Version

v1.32.0

Server

https://kubernetes.default.svc (https)

Contact

Operator Framework Community

Resource Areas

Channels & Operations 5

Across 5 channels, the API surfaces 5 operations. Each is listed below with its action, channel, parameters, and response codes.

Channels 5

SUB

/apis/apiextensions.k8s.io/v1/customresourcedefinitions

Watch all CustomResourceDefinitions

watchCustomResourceDefinitions body

SUB

/apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/catalogsources

Watch CatalogSources in a namespace

watchNamespacedCatalogSources 1 param body

SUB

/apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/subscriptions

Watch Subscriptions in a namespace

watchNamespacedSubscriptions 1 param body

SUB

/apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/installplans

Watch InstallPlans in a namespace

watchNamespacedInstallPlans 1 param body

SUB

/apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/clusterserviceversions

Watch ClusterServiceVersions in a namespace

watchNamespacedClusterServiceVersions 1 param body

Messages & Schemas 6

The contract defines 6 schemas that model the data carried by its messages. The most detailed is WatchEvent (2 properties). Each schema is shown below with its type and property counts.

CRDWatchEvent

message

Change event for a Kubernetes CRD resource

CatalogSourceWatchEvent

message

Change event for an OLM CatalogSource resource

SubscriptionWatchEvent

message

Change event for an OLM Subscription resource

InstallPlanWatchEvent

message

Change event for an OLM InstallPlan resource

CSVWatchEvent

message

Change event for an OLM ClusterServiceVersion resource

WatchEvent

object

A watch event representing a state change to a Kubernetes operator resource. The type field indicates the change and the object field contains the full resourc…

2 properties 2 required

Specification

The full machine-readable AsyncAPI contract behind this narrative.

Source

#Automation#Cloud Native#Custom Resources#Kubernetes

← Back to K APIs

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Kubernetes Operators

Metadata

Channels & Operations 5

Messages & Schemas 6

Specification

Source

API Details

Provider

Explore more