mingchuno / etcd4s

Scala etcd client implementing V3 APIs

GitHub

etcd4s

Build Status

A Scala etcd client implementing V3 API using gRPC and ScalaPB with optional Akka Stream support. This project is in beta stage with basic test coverage and usable APIs.

Overview

This repo is a client library of etcd implementing V3 APIs using gRPC under the hood with optional Akka Stream support for stream APIs. This library implement the complete set of the APIs in the V3 protoal. More information about the APIs can be found here:

Note that this library do not support gRPC json gateway and use raw gRPC call instead (underlying is java-grpc). Also, this project cross build against Scala 2.11 and 2.12.

Getting Started

The core lib

libraryDependencies += "com.github.mingchuno" %% "etcd4s-core" % "0.2.0"

To include akka stream support for stream API

libraryDependencies += "com.github.mingchuno" %% "etcd4s-akka-stream" % "0.2.0"

Usage

import org.etcd4s.{Etcd4sClientConfig, Etcd4sClient}
import org.etcd4s.implicits._
import org.etcd4s.formats._
import org.etcd4s.pb.etcdserverpb._

import scala.concurrent.ExecutionContext.Implicits.global

// create the client
val config = Etcd4sClientConfig(
  address = "127.0.0.1",
  port = 2379
)
val client = Etcd4sClient.newClient(config)

// set a key
client.kvService.setKey("foo", "bar") // return a Future

// get a key
client.kvService.getKey("foo").foreach { result =>
  assert(result == Some("bar"))
}

// delete a key
client.kvService.deleteKey("foo").foreach { result =>
  assert(result == 1)
}

// set more key
client.kvService.setKey("foo/bar", "Hello")
client.kvService.setKey("foo/baz", "World")

// get keys with range
client.kvService.getRange("foo/").foreach { result =>
  assert(result.count == 2)
}

// remember to shutdown the client
client.shutdown()

If you want the Akka Stream support for the stream APIs, you should add the etcd4s-akka-stream depns into your build.sbt

import org.etcd4s.akkasupport._
import org.etcd4s.implicits._
import org.etcd4s.pb.etcdserverpb._
import akka.NotUsed

// assume you have the implicit value and client needed in the scope
val flow: Flow[WatchRequest, WatchResponse, NotUsed] = client.rpcClient.watchRpc.watchFlow
Source.single(WatchRequest().withCreateRequest(WatchCreateRequest().withKey("foo")))
  .via(flow)
  .runForeach { resp =>
    println(resp)
  }

More example usage under the test dir in the repo.

Development

Requirment

  • Java 8+, Scala 12.12.X+, sbt and docker
# to start a background etcd for development
docker-compose up -d

How to start?

Simple! Just sbt test

Publish

This is to remind me how to publish and may switch to sbt-release later

  1. make sure you have ~/.sbt/gpg/ ready with pub/sec key paris
  2. make sure you have ~/.sbt/1.0/sonatype.sbt ready with credentials
  3. sbt "+clean" "+compile"
  4. sbt "+publishSigned"
  5. sbt sonatypeReleaseAll