K8s

K8s - Kubernetes API Client for Elixir

Build Status Coverage Status Hex.pm Documentation Hex.pm

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:

def deps do
  [
    {:k8s, "~> 0.5"}
  ]
end

Usage

Check out the Usage Guide for in-depth examples.

Most functions are also written using doctests.

If you are interested in building Kubernetes Operators or Schedulers, check out Bonny.

tl;dr Examples

Configure a cluster

There are many ways to configure cluster connections. Check out the guide for additional options.

In config.exs:

config :k8s,
  clusters: %{
    prod_us_east1: %{ # <- this can be any name, used to load connections later
      # Path to kube config
      conn: "~/.kube/config",
      # By default current context will be used, you can change the user or cluster
      conn_opts: [user: "some-user", cluster: "prod-cluster"]
    }
  }

Creating a deployment

{:ok, conn} = K8s.Conn.lookup(:prod_us_east1)

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(operation, conn)

Listing deployments

In a namespace:

{:ok, conn} = K8s.Conn.lookup(:prod_us_east1)

operation = K8s.Client.list("apps/v1", "Deployment", namespace: "prod")
{:ok, deployments} = K8s.Client.run(operation, conn)

Across all namespaces:

{:ok, conn} = K8s.Conn.lookup(:prod_us_east1)

operation = K8s.Client.list("apps/v1", "Deployment", namespace: :all)
{:ok, deployments} = K8s.Client.run(operation, conn)

Getting a deployment

{:ok, conn} = K8s.Conn.lookup(:prod_us_east1)

operation = K8s.Client.get("apps/v1", :deployment, [namespace: "default", name: "nginx-deployment"])
{:ok, deployment} = K8s.Client.run(operation, conn)