oscaro / clj-k8s

A fully featured Clojure wrapper for the Kubernetes API

clj-k8s

A Clojure Wrapper for the kubernetes API.

See OpenAPI specification for more information.

Generating Stubs

Stubs are generated with OpenAPIGenerator from OpenAPI 2.0/3.x Kubernetes API definition

# Check your kubernetes version:

$ kubectl version -o yaml
clientVersion:
  gitVersion: v1.26.1
  platform: linux/amd64
serverVersion:
  gitVersion: v1.26.1

$  bin/openapi-generate
[...]

$ git diff

API Usage

Creating client instance

Client is modelized by a map, initialization function depend of your Kubernetes distribution.

(ns test
  (:require [clj-k8s.auth :as ka]))

;; From ServiceAccount
(def client (ka/from-service-account))

;; From GKE
(def client (ka/from-gcp-kube-config))

;; From Env
(def client (ka/from-token))

;; The default & Generic way
(def client (ka/from-spec {:base-url "https://localhost:6443"
                           :token "eyGteo8o..."
                           :namespace "wilkins"}))

Special Notes

• For GKE, the KUBECONFIG env variable is honored and ~/.kube/config used as fallback if path isn't set via argv.
• For environment variable, the K8S_TOKEN should be setup if not provided by argument

The Authentification method is subjected to change in the future, with a generic function for context resolving. We recommand using the from-spec method for the moment.

API Methods

Namespaces

(require [clj-k8s.api :as k])

(k/get-namespace client "default")
(k/create-namespace client "foobar")
(k/delete-namespace client "foobar")

Testing

Setup Minikube

Setup a minikube cluster and setup token & environnement variables as follow:

$ source bin/source-minikube

$ echo $KUBERNETES_TOKEN
ey...

Create API Token

kubectl -n kube-system create serviceaccount toast
kubectl -n kube-system create clusterrolebinding toast-bind --clusterrole=cluster-admin --serviceaccount=kube-system:toast
export K8S_TOKEN=$(kubectl -n kube-system create token toast)

Lauching tests

When token is properly exported, run tests as follow:

lein test

License

Copyright © 2019-2023 Oscaro

Distributed under the Eclipse Public License either version 1.0 or (at your option) any later version.