K8s - Kubernetes API Client for Elixir
- 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
The package can be installed by adding :k8s
to your list of dependencies in mix.exs
:
def deps do
[
{:k8s, "~> 2.0"}
]
end
Check out the Usage Guide for in-depth examples. If you like learning with Livebook, check out kino_k8s. It comes with nice smart cells to help you generate your first working code.
Most functions are also written using doctests.
If you are interested in building Kubernetes Operators or Schedulers, check out Bonny.
Cluster connections can be created using the K8s.Conn
module.
K8s.Conn.from_file/1
will use the current context in your kubeconfig.
{: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.
{:ok, conn} = K8s.Conn.from_service_account("/path/to/service-account/directory")
Check out the connection guide for additional details.
{: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)
In a namespace:
{: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:
{: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)
{: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)