Datapio OpenCore v0.1.0

View Source Datapio.Controller behaviour (Datapio OpenCore v0.1.0)

Behaviour used to implement a Kubernetes operator.

Example:

defmodule MyApp.MyOperator do
  use Datapio.Controller,
    api_version: "v1"
    kind: "Pod"

  @impl true
  def add(pod, _opts) do
    :ok
  end

  @impl true
  def modify(pod, _opts) do
    :ok
  end

  @impl true
  def delete(pod, _opts) do
    :ok
  end

  @impl true
  def reconcile(pod, _opts) do
    :ok
  end
end

Link to this section Summary

Types

controller_options()

Options passed to the controller's callbacks

module_option()

Default options

module_options()
resource()
schema()
start_option()

Option passed to start_link/2

start_options()
supervisor_option()

Option controlling how the Datapio.Controller should be supervised

supervisor_options()
watch_option()

Option controlling what Kubernetes resources are watched

Callbacks

add(resource, controller_options)
delete(resource, controller_options)
modify(resource, controller_options)
reconcile(resource, controller_options)

Functions

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

start_link(module, opts)

Start a controller linked to the current process

Link to this section Types

Link to this type

controller_options()

View Source

Specs

controller_options() :: keyword()

Options passed to the controller's callbacks

Link to this type

module_option()

View Source

Specs

module_option() ::
  watch_option() | {:schema, schema()} | {:supervisor, supervisor_options()}

Default options

Link to this type

module_options()

View Source

Specs

module_options() :: [module_option(), ...]
Link to this type

resource()

View Source

Specs

resource() :: Datapio.K8s.Resource.resource()
Link to this type

schema()

View Source

Specs

schema() :: Datapio.K8s.Resource.schema()
Link to this type

start_option()

View Source

Specs

start_option() :: watch_option() | {:options, controller_options()}

Option passed to start_link/2

Link to this type

start_options()

View Source

Specs

start_options() :: [start_option(), ...]
Link to this type

supervisor_option()

View Source

Specs

supervisor_option() ::
  {:restart, :temporary | :transient | :permanent}
  | {:shutdown, timeout() | :brutal_kill}

Option controlling how the Datapio.Controller should be supervised

Link to this type

supervisor_options()

View Source

Specs

supervisor_options() :: [supervisor_option()]
Link to this type

watch_option()

View Source

Specs

watch_option() ::
  {:api_version, String.t()}
  | {:kind, String.t()}
  | {:namespace, :all | String.t()}
  | {:reconcile_delay, non_neg_integer()}

Option controlling what Kubernetes resources are watched

Link to this section Callbacks

Link to this callback

add(resource, controller_options)

View Source

Specs

add(resource(), controller_options()) :: :ok | {:error, term()}
Link to this callback

delete(resource, controller_options)

View Source

Specs

delete(resource(), controller_options()) :: :ok | {:error, term()}
Link to this callback

modify(resource, controller_options)

View Source

Specs

modify(resource(), controller_options()) :: :ok | {:error, term()}
Link to this callback

reconcile(resource, controller_options)

View Source

Specs

reconcile(resource(), controller_options()) :: :ok | {:error, term()}

Link to this section Functions

Link to this function

child_spec(init_arg)

View Source

Returns a specification to start this module under a supervisor.

See Supervisor.

Link to this function

start_link(module, opts)

View Source

Specs

start_link(module(), start_options()) :: GenServer.on_start()

Start a controller linked to the current process