Merge pull request #126 from vaslabs/feature/helmSupport

Helm plugin

Author: vaslabs

README.md

@@ -48,7 +48,7 @@ kubeyml:gen
 | envs | Map of environment variables, raw, field path or secret are supported| empty |
 | resourceRequests | Resource requests (cpu in the form of m, memory in the form of MiB |  `Resource(Cpu(100), Memory(256))` |
 | resourceLimits | Resource limits (cpu in the form of m, memory in the form of MiB |  `Resource(Cpu(1000), Memory(512))` |
-| target | The directory to output the deployment.yml | target of this project |
+| target | The directory to output the deployment.yml | <target of this project> / kubeyml |
 | deployment | The key to access the whole Deployment definition, exposed for further customisation | Instance with above defaults |
 
 ### Recipes

site/docs/akka-cluster/index.md

@@ -1,7 +1,7 @@
 ---
 layout: docs
 title:  "Akka Cluster"
-position: 4
+position: 5
 ---
 
 # Akka cluster support

site/docs/helm/index.md

@@ -0,0 +1,38 @@
+---
+layout: docs
+title:  "Helm Support"
+position: 4
+---
+# Helm support
+
+**This is an experimental feature**
+
+It is possible since 0.3.9 to generate a helm compatible structure.
+
+You have to simply enable HelmPlugin
+
+```scala  
+  enablePlugins(KubeDeploymentPlugin, KubeServicePlugin, KubeIngressPlugin, HelmPlugin)
+```
+
+This will generate under target/kubeyml a Chart.yml and a templates/ directory
+with all the kubernetes manifests already rendered.
+
+The aim for this is that you can have the whole templating done with Scala
+in your sbt build configuration.
+
+## Mixing the file
+
+If you want to have a hybrid solution you can mix helm templates and 
+this plugin. 
+
+In order to make the plugin store the files somewhere other than target/kubeyml
+you can override the setting.
+
+
+```scala
+(target in kube) := ".deployment/templates"
+```
+
+Remember that if you override the target you need to point to a templates directory
+

site/src/main/resources/microsite/data/menu.yml

@@ -24,6 +24,10 @@ options:
         menu_section: ingress
         url: ingress/recipe/
 
+  - title: Helm
+    url: helm/
+    menu_section: helm
+
   - title: Akka cluster
     url: akka-cluster/
     menu_section: akka_cluster

src/main/scala/kubeyml/deployment/plugin/Keys.scala

@@ -59,10 +59,11 @@ trait Keys {
 object Keys extends Keys {
 
   lazy val deploymentSettings: Seq[Def.Setting[_]] = Seq(
+    (target in kube) := (target in ThisProject).value / "kubeyml",
     gen in kube :=
       Plugin.generate(
         (deployment in kube).value,
-        (target in ThisProject).value
+        (target in kube).value
       ),
     namespace := (name in ThisProject).value,
     application := (name in ThisProject).value,

src/main/scala/kubeyml/helm/Keys.scala

@@ -0,0 +1,45 @@
+/*
+ * Copyright (c) 2019 Vasilis Nicolaou
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of
+ * this software and associated documentation files (the "Software"), to deal in
+ * the Software without restriction, including without limitation the rights to
+ * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+ * the Software, and to permit persons to whom the Software is furnished to do so,
+ * subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+ * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+ * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+package kubeyml.helm
+
+import kubeyml.deployment.plugin.Keys.application
+import kubeyml.deployment.plugin.Keys.{gen, kube}
+import sbt.Def
+import sbt._
+import sbt.Keys._
+import kubeyml.protocol.NonEmptyString
+
+object Keys {
+
+  lazy val helmSettings: Seq[Def.Setting[_]] = Seq(
+    (target in kube) := (target in kube).value / "templates",
+      gen in kube := {
+      (gen in kube).value
+      val chartTarget = (target in kube).value
+      val chart = Chart(
+        NonEmptyString((version in ThisBuild).value),
+        NonEmptyString((application in kube).value)
+      )
+      Plugin.generate(chart, chartTarget.getParentFile)
+    }
+  )
+}

src/main/scala/kubeyml/helm/Plugin.scala

@@ -0,0 +1,41 @@
+/*
+ * Copyright (c) 2019 Vasilis Nicolaou
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of
+ * this software and associated documentation files (the "Software"), to deal in
+ * the Software without restriction, including without limitation the rights to
+ * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+ * the Software, and to permit persons to whom the Software is furnished to do so,
+ * subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+ * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+ * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+package kubeyml.helm
+
+import java.io.File
+
+import sbt.AutoPlugin
+import kubeyml.deployment.plugin.Keys.kube
+
+import json_support._
+
+object HelmPlugin extends AutoPlugin {
+  override def trigger = noTrigger
+
+  override val projectSettings = sbt.inConfig(kube)(Keys.helmSettings)
+}
+
+object Plugin {
+
+  def generate(chart: Chart, file: File) =
+    kubeyml.plugin.writePlan(chart, file, "Chart")
+}

src/main/scala/kubeyml/helm/Protocol.scala

@@ -0,0 +1,29 @@
+/*
+ * Copyright (c) 2019 Vasilis Nicolaou
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of
+ * this software and associated documentation files (the "Software"), to deal in
+ * the Software without restriction, including without limitation the rights to
+ * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+ * the Software, and to permit persons to whom the Software is furnished to do so,
+ * subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+ * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+ * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+package kubeyml.helm
+
+import kubeyml.protocol.NonEmptyString
+
+case class Chart(
+  version: NonEmptyString,
+  name: NonEmptyString
+)

src/main/scala/kubeyml/helm/json_support.scala

@@ -0,0 +1,38 @@
+/*
+ * Copyright (c) 2019 Vasilis Nicolaou
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of
+ * this software and associated documentation files (the "Software"), to deal in
+ * the Software without restriction, including without limitation the rights to
+ * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+ * the Software, and to permit persons to whom the Software is furnished to do so,
+ * subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+ * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+ * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+package kubeyml.helm
+
+import io.circe.{Encoder, Json}
+import io.circe.syntax._
+import kubeyml.protocol.json_support._
+
+object json_support {
+
+  implicit val chartEncoder: Encoder[Chart] = Encoder.instance(
+    c =>
+      Json.obj(
+        "apiVersion" -> "v2".asJson,
+        "name" -> c.name.asJson,
+        "version" -> c.version.asJson
+      )
+  )
+}

src/main/scala/kubeyml/ingress/plugin/Keys.scala

@@ -49,7 +49,7 @@ object Keys extends Keys {
       Plugin.generate(
         (ServiceKeys.service in kube).value,
         (Keys.ingress in kube).value,
-        (target in ThisProject).value,
+        (target in kube).value,
         (streams.value.log)
       )
     },

src/main/scala/kubeyml/plugin/package.scala

@@ -30,9 +30,8 @@ import io.circe.yaml.syntax._
 package object plugin {
 
   private[kubeyml] def writePlan[A](a: A, buildTarget: File, kind: String)(implicit encoder: Encoder[A]) = {
-    val genTarget = new File(buildTarget, "kubeyml")
-    genTarget.mkdirs()
-    val file = new File(genTarget, s"${kind}.yml")
+    buildTarget.mkdirs()
+    val file = new File(buildTarget, s"${kind}.yml")
     val printWriter = new PrintWriter(file)
     try {
       printWriter.println(a.asJson.asYaml.spaces4)
@@ -44,9 +43,8 @@ package object plugin {
   private[kubeyml] def writePlansInSingle[A, B](a: A, b: B, buildTarget: File, kind: String)(implicit
                                               encoderA: Encoder[A], encoder: Encoder[B]
   ) = {
-    val genTarget = new File(buildTarget, "kubeyml")
-    genTarget.mkdirs()
-    val file = new File(genTarget, s"${kind}.yml")
+    buildTarget.mkdirs()
+    val file = new File(buildTarget, s"${kind}.yml")
     val printWriter = new PrintWriter(file)
     try {
       printWriter.println(a.asJson.asYaml.spaces4)

src/main/scala/kubeyml/roles/akka/cluster/plugin/Keys.scala

@@ -69,7 +69,7 @@ object Keys extends Keys {
           Essential.subjects(namespace),
           RoleRef(role)
         ),
-        (target in ThisProject).value
+        (target in kube).value
       )
     }
   )

src/main/scala/kubeyml/service/plugin/Keys.scala

@@ -43,7 +43,7 @@ object Keys extends Keys {
       (gen in kube).value
       Plugin.generate(
         (Keys.service in kube).value,
-        (target in ThisProject).value
+        (target in kube).value
       )
     },
     (service in kube) := Service.fromDeployment(