@spec apply(
  Req.Request.t(),
  resource :: map(),
  field_manager :: binary(),
  force :: boolean(),
  opts :: Keyword.t()
) :: response()

Applies the given resource using a Server-Side-Apply Patch.

See the documentation for a documentation on field_manager and force arguments.

Examples

iex> Req.new()
...> |> Kubereq.attach(api_version: "v1", kind: "ConfigMap")
...> |> Kubereq.apply(resource)
{:ok, %Req.Response{status: 200, body: %{...}}}

@spec attach(req :: Req.Request.t(), opts :: Keyword.t()) :: Req.Request.t()

Attaches kubereq to a Req.Request struct for making HTTP requests to a Kubernetes cluster. You can optionally pass a Kubernetes configuration or pipeline via kubeconfig option. If it is omitted, the default config Kubereq.Kubeconfig.Default is loaded.

Examples

iex> Req.new() |> Kubereq.attach()
%Request.Req{...}

@spec create(Req.Request.t(), resource :: map(), opts :: Keyword.t()) :: response()

Create the resource or its subresource on the cluster.

Example

iex> Req.new()
...> |> Kubereq.attach(api_version: "v1", kind: "ConfigMap")
...> |> Kubereq.create(resource)
{:ok, %Req.Response{status: 201, body: %{...}}}

@spec delete(
  Req.Request.t(),
  namespace :: namespace(),
  name :: String.t(),
  opts :: Keyword.t()
) :: response()

Deletes the resource or its subresource from the cluster.

Examples

iex> Req.new()
...> |> Kubereq.attach(api_version: "v1", kind: "ConfigMap")
...> |> Kubereq.delete("default", "foo")
{:ok, %Req.Response{status: 200, body: %{...}}}

@spec delete_all(Req.Request.t(), namespace :: namespace(), opts :: keyword()) ::
  response()

Deletes all resources in the given namespace.

Examples

iex> Req.new()
...> |> Kubereq.attach(api_version: "v1", kind: "ConfigMap")
...> |> Kubereq.delete_all("default", label_selectors: [{"app", "my-app"}])
{:ok, %Req.Response{status: 200, body: %{...}}}

@spec get(
  Req.Request.t(),
  namespace :: namespace(),
  name :: String.t(),
  opts :: Keyword.t() | nil
) :: response()

Get the resource name in namespace or its subresource.

Omit namespace to get cluster resources.

Example

iex> Req.new()
...> |> Kubereq.attach(api_version: "v1", kind: "ConfigMap")
...> |> Kubereq.get("default", "foo")
{:ok, %Req.Response{status: 200, body: %{...}}}

@spec json_patch(
  Req.Request.t(),
  json_patch :: map(),
  namespace :: namespace(),
  name :: String.t(),
  opts :: Keyword.t()
) :: response()

Patches the resource namein namespace or its subresource using the given json_patch.

Examples

iex> Req.new()
...> |> Kubereq.attach(api_version: "v1", kind: "ConfigMap")
...> |> Kubereq.json_patch(%{...}, "default", "foo")
{:ok, %Req.Response{...}

@spec list(Req.Request.t(), namespace :: namespace(), opts :: keyword()) :: response()

Get a resource list.

Examples

iex> Req.new()
...> |> Kubereq.attach(api_version: "v1", kind: "ConfigMap")
...> |> Kubereq.list("default")
{:ok, %Req.Response{status: 200, body: %{...}}}

@spec merge_patch(
  Req.Request.t(),
  merge_patch :: String.t(),
  namespace :: namespace(),
  name :: String.t(),
  opts :: Keyword.t()
) :: response()

Patches the resource namein namespace or its subresource using the given merge_patch.

Examples

iex> Req.new()
...> |> Kubereq.attach(api_version: "v1", kind: "ConfigMap")
...> |> Kubereq.merge_patch(%{...}, "default", "foo")
{:ok, %Req.Response{...}

@spec update(Req.Request.t(), resource :: map(), opts :: Keyword.t()) :: response()

Updates the given resource.

Examples

iex> Req.new()
...> |> Kubereq.attach(api_version: "v1", kind: "ConfigMap")
...> |> Kubereq.update(resource)
{:ok, %Req.Response{status: 200, body: %{...}}}

@spec wait_until(
  Req.Request.t(),
  namespace :: namespace(),
  name :: String.t(),
  callback :: wait_until_callback(),
  opts :: Keyword.t()
) :: wait_until_response()

GET a resource and wait until the given callback returns true or the given timeout (ms) has expired.

Options

All options described in the moduledoc plus:

• timeout - Timeout in ms after function terminates with {:error, :timeout}

@spec watch(
  Req.Request.t(),
  namespace :: namespace(),
  opts :: keyword()
) :: watch_response()

Watch events of all resources in namespace.

Examples

iex> Req.new()
...> |> Kubereq.attach(api_version: "v1", kind: "ConfigMap")
...> |> Kubereq.watch("default")
{:ok, #Function<60.48886818/2 in Stream.transform/3>}

Omit the second argument in order to watch events in all namespaces:

iex> Req.new()
...> |> Kubereq.attach(api_version: "v1", kind: "ConfigMap")
...> |> Kubereq.watch()
{:ok, #Function<60.48886818/2 in Stream.transform/3>}

Options

All options described in the moduledoc plus:

• :resource_version - If given, starts to stream from the given resourceVersion of the resource list. Otherwise starts streaming from HEAD.
• :stream_to - If set to a pid, streams events to the given pid. If set to {pid, ref}, the messages are in the form {ref, event}.

@spec watch_single(
  Req.Request.t(),
  namespace :: namespace(),
  name :: String.t(),
  opts :: keyword()
) :: watch_response()

Watch events of a single resources namein namespace. The req struct should have been created using Kubereq.new/1.

Examples

iex> Req.new()
...> |> Kubereq.attach(api_version: "v1", kind: "ConfigMap")
...> |> Kubereq.watch_single("default")
{:ok, #Function<60.48886818/2 in Stream.transform/3>}

Omit the second argument in order to watch events in all namespaces:

iex> Req.new()
...> |> Kubereq.attach(api_version: "v1", kind: "ConfigMap")
...> |> Kubereq.watch_single()
{:ok, #Function<60.48886818/2 in Stream.transform/3>}

Options

All options described in the moduledoc plus:

• :stream_to - If set to a pid, streams events to the given pid. If set to {pid, ref}, the messages are in the form {ref, event}