Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/oscaro/clj-k8s
A fully featured Clojure wrapper for the Kubernetes API
https://github.com/oscaro/clj-k8s
clojure kubernetes
Last synced: 3 months ago
JSON representation
A fully featured Clojure wrapper for the Kubernetes API
- Host: GitHub
- URL: https://github.com/oscaro/clj-k8s
- Owner: oscaro
- Created: 2023-04-21T09:07:15.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2024-03-22T10:17:37.000Z (11 months ago)
- Last Synced: 2024-10-28T13:42:57.897Z (4 months ago)
- Topics: clojure, kubernetes
- Language: Clojure
- Homepage: https://oscaro.github.io/clj-k8s/
- Size: 648 KB
- Stars: 10
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# clj-k8s [](https://github.com/oscaro/clj-k8s/actions/workflows/clojure.yml) [](https://clojars.org/com.oscaro/clj-k8s)
A Clojure Wrapper for the [kubernetes](https://kubernetes.io/) API.
See [OpenAPI specification](https://kubernetes.io/docs/concepts/overview/kubernetes-api/#api-specification) for more information.
## Generating Stubs
Stubs are generated with [OpenAPIGenerator](https://openapi-generator.tech/) from OpenAPI 2.0/3.x Kubernetes API definition
```bash
# 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.
```clojure
(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
```clojure
(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:
```bash
$ source bin/source-minikube
$ echo $KUBERNETES_TOKEN
ey...
```
### Create API Token
```bash
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.
[kubernetes]: https://kubernetes.io/