# K8s
[](https://hex.pm/packages/k8s)
[](https://coveralls.io/github/coryodaniel/k8s?branch=develop)
[](https://github.com/coryodaniel/k8s/commits/develop)
[](https://github.com/coryodaniel/k8s/actions/workflows/ci.yaml)
[](https://github.com/coryodaniel/k8s/actions/workflows/elixir_matrix.yaml)
[](https://github.com/coryodaniel/k8s/actions/workflows/k8s_matrix.yaml)
[](https://hexdocs.pm/k8s/)
[](https://hex.pm/packages/k8s)
[](https://github.com/coryodaniel/k8s/blob/develop/LICENSE)
[K8s](https://hexdocs.pm/k8s/usage.html) - Kubernetes API Client for Elixir
## Features
* A client API for humans đŠđŧđ§đŠđģđŠđŊđŠđžđ§đģđ§đŊđ§đ§đžđ¨đŧđ¨đžđ¨đŋ
* đŽ Kubernetes resources, groups, and CRDs are autodiscovered at boot time. No swagger file to include or override.
* Client supports standard HTTP calls, async batches, wait on status â˛ī¸, and watchers đ
* âī¸ HTTP Request middleware
* Multiple clusters â â â
* đ Multiple authentication credentials
* đ¤ serviceaccount
* token
* đ certificate
* auth-provider
* Pluggable auth providers!
* đ Tested against Kubernetes versions 1.10+ and master
* đ ī¸ CRD support
* đ Integrated with `:telemetry`
* âšī¸ Kubernetes resource and version helper functions
* 𧰠Kube config file parsing
* đī¸ Macro free; fast compile & fast startup
## Installation
The package can be installed by adding `:k8s` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[
{:k8s, "~> 1.0"}
]
end
```
## Usage
Check out the [Usage Guide](https://hexdocs.pm/k8s/usage.html) for in-depth examples.
Most functions are also written using doctests.
* [K8s.Client doctests](https://hexdocs.pm/k8s/K8s.Client.html)
* [K8s.Conn doctests](https://hexdocs.pm/k8s/K8s.Conn.html)
* [K8s.Resource doctests](https://hexdocs.pm/k8s/K8s.Resource.html)
* [K8s.Version doctests](https://hexdocs.pm/k8s/K8s.Version.html)
If you are interested in building Kubernetes Operators or Schedulers, check out [Bonny](https://github.com/coryodaniel/bonny).
## tl;dr Examples
### Configure a cluster connection
Cluster connections can be created using the `K8s.Conn` module.
`K8s.Conn.from_file/1` will use the current context in your kubeconfig.
```elixir
{:ok, conn} = K8s.Conn.from_file("path/to/kubeconfig.yaml")
```
`K8s.Conn.from_file/2` accepts a keyword list to set the `:user`, `:cluster`, and/or `:context`
Connections can also be created in-cluster from a service account.
```elixir
{:ok, conn} = K8s.Conn.from_service_account("/path/to/service-account/directory")
```
Check out the [connection guide](https://hexdocs.pm/k8s/connections.html) for additional details.
### Creating a deployment
```elixir
{:ok, conn} = K8s.Conn.from_file("path/to/kubeconfig.yaml")
opts = [namespace: "default", name: "nginx", image: "nginx:nginx:1.7.9"]
{:ok, resource} = K8s.Resource.from_file("priv/deployment.yaml", opts)
operation = K8s.Client.create(resource)
{:ok, deployment} = K8s.Client.run(conn, operation)
```
### Listing deployments
In a namespace:
```elixir
{:ok, conn} = K8s.Conn.from_file("path/to/kubeconfig.yaml")
operation = K8s.Client.list("apps/v1", "Deployment", namespace: "prod")
{:ok, deployments} = K8s.Client.run(conn, operation)
```
Across all namespaces:
```elixir
{:ok, conn} = K8s.Conn.from_file("path/to/kubeconfig.yaml")
operation = K8s.Client.list("apps/v1", "Deployment", namespace: :all)
{:ok, deployments} = K8s.Client.run(conn, operation)
```
### Getting a deployment
```elixir
{:ok, conn} = K8s.Conn.from_file("path/to/kubeconfig.yaml")
operation = K8s.Client.get("apps/v1", :deployment, [namespace: "default", name: "nginx-deployment"])
{:ok, deployment} = K8s.Client.run(conn, operation)
```