# Kazan

Kazan is a Kubernetes API client for Elixir. It uses the OpenAPI specifications
provided by kube to generate most of it's functions and datastructures. This
allows the whole kube API to be supported with relatively little effort.

Kazan should mostly work though it's not thoroughly tested against the actual
kubernetes API.  If you find a bug in the library please file an issue (or
submit a PR) and I'll try and get it fixed.

I'm reasonably happy with the API at the moment so I don't expect to change it
too drastically.  However I can't speak for the k8s API specifications that
the kazan code is generated from.  Also the library is still pre-1.0 so if I
find a better way to put it together I may end up changing things.

Looking for some help? Check out `kazan`'s Gitter [chatroom](

### Features

- Support for most Kubernetes API calls.
- Structs for most Kubernetes API structures.
- [Documentation of all models & calls](
- Client certificate, token and auth provider based authentication.
- Loading config from kubeconfig files.
- Support for watch requests.
- Typespecs for functions and structs (though dialyzer outputs a lot of
  warnings when run on Kazan)

### Not Implemented

- Custom resources (I'd be interested in supporting these, but it's not clear how to do it)
- Other forms of authentication
- Patching with `application/json-patch+json` or
  `application/strategic-merge-patch+json` content types.
- Removing fields when patching with `application/merge-patch+json`.
- Comprehensive tests.
- Validation of requests.
- Probably some other things.

## Installation

If [available in Hex](, the package can be installed as:

  1. Add `kazan` to your list of dependencies in `mix.exs`:

def deps do
  [{:kazan, "~> 0.10"}]

  2. Ensure `kazan` is started before your application:

def application do
  [applications: [:kazan]]

## Configuration

Kazan uses the `Kazan.Server` struct to contain server & authentication
configuration details. `Kazan.Server` also provides some convenience functions
to create a `Kazan.Server` from external sources such as a kube config file, or
a kube service account.

If your application is only going to be talking to a single kubernetes cluster,
then it's recommended to configure that cluster in your mix config. This makes
working with kazan slightly easier, as you can call `` without
providing a server every time.

### In Cluster Authentication

If your code is going to be running on a kubernetes cluster and you wish to use
the kubernetes service account that can be configured like this:

config :kazan, :server, :in_cluster

Alternatively, the `Kazan.Server.in_cluster` function can be used to create a
server for passing straight into ``

### Configuration via kube config file.

If you have a kube config file that contains the cluster & auth details you wish
to use, kazan can use that:

config :kazan, :server, {:kubeconfig, "path/to/file"}

Alternatively, the `Kazan.Server.from_kubeconfig` function can be used to create a
server for passing straight into ``

### Configuring server details directly

If you wish to configure the server details manually, kazan can also accept a
map of server parameters:

config :kazan, :server, %{url: "kubernetes.default" auth: %{token: "your_token"}}

See the [`Kazan.Server`
documentation]( to see what fields
this supports.

### Google Kubernetes Engine Config via gcloud

If developing against GKE, gcloud can create a kube config file that Kazan can
understand. However, in this case you will need to call
`Kazan.Server.resolve_token/2` in order to query gcloud for a valid token. See
the docs for `Kazan.Server.resolve_token` for more details.

## Usage

Making a request with Kazan is done in two stages.

1. Build the request object using one of the functions in `Kazan.Api.*`.
2. Run that request using [``](

For example, to get all of the pods from the server configured in the mix config:

# %Kazan.Models.V1.PodList{...}

Alternatively, you might want to specify the server to send the request to:

server = Kazan.Server.in_cluster()

|>!(server: server)
# %Kazan.Apis.Core.V1.PodList{...}

More details on building requests can be found in the [documentation for

Details on creating watch requests can be found in the [documentation for