@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{...}

Options

All options (see Options section in module doc) are accepted and merged with the given 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 exec(
  req :: Req.Request.t(),
  namespace :: namespace(),
  name :: String.t(),
  opts :: Keyword.t() | nil
) :: response()

Opens a websocket to the given Pod and executes a command on it.

Examples

{:ok, resp} =
  Kubereq.exec(req, "defaault", "my-pod",
    container: "main-container",
    command: "/bin/sh",
    command: "-c",
    command: "echo foobar",
    stdout: true,
    stderr: true
  )
Enum.each(resp.body, &IO.inspect/1)
# {:stdout, ""}
# {:stdout, "foobar\n"}

Options

• :container (optional) - The container to connect to. Defaults to only container if there is one container in the pod. Fails if not defined for pods with multiple pods.
• :command - Command is the remote command to execute. Not executed within a shell.
• :stdin (optional) - Redirect the standard input stream of the pod for this call. Defaults to true.
• :stdin (optional) - Redirect the standard output stream of the pod for this call. Defaults to true.
• :stderr (optional) - Redirect the standard error stream of the pod for this call. Defaults to true.
• :tty (optional) - If true indicates that a tty will be allocated for the exec call. Defaults to false.

@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 logs(
  Req.Request.t(),
  namespace :: namespace(),
  name :: String.t(),
  opts :: Keyword.t() | nil
) :: response()

Opens a websocket to the given container and streams logs from it.

Examples

req = Req.new() |> Kubereq.attach()
{:ok, resp} =
  Kubereq.logs(req, "default", "my-pod",
    container: "main-container",
    tailLines: 5
  )
Enum.each(resp.body, &IO.inspect/1)

Options

• :container - The container for which to stream logs. Defaults to only container if there is one container in the pod. Fails if not defined for pods with multiple pods.
• :follow - Follow the log stream of the pod. If this is set to true, the connection is kept alive which blocks current the process. If you need this, you probably want to use Kubereq.PodLogs instead. Defaults to false.
• :insecureSkipTLSVerifyBackend - insecureSkipTLSVerifyBackend indicates that the apiserver should not confirm the validity of the serving certificate of the backend it is connecting to. This will make the HTTPS connection between the apiserver and the backend insecure. This means the apiserver cannot verify the log data it is receiving came from the real kubelet. If the kubelet is configured to verify the apiserver's TLS credentials, it does not mean the connection to the real kubelet is vulnerable to a man in the middle attack (e.g. an attacker could not intercept the actual log data coming from the real kubelet).
• :limitBytes - If set, the number of bytes to read from the server before terminating the log output. This may not display a complete final line of logging, and may return slightly more or slightly less than the specified limit.
• :pretty - If 'true', then the output is pretty printed.
• :previous - Return previous t erminated container logs. Defaults to false.
• :sinceSeconds - A relative time in seconds before the current time from which to show logs. If this value precedes the time a pod was started, only logs since the pod start will be returned. If this value is in the future, no logs will be returned. Only one of sinceSeconds or sinceTime may be specified.
• :tailLines - If set, the number of lines from the end of the logs to show. If not specified, logs are shown from the creation of the container or sinceSeconds or sinceTime
• :timestamps - If true, add an RFC3339 or RFC3339Nano timestamp at the beginning of every line of log output. Defaults to false.

@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}