Scala client for the Kubernetes API.
This example lists pods in kube-system
namespace:
import skuber._
import skuber.json.format._
import org.apache.pekko.actor.ActorSystem
import scala.util.{Success, Failure}
implicit val system = ActorSystem()
implicit val dispatcher = system.dispatcher
val k8s = k8sInit
val listPodsRequest = k8s.list[PodList](Some("kube-system"))
listPodsRequest.onComplete {
case Success(pods) => pods.items.foreach { p => println(p.name) }
case Failure(e) => throw(e)
}
Read the documentation and join discord community to ask your questions!
kubeconfig
files for configuration - see the configuration guide for detailsk8s get[Deployment]("nginx")
returns a value of type Future[Deployment]
A Kubernetes cluster is needed at runtime. For local development purposes, minikube is recommended. To get minikube follow the instructions here
You can use the latest release by adding to your build:
libraryDependencies += "io.github.hagay3" %% "skuber" % "4.0.2"
Building the library from source is very straightforward. Simply run sbt test
in the root directory of the project to build the library (and examples) and run the unit tests to verify the build.
The CI parameters defined in build.sbt
.
ci.yaml and clean.yaml are generated automatically with sbt-github-actions plugin.
Run sbt githubWorkflowGenerate && bash infra/ci/fix-workflows.sh
in order to regenerate ci.yaml and clean.yaml.
CI Running against the following k8s versions
skuber supports all other k8s versions, not all of them tested under CI.
https://kubernetes.io/releases/
I'm trying to be responsive to any new issues, you can create github issue or contact me.
Skuber chat on discord: https://discord.gg/byEh56vFJR
Email: hagay3@gmail.com