Packages
k8s
0.2.0
2.8.0
2.7.0
2.6.2
2.6.1
2.6.0
2.5.0
2.4.2
2.4.1
2.4.0
2.3.0
2.2.0
2.1.1
2.1.0
2.0.3
2.0.2
2.0.1
2.0.0
2.0.0-rc.6
2.0.0-rc.5
2.0.0-rc.4
2.0.0-rc.3
2.0.0-rc.2
2.0.0-rc.1
2.0.0-rc.0
1.2.1
1.2.0
1.1.10
1.1.9
1.1.8
1.1.7
1.1.6
1.1.5
1.1.4
1.1.3
1.1.2
1.1.1
1.1.0
1.0.0
1.0.0-rc1
0.5.2
0.5.1
0.5.0
0.5.0-rc.2
0.5.0-rc.1
0.4.0
0.3.2
0.3.1
0.3.0
0.2.13
0.2.12
0.2.11
0.2.10
0.2.9
0.2.8
0.2.7
retired
0.2.6
0.2.5
0.2.4
0.2.3
0.2.2
0.2.1
0.2.0
0.1.3
Kubernetes API Client for Elixir
Current section
Files
Jump to
Current section
Files
README.md
# K8s
[K8s](https://hexdocs.pm/k8s/readme.html) - A Kubernetes client for Elixir
[](https://travis-ci.org/coryodaniel/k8s)
[](https://coveralls.io/github/coryodaniel/k8s?branch=master)
[](https://hex.pm/packages/k8s)
[](https://hexdocs.pm/k8s/)
## Installation
If [available in Hex](https://hex.pm/docs/publish), the package can be installed
by adding `k8s` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[
{:k8s, "~> 0.2"}
]
end
```
## 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
* Supports multiple clusters
* Supports multiple authentication credentials
* Supports multiple kubernetes API
* Tested against kubernetes swagger specs: 1.10, 1.11, 1.12, 1.13, and master
* CRD support
* Kubernetes resource and version helper functions
* Kube config file parsing
* Certificate and service account based auth
* Pluggable auth providers
* Macro free; fast compile & fast startup
### Non-features
* Modules for every resource. The client always return string-keyed maps.
* K8s.Client does *not* assuming "default" namespaces. Always provide a namespace when a namespace is applicable.
* Will not support the deprecated Watch API
* Connect URLs aren't currently supported
* Finalize, binding, scale, and approval subresources aren't currently supported
## Registering Clusters
Clusters can be registered via `config.exs` or directly with `K8s.Cluster.register/2`.
Clusters are referenced by name (`:default` below) when using a `K8s.Client`. Multiple clusters can be registered via config.
This library ships with Kubernetes specs 1.10, 1.11, 1.12, and 1.13.
### Registering clusters via config
Adding a cluster named `:default` using `~/.kube/config`. Defaults to `current-context`.
```elixir
config :k8s,
clusters: %{
default: %{
conf: "~/.kube/config"
}
}
```
Using an alternate context:
```elixir
config :k8s,
clusters: %{
default: %{
conf: "~/.kube/config"
conf_opts: [context: "other-context"]
}
}
```
Setting cluster and user explicitly:
```elixir
config :k8s,
clusters: %{
default: %{
conf: "~/.kube/config"
conf_opts: [user: "some-user", cluster: "prod-cluster"]
}
}
```
### Registering clusters directly
The below will register a cluster named `"1.13"` using `~/.kube.config` to connect. There are many options for loading a config, this will load the user and cluster from the `current-context`.
```elixir
name = "1.13"
conf = K8s.Conf.from_file("~/.kube/config")
K8s.Cluster.register(name, conf)
```
*Note:* Kubernetes API specs can be downloaded using `mix k8s.swagger --version 1.13`.
### Adding authorization providers
```elixir
config :k8s, auth_providers: [My.Custom.Provider]
```
Providers are checked in order, the first to return an authorization struct wins.
Custom providers are processed before default providers.
See [Certicate](lib/k8s/conf/auth/certificate.ex) and [Token](lib/k8s/conf/auth/token.ex) for protocol and behavior implementations.
Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
and published on [HexDocs](https://hexdocs.pm). Once published, the docs can
be found at [https://hexdocs.pm/k8s](https://hexdocs.pm/k8s).