zio-k8s-client
API
Generated with
zio-k8s-client/com.coralogix.zio.k8s/com.coralogix.zio.k8s.client

com.coralogix.zio.k8s.client

package com.coralogix.zio.k8s.client

Members list

Packages

package com.coralogix.zio.k8s.client.admissionregistration.v1
package com.coralogix.zio.k8s.client.apiextensions.v1.customresourcedefinitions
package com.coralogix.zio.k8s.client.apiregistration.v1.apiservices
package com.coralogix.zio.k8s.client.apiserver
package com.coralogix.zio.k8s.client.apps.v1
package com.coralogix.zio.k8s.client.authorization.rbac.v1
package com.coralogix.zio.k8s.client.autoscaling
package com.coralogix.zio.k8s.client.batch
package com.coralogix.zio.k8s.client.certificates.v1.certificatesigningrequests
package com.coralogix.zio.k8s.client.config

Contains data structures, ZIO layers and zio-config descriptors for configuring the zio-k8s client.

Contains data structures, ZIO layers and zio-config descriptors for configuring the zio-k8s client.

Each zio-k8s client module depends on two ZIO modules: com.coralogix.zio.k8s.client.model.K8sCluster and an sttp.client3.SttpBackend. To use the default configuration (use kubeconfig if available, otherwise fallback to service account token), use either asynchttpclient.k8sDefault or httpclient.k8sDefault depending on your chosen sttp backend.

Manual configuration is possible by providing a K8sClusterConfig value to both the k8sCluster layer and either asynchttpclient.k8sSttpClient or httpclient.k8sSttpClient.

Instead of manually providing the configuration, zio-config descriptors are available to load them from any supported source.

Attributes

package com.coralogix.zio.k8s.client.coordination.v1.leases
package com.coralogix.zio.k8s.client.discovery
package com.coralogix.zio.k8s.client.events
package com.coralogix.zio.k8s.client.impl
package com.coralogix.zio.k8s.client.internal
package com.coralogix.zio.k8s.client.kubernetes
package com.coralogix.zio.k8s.client.model
package com.coralogix.zio.k8s.client.networking.v1
package com.coralogix.zio.k8s.client.node
package com.coralogix.zio.k8s.client.policy
package com.coralogix.zio.k8s.client.scheduling.v1.priorityclasses
package com.coralogix.zio.k8s.client.storage
package com.coralogix.zio.k8s.client.subresources
package com.coralogix.zio.k8s.client.test
package com.coralogix.zio.k8s.client.v1

Type members

Classlikes

trait ClusterResource[T]

Generic interface for working with Kubernetes cluster resources.

Generic interface for working with Kubernetes cluster resources.

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

Type parameters

T

Resource type

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
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
Show all
trait ClusterResourceDelete[T, DeleteResult]

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
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
Show all
trait ClusterResourceDeleteAll[T]

Extra capability for ClusterResource interfaces providing deleteAll

Extra capability for ClusterResource interfaces providing deleteAll

It is separated because it is not supported by all resources.

Type parameters

T

Resource type

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
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
Show all
trait ClusterResourceStatus[StatusT, T]

Extra capability for ClusterResource interfaces to manage status subresources

Extra capability for ClusterResource interfaces to manage status subresources

Type parameters

StatusT

Status subresource type

T

Resource type

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
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
Show all
final case class CodingFailure(requestInfo: K8sRequestInfo, failure: CharacterCodingException) extends K8sFailure

Error in the UTF-8 character coding of the response from the Kubernetes API

Error in the UTF-8 character coding of the response from the Kubernetes API

Value parameters

failure

The character coding error

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait K8sFailure
class Object
trait Matchable
class Any
Show all
final case class DecodedFailure(requestInfo: K8sRequestInfo, status: Status, code: StatusCode) extends K8sFailure

Failed Kubernetes API request

Failed Kubernetes API request

Note that some specific failure types are encoded by their own failure type. See Unauthorized, Gone and NotFound.

Value parameters

code

Response status code

status

The Kubernetes com.coralogix.zio.k8s.model.pkg.apis.meta.v1.Status value returned in the failure response

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait K8sFailure
class Object
trait Matchable
class Any
Show all
final case class DeserializationFailure(requestInfo: K8sRequestInfo, error: NonEmptyList[Error]) extends K8sFailure

Error indicating that Kubernetes API responded with success, but the response body could not be deserialized to the expected data type.

Error indicating that Kubernetes API responded with success, but the response body could not be deserialized to the expected data type.

Value parameters

error

The list of deserialization errors

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait K8sFailure
class Object
trait Matchable
class Any
Show all
object DeserializationFailure

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case object Gone extends K8sFailure

The server returned with HTTP 410 (Gone) which has a specific role in handling watch streams.

The server returned with HTTP 410 (Gone) which has a specific role in handling watch streams.

Attributes

Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
trait K8sFailure
class Object
trait Matchable
class Any
Show all
Self type
Gone.type
final case class HttpFailure(requestInfo: K8sRequestInfo, message: String, code: StatusCode) extends K8sFailure

Failed HTTP response

Failed HTTP response

Indicates that the response from the Kubernetes API has a non-successful status code and it's body did not contain a com.coralogix.zio.k8s.model.pkg.apis.meta.v1.Status value.

In case the error is a standard Kubernetes error message, the error type will be DecodedFailure.

Note that some specific failure types are encoded by their own failure type. See Unauthorized, Gone and NotFound.

Value parameters

code

Response status code

message

Response message

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait K8sFailure
class Object
trait Matchable
class Any
Show all
final case class InvalidEvent(requestInfo: K8sRequestInfo, eventType: String) extends K8sFailure

An unsupported event type was sent in a watch stream

An unsupported event type was sent in a watch stream

Value parameters

eventType

The unrecognized event type from the server

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait K8sFailure
class Object
trait Matchable
class Any
Show all
sealed trait K8sFailure

Error type of the Kubernetes client

Error type of the Kubernetes client

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Gone.type
class HttpFailure
class InvalidEvent
object NotFound.type
class Unauthorized
Show all
object K8sFailure

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
K8sFailure.type
object K8sRequestInfo

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class K8sRequestInfo(resourceType: K8sResourceType, operation: String, namespace: Option[K8sNamespace], fieldSelector: Option[FieldSelector], labelSelector: Option[LabelSelector], name: Option[String])

K8s API request information to be provided in K8sFailure failures

K8s API request information to be provided in K8sFailure failures

Value parameters

operation

Operation name

resourceType

Resource type

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
trait NamespacedResource[T]

Generic interface for working with namespaced Kubernetes resources.

Generic interface for working with namespaced Kubernetes resources.

More type safe than Resource as it requires passing a namespace where necessary.

Type parameters

T

Resource type

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
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
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
Show all
trait NamespacedResourceDelete[T, DeleteResult]

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
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
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
Show all
trait NamespacedResourceDeleteAll[T]

Extra capability for NamespacedResource interfaces providing deleteAll

Extra capability for NamespacedResource interfaces providing deleteAll

It is separated because it is not supported by all resources.

Type parameters

T

Resource type

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
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
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
Show all
trait NamespacedResourceStatus[StatusT, T]

Extra capability for NamespacedResource interfaces to manage status subresources

Extra capability for NamespacedResource interfaces to manage status subresources

Type parameters

StatusT

Status subresource type

T

Resource type

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
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
Show all
case object NotFound extends K8sFailure

The sever returned with HTTP 404 (NotFound).

The sever returned with HTTP 404 (NotFound).

See the K8sFailure.syntax.K8sZIOSyntax.ifFound extension method for a convenient way to handle these errors.

Attributes

Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
trait K8sFailure
class Object
trait Matchable
class Any
Show all
Self type
NotFound.type
final case class RequestFailure(requestInfo: K8sRequestInfo, reason: Throwable) extends K8sFailure

Failed to send the HTTP request to the Kubernetes API

Failed to send the HTTP request to the Kubernetes API

Value parameters

reason

The failure reason

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait K8sFailure
class Object
trait Matchable
class Any
Show all
trait Resource[T]

Generic interface for working with Kubernetes resources

Generic interface for working with Kubernetes resources

This interface supports both namespaced and cluster resources. For more type safe variants check NamespacedResource and ClusterResource.

Type parameters

T

Resource type

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
class ResourceClient[T, DeleteResult]
class TestResourceClient[T, DeleteResult]
trait ResourceDelete[T, DeleteResult]

Extra capability for Resource interfaces providing delete

Extra capability for Resource interfaces providing delete

It is separated because because its result type varies for different resources.

Type parameters

DeleteResult

Delete result type

T

Resource type

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
class ResourceClient[T, DeleteResult]
class TestResourceClient[T, DeleteResult]
trait ResourceDeleteAll[T]

Extra capability for Resource interfaces providing deleteAll

Extra capability for Resource interfaces providing deleteAll

It is separated because it is not supported by all resources.

Type parameters

T

Resource type

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
class ResourceClient[T, DeleteResult]
class TestResourceClient[T, DeleteResult]
trait ResourceStatus[StatusT, T]

Extra capability for Resource interfaces to manage status subresources

Extra capability for Resource interfaces to manage status subresources

Type parameters

StatusT

Status subresource type

T

Resource type

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
class ResourceStatusClient[StatusT, T]
class TestResourceStatusClient[StatusT, T]
trait Subresource[T]

Generic interface for subresources.

Generic interface for subresources.

Every subresource supports a different subset of these operations, so usually you should use the actual generated subresource interfaces instead.

Type parameters

T

Subresource type

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
final case class Unauthorized(requestInfo: K8sRequestInfo, message: String) extends K8sFailure

Request unauthorized

Request unauthorized

Indicates that the Kubernetes API returned a HTTP 401 response.

Value parameters

message

Message of the response

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait K8sFailure
class Object
trait Matchable
class Any
Show all
final case class UndefinedField(field: String) extends K8sFailure

Error produced by the generated getter methods on Kubernetes data structures.

Error produced by the generated getter methods on Kubernetes data structures.

Indicates that the requested field is not present.

Value parameters

field

Field name

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait K8sFailure
class Object
trait Matchable
class Any
Show all
Generated with