Datapio OpenCore v0.1.0

View Source Datapio.K8s.Event (Datapio OpenCore v0.1.0)

This module allows you to create and publish custom Kubernetes Events. For more information about the Event spec, please read this reference.

Usage example:

alias Datapio.K8s.Event

{:ok, conn} = Datapio.K8s.Conn.lookup()
operation = K8s.Client.get("apps/v1", :deployment, [namespace: "default", name: "nginx-deployment"])
{:ok, deployment} = K8s.Client.run(conn, operation)

Event.new(name: "some-prefix", namespace: "default")
  |> Event.action("notify")
  |> Event.reporting_controller("my-app")
  |> Event.reporting_instance("my-app-0")
  |> Event.regarding(deployment)
  |> Event.type(:normal)
  |> Event.reason("TestMessage")
  |> Event.message("This is an example")
  |> Event.time(:now)
  |> Event.publish(conn)

Link to this section Summary

Types

partial()

Represent a partial Kubernetes Event (not publishable yet)

t()

Represent a Kubernetes Event

Functions

action(event, name)

Specify what action was taken/failed

message(event, val)

Specify the message describing this event

new(list)

Create a new event

publish(event, conn)

Publish the event to Kubernetes

reason(event, val)

Specify the reason of the event

regarding(event, resource)

Specify the object this event is about

related(event, resource)

Specify a secondary object this event is related to

reporting_controller(event, name)

Specify the name of the controller that emitted this Event

reporting_instance(event, name)

Specify the ID of the controller instance

time(event, dt)

Specify the time at which the event was first observed

type(event, atom)

Specify the type of the event

Link to this section Types

Link to this type

partial()

View Source

Specs

partial() :: t()

Represent a partial Kubernetes Event (not publishable yet)

Link to this type

t()

View Source

Specs

t() :: Datapio.K8s.Resource.t()

Represent a Kubernetes Event

Link to this section Functions

Link to this function

action(event, name)

View Source

Specs

action(partial(), String.t()) :: partial()

Specify what action was taken/failed

Link to this function

message(event, val)

View Source

Specs

message(partial(), String.t()) :: partial()

Specify the message describing this event

Link to this function

new(list)

View Source

Specs

new(name: String.t(), namespace: String.t()) :: partial()

Create a new event

Link to this function

publish(event, conn)

View Source

Specs

publish(t(), K8s.Conn.t()) :: {:ok, any()} | {:error, term()}

Publish the event to Kubernetes

Link to this function

reason(event, val)

View Source

Specs

reason(partial(), String.t()) :: partial()

Specify the reason of the event

Link to this function

regarding(event, resource)

View Source

Specs

regarding(partial(), Datapio.K8s.Resource.t()) :: partial()

Specify the object this event is about

Link to this function

related(event, resource)

View Source

Specs

related(partial(), Datapio.K8s.Resource.t()) :: partial()

Specify a secondary object this event is related to

Link to this function

reporting_controller(event, name)

View Source

Specs

reporting_controller(partial(), String.t()) :: partial()

Specify the name of the controller that emitted this Event

Link to this function

reporting_instance(event, name)

View Source

Specs

reporting_instance(partial(), String.t()) :: partial()

Specify the ID of the controller instance

Link to this function

time(event, dt)

View Source

Specs

time(partial(), :now | DateTime.t()) :: partial()

Specify the time at which the event was first observed

Link to this function

type(event, atom)

View Source

Specs

type(partial(), :normal | :warning) :: partial()

Specify the type of the event