{"id":19891359,"url":"https://github.com/lightbend/deckhand","last_synced_at":"2026-01-03T13:05:04.840Z","repository":{"id":142746543,"uuid":"162755690","full_name":"lightbend/deckhand","owner":"lightbend","description":"sbt companion for Kubernetes and OpenShift","archived":false,"fork":false,"pushed_at":"2019-05-30T00:20:32.000Z","size":473,"stargazers_count":2,"open_issues_count":1,"forks_count":2,"subscribers_count":10,"default_branch":"master","last_synced_at":"2025-01-22T19:37:11.815Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Scala","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/lightbend.png","metadata":{"files":{"readme":"README.markdown","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-12-21T20:35:11.000Z","updated_at":"2024-02-19T12:18:27.000Z","dependencies_parsed_at":null,"dependency_job_id":"72ce41e9-cb05-4184-9c25-3e3992097b36","html_url":"https://github.com/lightbend/deckhand","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lightbend%2Fdeckhand","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lightbend%2Fdeckhand/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lightbend%2Fdeckhand/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lightbend%2Fdeckhand/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lightbend","download_url":"https://codeload.github.com/lightbend/deckhand/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243836029,"owners_count":20355616,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-12T18:17:59.155Z","updated_at":"2026-01-03T13:04:59.821Z","avatar_url":"https://github.com/lightbend.png","language":"Scala","funding_links":[],"categories":[],"sub_categories":[],"readme":"Deckhand\n========\n\n*sbt companion for Kubernetes and OpenShift.*\n\n![07-27-1962_18855F Pakhuis Maandag](doc/Pakhuis_Maandag.jpg)\n\n### Status\n\nIncubating.\n\n### Setup\n\nFor sbt 1.x add the following to `project/plugins.sbt`:\n\n```scala\naddSbtPlugin(\"com.lightbend.rp\" % \"sbt-deckhand\" % \"X.Y.Z\")\n```\n\nSee [releases](https://github.com/lightbend/deckhand/releases) for the latest release.\n\nUsage\n-----\n\nsbt-deckhand introduces `Deckhand` object to your `build.sbt`, which is intended to drive an OpenShift cluster during integration testing.\n\n### Deckhand.kubectl\n\nExample:\n\n```scala\nlazy val check = taskKey[Unit](\"check\")\n\ncheck := {\n  val s = streams.value\n  val namespace = \"somenamespace\"\n  val kubectl = Deckhand.kubectl(s.log)\n  val yamlDir = baseDirectory.value / \"kubernetes\"\n\n  try {\n    kubectl.tryCreate(s\"namespace $namespace\")\n    kubectl.setCurrentNamespace(namespace)\n    kubectl.apply(yamlDir / \"akka-cluster.yaml\")\n    kubectl.waitForPods(3)\n    kubectl.describe(\"pods\")\n\n    // do something here...\n  } finally {\n    kubectl.delete(s\"services,pods,deployment --all --namespace $namespace\")\n    kubectl.waitForPods(0)\n  }\n}\n```\n\n`Deckhand.kubectl(s.log)` returns `Kubectrl` value, which is a thin wrapper around `kubectl` and `oc` command line.\nIt provides methods such as `apply`, `get`, and `logs` each corresponding to `kubectl apply`, `kubectl get`, and `kubectl logs`.\n\nSee [Kubectl.scala](src/main/scala/com/lightbend/rp/sbtdeckhand/Kubectl.scala) for details.\n\n#### waitForPods\n\n`waitForPods` is a utility method to wait for the given number of pods.\n\n```scala\nkubectl.waitForPods(3)\n```\n\nOptionally you can also pass in String arguments to `kubectl get` to narrow down the pods to wait for:\n\n```scala\nkubectl.waitForPods(3, \"--selector app=bootstrap-kapi-demo\")\n```\n\n#### checkAkkaCluster\n\n`checkAkkaCluster` is a utility method to wait for an Akka Cluster to bootstrap itself with the given number of members.\n\n```scala\nkubectl.checkAkkaCluster(3)\n```\n\n#### Deckhand.mustache\n\nFor simple templating, Deckhand provides [Mustache](https://mustache.github.io/) template support, which can be used to substitute variables in the YAML files.\n\nFor example given `rbac.mustache`, I'd like to plugin `{{namespace}}` in `build.sbt`.\n\n```yaml\n---\nkind: Role\napiVersion: rbac.authorization.k8s.io/v1\nmetadata:\n  name: pod-reader\nrules:\n- apiGroups: [\"\"] # \"\" indicates the core API group\n  resources: [\"pods\"]\n  verbs: [\"get\", \"watch\", \"list\"]\n---\nkind: RoleBinding\napiVersion: rbac.authorization.k8s.io/v1\nmetadata:\n  name: read-pods\nsubjects:\n- kind: User\n  name: system:serviceaccount:{{namespace}}:default\nroleRef:\n  kind: Role\n  name: pod-reader\n  apiGroup: rbac.authorization.k8s.io\n```\n\nWe can call:\n\n```scala\nval kubectl = Deckhand.kubectl(s.log)\nval yamlDir = baseDirectory.value / \"kubernetes\"\nval namespace = \"somenamespace\"\nkubectl.apply(Deckhand.mustache(yamlDir / \"rbac.mustache\"),\n  Map(\n    \"namespace\"       -\u003e namespace\n  ))\n```\n\n#### Deckhand.kustomize\n\nAlternatively, if you want to overlay specific YAML patch on top of base YAML files, Deckhand provides [Kustomize](https://github.com/kubernetes-sigs/kustomize) integration.\n\nFor example here's a patch to patch the `imagePullPolicy` to `Never` for Minikube:\n\n```yaml\napiVersion: \"apps/v1beta2\"\nkind: Deployment\nmetadata:\n  name: \"bootstrap-kapi-demo-v0-1-0\"\nspec:\n  template:\n    spec:\n      containers:\n        - name: \"bootstrap-kapi-demo\"\n          image: \"bootstrap-kapi-demo:0.1.0\"\n          imagePullPolicy: \"Never\"\n```\n\nIn `build.sbt` we can apply the variant YAML file as follows:\n\n```scala\nval kubectl = Deckhand.kubectl(s.log)\nkubectl.apply(Deckhand.kustomize(baseDirectory.value / \"overlay\" / \"minikube\"))\n```\n\n### Deckhand.docker\n\nExample:\n\n```scala\nlazy val check = taskKey[Unit](\"check\")\n\ncheck := {\n  val s = streams.value\n  val nm = name.value\n  val v = version.value\n  val namespace = \"somenamespace\"\n  val docker = Deckhand.docker(s.log)\n  docker.tag(s\"$nm:$v registry.yourcompany.com/$namespace/$nm:$v\")\n  docker.push(s\"registry.yourcompany.com/$namespace/$nm\")\n}\n```\n\n### Photo credit\n\n[Ben van Meerendonk / AHF, collectie IISG, Amsterdam](https://www.flickr.com/photos/iisg/6526598519/in/photostream/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flightbend%2Fdeckhand","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flightbend%2Fdeckhand","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flightbend%2Fdeckhand/lists"}