Orchestra

Latest version

Orchestra is an Open Source Continuous Integration / Continuous Deployment server as a library running on Kubernetes.
It leverages Kubernetes concepts such as Jobs or Secrets, and configuration as code in Scala to take the most of compile time type safety and compatibility with Scala or Java libraries.

Key features:

  • Configured completely via code which can be version controlled
  • Fully scalable
  • Highly Available
  • Extendable via any Scala/Java libraries

Quick start

Requirements

Installation

project/plugins.sbt:

addSbtPlugin("com.drivetribe" % "sbt-orchestra" % "<latest version>")

build.sbt:

lazy val orchestration = OrchestraProject("orchestration", file("orchestration"))
  .settings(
    libraryDependencies ++= Seq(
      "com.drivetribe" %%% "orchestra-github" % orchestraVersion, // Optional Github plugin
      "com.drivetribe" %%% "orchestra-cron" % orchestraVersion, // Optional Cron plugin
      "com.drivetribe" %% "orchestra-lock" % orchestraVersion // Optional Lock plugin
    )
  )
lazy val orchestrationJVM = orchestration.jvm
lazy val orchestrationJS = orchestration.js

Simple example

Given the above installation, here is a minimal project with one job:

orchestration/src/main/scala/Orchestration.scala:

import com.drivetribe.orchestra._
import com.drivetribe.orchestra.Dsl._
import com.drivetribe.orchestra.board._
import com.drivetribe.orchestra.job._
import com.drivetribe.orchestra.model._

// We extend Orchestra to create the web server
object Orchestration extends Orchestra {
  // Configuring the UI
  lazy val board = deployFrontendJobBoard
  // Configuring the jobs
  lazy val jobs = Set(deployFrontendJob)
  
  // Creating the job and configuring UI related settings
  lazy val deployFrontendJobBoard = JobBoard[() => Unit](JobId("deployFrontend"), "Deploy Frontend")()
  // Creating the job from the above definition (this will be compiled to JVM)
  lazy val deployFrontendJob = Job(deployFrontendJobBoard) { implicit workDir => () =>
    println("Deploying Frontend")
  }
}

This example is described in Jobs & Boards.

See example projects

Deployment on Kubernetes with Minikube

We provide some basic Kubernetes Deployment in kubernetes-dev that you can use to deploy on a dev environment.
Assuming that you are in one of the example projects (or in your own project), here is how to deploy on Kubernetes with Minikube:

minikube start                            # Start Minikube
eval `minikube docker-env`                # Make docker use the docker engine of Minikube
sbt orchestrationJVM/Docker/publishLocal  # Publish the docker artifact
kubectl apply -f ../kubernetes-dev        # Apply the deployement to Kubernetes
kubectl proxy                             # Proxy the Kubernetes api

Visit Orchestra on https://127.0.0.1:8001/api/v1/namespaces/orchestra/services/orchestration:http/proxy.
You can troubleshoot any deployment issue with minikube dashboard.

More on how to configure the deployment in Config.

Documentation

Find all the documentation on https://drivetribe.github.io/orchestra/

Related projects