# kubereq v0.4.3 - Table of Contents

> A Kubernetes Client using Req.

## Pages

- [Kubereq](readme.md)
- [Changelog](changelog.md)

## Modules

- [Kubereq](Kubereq.md): A Kubernetes client for Elixir based on `Req`.
- [Kubereq.Access](Kubereq.Access.md): Helper module to access maps in lists.

- [Kubereq.Watcher](Kubereq.Watcher.md): A behaviour module for implementing a Kubernetes watch event handler.

- Websocket Connection
  - [Kubereq.PodExec](Kubereq.PodExec.md): Establish a connection to a Pod and execute a command in a container.
  - [Kubereq.PodLogs](Kubereq.PodLogs.md): Establish a connection to a Pod and stream logs.

- Kubeconfig Loading
  - [Kubereq.Kubeconfig](Kubereq.Kubeconfig.md): This is the `Pluggable.Token` for the pipeline loading the Kubernetes config.
The Kubeconfig represents the configuration to establish a connection to
the Kubernetes cluster. It contains informations like endpoint, certificates,
user authentication details etc.
  - [Kubereq.Kubeconfig.Default](Kubereq.Kubeconfig.Default.md): Default pipeline of pluggable steps for loading the Kubeconfig. Tries to
build the Kubeconfig from different default settings.
  - [Kubereq.Kubeconfig.ENV](Kubereq.Kubeconfig.ENV.md): Pluggable step that loads the Kubeconfig from a config file whose location is
defined by an ENV variable. Uses `Kubereq.Kubeconfig.File` under the hood.
  - [Kubereq.Kubeconfig.File](Kubereq.Kubeconfig.File.md): Pluggable step that load the Kubeconfig from a file.
  - [Kubereq.Kubeconfig.ServiceAccount](Kubereq.Kubeconfig.ServiceAccount.md): Pluggable step that builds the Kubeconfig using a Service Account's token for
authentication.
  - [Kubereq.Kubeconfig.Stub](Kubereq.Kubeconfig.Stub.md): Req testing conveniences for `kubereq` requests.

- Selectors
  - [Kubereq.Step.FieldSelector](Kubereq.Step.FieldSelector.md): Req step to format field selectors.
  - [Kubereq.Step.LabelSelector](Kubereq.Step.LabelSelector.md): Req step to format label selectors.

- Exceptions
  - [Kubereq.Error.KubeconfError](Kubereq.Error.KubeconfError.md): Indicates an error with the Kubernetes Configuration

  - [Kubereq.Error.StepError](Kubereq.Error.StepError.md): Indicates an error during the Req steps processing.