added README and LICENSE

LICENSE.txt

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

README.md

@@ -0,0 +1,69 @@
+# Skuber
+
+Skuber is a Scala client library for [Kubernetes](http://kubernetes.io). It provides a high-level and strongly typed Scala API for remotely managing and reactively monitoring Kubernetes resources (such as Pods, Containers, Services, Replication Controllers etc.) via the Kubernetes API server.
+
+The client supports v1 of the Kubernetes REST API.
+
+## Sample Usage
+
+The code block below illustrates the simple steps required to create a replicated nginx service on a Kubernetes cluster.
+
+The service uses five replicated pods, each running a Docker container of an nginx image (Kubernetes will automatically pull the image if necessary). Each pod publishes the exposed port 80 of its container, on which the nginx service is running.
+
+The service can be accessed from outside the cluster at port 30001 on each node, which Kubernetes proxies to port 80 on the service endpoints (i.e. the pods in which the nginx containers are currently running). 
+
+    import skuber._
+    import skuber.json.format._
+
+    val nginxSelector  = Map("app" -> "nginx")
+    val nginxContainer = Container("nginx",image="nginx").port(80)
+    val nginxController= ReplicationController("nginx",nginxContainer,nginxSelector).withReplicas(5)
+    val nginxService   = Service("nginx", nginxSelector, Service.Port(port=80, nodePort=30001)) 
+
+    import scala.concurrent.ExecutionContext.Implicits.global
+
+    val k8s = k8sInit
+
+    val createOnK8s = for {
+      rc  <- k8s create nginxController
+      svc <- k8s create nginxService
+    } yield (rc,svc)
+
+    createOnK8s onComplete {
+      case Success(_) => System.out.println("Successfully created nginx replication controller & service on Kubernetes cluster")
+      case Failure(ex) => System.err.println("Encountered exception trying to create resources on Kubernetes cluster: " + ex)
+    }
+
+    k8s.close
+
+The code snippet above illustrates only a small part of the Skuber functionality, which covers most of the capabilites of the Kubernetes API  - for more examples see the reactive Guestbook example in the examples project, and the tests under client/src/test/scala.
+
+## Features
+
+- Comprehensive Scala case class representations of the Kubernetes types supported by the API server; including Pod, Service, ReplicationController, Nodes, Container, Endpoint, Namespace, Volume, PersistentVolume, Resource, Security, EnvVar, ServiceAccount, LimitRange, Secret, Event and others
+- Support for Kubernetes object, list and simple kinds
+- Fluent API for building the desired specification ("spec") of a Kubernetes object to be created or updated on the server 
+- Implicit json formatters for reading and writing the Kubernetes types
+- Support for create, get, delete, list, update, and watch operations on Kubernetes types using an asynchronous and type-safe interface that maps each operation to the appropriate Kubernetes RESTful API HTTP requests. 
+- Watching Kubernetes objects returns Iteratees for reactive processing of events from the cluster
+- Client contexts (including connection details and namespace) can be configured by a combination of system properties and a config file format based on the Kubernetes kubeconfig file YAML format
+
+## Build Instructions
+
+The project consists of two sub-projects - the main Skuber client library (under the 'client' directory) and an 'examples' project which currently contains just the reactive Guestbook example.
+
+A sbt build file is provided at the top-level directory, so you can use standard SBT commands to build JARs for both projects or select one project to build.
+
+The reactive guestbook example can be built and run as a fat JAR using the sbt assembly plug-in, which is probably the quickest way to get it up and running.
+
+## Requirements
+
+The client library requires Java 8. The build uses sbt 0.13. A Kubernetes cluster that supports v1.0 of the API is a runtime requirement. 
+
+## Status
+
+The coverage of the Kubernetes API functionality by Skuber is extensive, however this is an early ALPHA release with all the caveats that implies. 
+
+- Testing has largely used the default configuration, which connects to a Kubernetes cluster via a kubectl proxy running on localhost:8001 and uses the default namespace. Your mileage may vary with other client configurations.
+- If some functionality isn't covered by the tests and examples included in this release you should assume it hasn't been tested.
+- Documentation is currently sparse to non-existent - in practice a reasonable knowledge of both Kubernetes and Scala will be a prerequisite, from there the Skuber tests and example should help get you up and running. 

build.sbt

@@ -9,7 +9,6 @@ val commonsIO = "commons-io" % "commons-io" % "2.4"
 val playIterateesExtra = "com.typesafe.play.extras" %% "iteratees-extras" % "1.5.0"
 
 // Akka is required by the examples 
-
 val akka ="com.typesafe.akka" %% "akka-actor" % "2.4.0"
 
 // Need Java 8 or later as the java.time package is used to represent K8S timestamps
@@ -23,19 +22,27 @@ lazy val commonSettings = Seq(
   scalaVersion := "2.11.7"
 )
 
+lazy val skuberSettings = Seq(
+  name := "skuber-client",
+  libraryDependencies ++= Seq(playws,playIterateesExtra,snakeYaml,commonsIO,scalaCheck % Test,specs2 % Test).
+				map(_.exclude("commons-logging","commons-logging"))
+)
+
+lazy val examplesSettings = Seq(
+  name := "skuber-examples",
+  libraryDependencies += akka
+)
+
 lazy val root = (project in file(".")) aggregate(
   client,
   examples)
 
 lazy val client = (project in file("client")).
   settings(commonSettings: _*).
-  settings(
-    libraryDependencies ++= Seq(playws,playIterateesExtra,snakeYaml,commonsIO,scalaCheck % Test,specs2 % Test).
-				map(_.exclude("commons-logging","commons-logging"))
-  )
+  settings(skuberSettings: _*)
 
 lazy val examples = (project in file("examples")).
   settings(commonSettings: _*).
-  settings(libraryDependencies += akka).
+  settings(examplesSettings: _*).
   dependsOn(client)
 

client/src/main/scala/skuber/Container.scala

@@ -23,6 +23,18 @@ case class Container(
     imagePullPolicy: Container.PullPolicy.Value = Container.PullPolicy.IfNotPresent,
     securityContext: Option[Security.Context] = None)
       extends Limitable
+{
+  def port(port: Int, prot:Protocol.Value = Protocol.TCP) : Container = 
+    this.copy(ports=Container.Port(containerPort=port, protocol=prot)::this.ports)        
+  def port(p: Container.Port) : Container = this.copy(ports=p::this.ports)
+  def env(e: (String, String)*) = {
+    import EnvVar.strToValue
+    val envVarSeq = e map { case (n,v) => EnvVar(n,v) }
+    this.copy(env = this.env ++ envVarSeq)
+  }
+  def entrypoint(cmd: String*) = this.copy(command=cmd.toList)
+}
+
 
 object Container {
 

client/src/main/scala/skuber/ReplicationController.scala

@@ -38,6 +38,16 @@ object ReplicationController {
     def apply(name: String) : ReplicationController = ReplicationController(metadata=ObjectMeta(name=name))
     def apply(name: String, spec: ReplicationController.Spec) : ReplicationController = 
                           ReplicationController(metadata=ObjectMeta(name=name), spec = Some(spec))
+    def apply(name:String, container: Container, selector: Map[String, String]) : ReplicationController = {
+      val podSpec=Pod.Spec(containers=List(container))
+      apply(name, podSpec, selector)
+    }
+    def apply(name:String, podSpec: Pod.Spec, selector: Map[String, String]) : ReplicationController = {
+      val meta=ObjectMeta(name=name, labels = selector)
+      val templSpec=Pod.Template.Spec(metadata=meta, spec=Some(podSpec))
+      ReplicationController(metadata=meta, spec=Some(Spec(template=Some(templSpec),selector=Some(selector))))
+    }
+
     case class Spec(
       replicas: Int=1,
       selector: Option[Map[String, String]] = None,

client/src/main/scala/skuber/Service.scala

@@ -25,8 +25,15 @@ object Service {
 
    def apply(name: String): Service = Service(metadata=ObjectMeta(name=name))
    def apply(name: String, spec: Service.Spec) : Service = Service(metadata=ObjectMeta(name=name), spec = Some(spec))
+   def apply(name: String, selector: Map[String, String], port: Int): Service =
+     apply(name, selector, Port(port=port))
+   def apply(name: String, selector: Map[String,String], port: Port): Service = {
+     val meta=ObjectMeta(name=name,labels=selector)
+     val serviceType=if (port.nodePort != 0) Type.NodePort else Type.ClusterIP
+     val spec=Spec(ports=List(port), selector=selector,_type=serviceType)
+     Service(metadata=meta,spec=Some(spec))
+   }
 
-
    object Affinity extends Enumeration {
      type Affinity=Value
      val ClientIP, None=Value