ClusterResource

Generic interface for working with Kubernetes cluster resources.

More type safe than Resource as it does not allow passing a namespace.

Type Params
T

Resource type

class Object
trait Matchable
class Any
trait Service
class Live
trait Service
class Live
trait Service
class Live
trait Service
class Live
trait Service
class Live
trait Service
class Live
trait Service
class Live
trait Service
class Live
trait Service
class Live
trait Service
class Live
trait Service
class Live
trait Service
class Live
trait Service
class Live
trait Service
class Live
trait Service
class Live
trait Service
class Live
trait Service
class Live
trait Service
class Live
trait Service
class Live
trait Service
class Live
trait Service
class Live
trait Service
class Live
trait Service
class Live
trait Service
class Live
trait Service
class Live
trait Service
class Live
trait Service
class Live

Value members

Concrete methods

def create(newResource: T, dryRun: Boolean): IO[K8sFailure, T]

Creates a new resource

Creates a new resource

Value Params
dryRun

If true, the request is sent to the server but it will not create the resource.

newResource

The new resource to define in the cluster.

Returns

Returns the created resource as it was returned from Kubernetes

def get(name: String): IO[K8sFailure, T]

Get a resource by its name

Get a resource by its name

Value Params
name

Name of the resource

Returns

Returns the current version of the resource

def getAll(chunkSize: Int, fieldSelector: Option[FieldSelector], labelSelector: Option[LabelSelector], resourceVersion: ListResourceVersion): Stream[K8sFailure, T]

A paginated query of all resources with filtering possibilities

A paginated query of all resources with filtering possibilities

Value Params
chunkSize

Number of items to return per HTTP request

fieldSelector

Constrain the returned items by field selectors. Not all fields are supported by the server.

labelSelector

Constrain the returned items by label selectors.

resourceVersion

Control the returned resources' version.

Returns

A stream of resources

def replace(name: String, updatedResource: T, dryRun: Boolean): IO[K8sFailure, T]

Replaces an existing resource selected by its name

Replaces an existing resource selected by its name

Value Params
dryRun

If true, the request is sent to the server but it will not create the resource.

name

Name of the resource

updatedResource

The new value of the resource

Returns

Returns the updated resource as it was returned from Kubernetes

def watch(resourceVersion: Option[String], fieldSelector: Option[FieldSelector], labelSelector: Option[LabelSelector]): Stream[K8sFailure, TypedWatchEvent[T]]

Watch stream of resource change events of type com.coralogix.zio.k8s.client.model.TypedWatchEvent

Watch stream of resource change events of type com.coralogix.zio.k8s.client.model.TypedWatchEvent

This function requires the user to control the starting resourceVersion and to restart the watch stream when the server closes the connection.

For a more convenient variant check watchForever.

Value Params
fieldSelector

Constrain the returned items by field selectors. Not all fields are supported by the server.

labelSelector

Constrain the returned items by label selectors.

resourceVersion

Last known resource version

Returns

A stream of watch events

def watchForever(fieldSelector: Option[FieldSelector], labelSelector: Option[LabelSelector]): ZStream[Clock, K8sFailure, TypedWatchEvent[T]]

Infinite watch stream of resource change events of type com.coralogix.zio.k8s.client.model.TypedWatchEvent

Infinite watch stream of resource change events of type com.coralogix.zio.k8s.client.model.TypedWatchEvent

The underlying implementation takes advantage of Kubernetes watch bookmarks.

Value Params
fieldSelector

Constrain the returned items by field selectors. Not all fields are supported by the server.

labelSelector

Constrain the returned items by label selectors.

Returns

A stream of watch events

Abstract fields

A more generic interface for the same resource

A more generic interface for the same resource