Skip to content

Latest commit

 

History

History
148 lines (97 loc) · 5.48 KB

README.md

File metadata and controls

148 lines (97 loc) · 5.48 KB
Raw

Build Status Maven Central License

NOTE A beta release of Skuber 3 is available now which supports (for Scala 2.13 only in this beta) separate Pekko and Akka clients - see https://github.com/doriordan/skuber/tree/30refactor#skuber-3---for-pekko-and-akka-users for details

Skuber

Skuber is a Scala client library for Kubernetes. It provides a fully featured, high-level and strongly typed Scala API for managing Kubernetes cluster resources (such as Pods, Services, Deployments, ReplicaSets, Ingresses etc.) via the Kubernetes REST API server.

Features

  • Comprehensive support for Kubernetes API model represented as Scala case classes
  • Support for core, extensions and other Kubernetes API groups
  • Full support for converting resources between the case class and standard JSON representations
  • Client API for creating, reading, updating, removing, listing and watching resources on a Kubernetes cluster
  • The API is asynchronous and strongly typed e.g. k8s get[Deployment]("nginx") returns a value of type Future[Deployment]
  • Fluent API for creating and updating specifications of Kubernetes resources
  • Uses standard kubeconfig files for configuration - see the configuration guide for details

See the programming guide for more details.

Example

This example lists pods in kube-system namespace:

import skuber._
import skuber.json.format._
import akka.actor.ActorSystem
import scala.util.{Success, Failure}

implicit val system = ActorSystem()
implicit val dispatcher = system.dispatcher

val k8s = k8sInit
val listPodsRequest = k8s.listInNamespace[PodList]("kube-system")
listPodsRequest.onComplete {
  case Success(pods) => pods.items.foreach { p => println(p.name) }
  case Failure(e) => throw(e)
}

See more elaborate example here.

Quick Start

Make sure prerequisites are met. There are couple of quick ways to get started with Skuber:

With Ammonite-REPL

Provides you with a configured client on startup. It is handy to use this for quick experiments.

  • using bash

    $ amm -p ./Quickstart.sc

  • from inside ammonite-repl:

    import $file.`Quickstart`, Quickstart._

    Just handy shortcut to import skuber inside ammonite-repl:

    import $ivy.`io.skuber::skuber:2.6.7`, skuber._, skuber.json.format._

Interactive with sbt

  • Clone this repository.

  • Tell Skuber to configure itself from the default Kubeconfig file ($HOME/.kube/config):

    export SKUBER_CONFIG=file

    Read more about Skuber configuration here

  • Run sbt and try one or more of the examples and then:

    sbt:root> project examples
sbt:skuber-examples> run

Multiple main classes detected, select one to run:

 [1] skuber.examples.customresources.CreateCRD
 [2] skuber.examples.deployment.DeploymentExamples
 [3] skuber.examples.fluent.FluentExamples
 [4] skuber.examples.guestbook.Guestbook
 [5] skuber.examples.ingress.NginxIngress
 [6] skuber.examples.job.PrintPiJob
 [7] skuber.examples.list.ListExamples
 [8] skuber.examples.patch.PatchExamples
 [9] skuber.examples.podlogs.PodLogExample
 [10] skuber.examples.scale.ScaleExamples
 [11] skuber.examples.watch.WatchExamples

Enter number:

For other Kubernetes setups, see the configuration guide for details on how to tailor the configuration for your clusters security, namespace and connectivity requirements.

Prerequisites

  • Java 8
  • Kubernetes cluster

A Kubernetes cluster is needed at runtime. For local development purposes, minikube is recommended. To get minikube follow the instructions here

Release

You can use the latest release (for 2.12 or 2.13) by adding to your build:

libraryDependencies += "io.skuber" %% "skuber" % "2.6.7"

Meanwhile users of skuber v1 can continue to use the final v1.x release, which is available only on Scala 2.11:

libraryDependencies += "io.skuber" % "skuber_2.11" % "1.7.1"

NOTE: Skuber 2 supports Scala 2.13 since v2.4.0 - support for Scala 2.11 has now been removed since v2.6.0.

Migrating to release v2

If you have an application using the legacy version v1 of Skuber and want to move to v2, then check out the migration guide.

Building

Building the library from source is very straightforward. Simply run sbt testin the root directory of the project to build the library (and examples) and run the unit tests to verify the build.

License

This code is licensed under the Apache V2.0 license, a copy of which is included here.

IMPORTANT: Akka License Model Changes

Lightbend have moved Akka versions starting from 2.7.x from an Apache 2.0 to BSL license. Skuber currently uses Akka 2.6.x and it is not planned to move to a BSL licensed Akka version - instead it is planned to migrate Skuber to the Apache Pekko open-source fork once it has a full release.