Merge pull request #27 from delphi-hub/feature/dockerApiImplementation

Implementation of docker functionality in the Instance Registry

Author: johannesduesing

OpenAPISpecification.yaml

@@ -240,7 +240,7 @@ paths:
     post:
       tags:
         - Docker Operations
-      summary: Reports the successful start of an instances to the registry
+      summary: Reports the successful start of an instance to the registry
       description: >-
         This command informs the registry about an instance that successfully
         reached the state 'Running'. This is only applicable to instances
@@ -250,7 +250,7 @@ paths:
       operationId: reportStart
       parameters:
         - in: query
-          name: InstanceID
+          name: Id
           description: The ID of the instance that was started
           required: true
           type: integer
@@ -259,7 +259,36 @@ paths:
         '200':
           description: Report successfully processed.
         '400':
-          description: Bad request, the instance with the specified ID is not deployed as a docker container.
+          description: >-
+            Bad request, the instance with the specified ID is not deployed as a
+            docker container.
+        '404':
+          description: ID not found on server
+        '500':
+          description: Internal server error
+  /reportStop:
+    post:
+      tags:
+        - Docker Operations
+      summary: Reports the manual stop of an instances to the registry
+      description: >-
+        This command informs the registry about an instance that was stopped manually, meaning not via calling /stop on the instance registry. This is only applicable to instances
+        running inside a docker container, as non-container instances would deregister themselves when stopped. 
+      operationId: reportStop
+      parameters:
+        - in: query
+          name: Id
+          description: The ID of the instance that was stopped
+          required: true
+          type: integer
+          format: int64
+      responses:
+        '200':
+          description: Report successfully processed.
+        '400':
+          description: >-
+            Bad request, the instance with the specified ID is not deployed as a
+            docker container.
         '404':
           description: ID not found on server
         '500':
@@ -280,7 +309,7 @@ paths:
       operationId: reportFailure
       parameters:
         - in: query
-          name: InstanceID
+          name: Id
           description: The ID of the instance that encountered the failure
           required: true
           type: integer
@@ -294,7 +323,9 @@ paths:
         '200':
           description: Report successfully processed.
         '400':
-          description: Bad request, the instance with the specified ID is not deployed as a docker container.
+          description: >-
+            Bad request, the instance with the specified ID is not deployed as a
+            docker container.
         '404':
           description: ID not found on server
         '500':
@@ -304,20 +335,24 @@ paths:
       tags:
         - Docker Operations
       summary: Pauses the specified instances' docker container
-      description: This command pauses the docker container of the instance with the specified ID. Will change the instance state from 'Running' to 'Paused'
+      description: >-
+        This command pauses the docker container of the instance with the
+        specified ID. Will change the instance state from 'Running' to 'Paused'
       operationId: pause
       parameters:
         - in: query
-          name: InstanceID
+          name: Id
           description: The ID of the instance to be paused
           required: true
           type: integer
           format: int64
       responses:
         '202':
-          description: Accepted, the operation will be completed in the future.
+          description: 'Accepted, the operation will be completed in the future.'
         '400':
-          description: Bad request, the instance with the specified ID is either not running or not deployed as a docker container at all.
+          description: >-
+            Bad request, the instance with the specified ID is either not
+            running or not deployed as a docker container at all.
         '404':
           description: ID not found on server
         '500':
@@ -327,20 +362,25 @@ paths:
       tags:
         - Docker Operations
       summary: Resumes the specified instances' docker container
-      description: This command resumes the execution of the docker container of the instance with the specified ID. Will change the instance state from 'Paused' to 'Running'.
+      description: >-
+        This command resumes the execution of the docker container of the
+        instance with the specified ID. Will change the instance state from
+        'Paused' to 'Running'.
       operationId: resume
       parameters:
         - in: query
-          name: InstanceID
+          name: Id
           description: The ID of the instance to be resumed
           required: true
           type: integer
           format: int64
       responses:
         '202':
-          description: Accepted, the operation will be completed in the future.
+          description: 'Accepted, the operation will be completed in the future.'
         '400':
-          description: Bad request, the instance with the specified ID is either not paused or not deployed as a docker container at all.
+          description: >-
+            Bad request, the instance with the specified ID is either not paused
+            or not deployed as a docker container at all.
         '404':
           description: ID not found on server
         '500':
@@ -350,20 +390,25 @@ paths:
       tags:
         - Docker Operations
       summary: Stops the specified instances' docker container
-      description: This command stops the docker container of the instance with the specified ID. The instance will be properly shut down by calling its /stop command first. Will change the instance state to 'Stopped'.
+      description: >-
+        This command stops the docker container of the instance with the
+        specified ID. The instance will be properly shut down by calling its
+        /stop command first. Will change the instance state to 'Stopped'.
       operationId: stop
       parameters:
         - in: query
-          name: InstanceID
+          name: Id
           description: The ID of the instance to be stopped
           required: true
           type: integer
           format: int64
       responses:
         '202':
-          description: Accepted, the operation will be completed in the future.
+          description: 'Accepted, the operation will be completed in the future.'
         '400':
-          description: Bad request, the instance with the specified ID is either already stopped or not deployed as a docker container at all.
+          description: >-
+            Bad request, the instance with the specified ID is either already
+            stopped or not deployed as a docker container at all.
         '404':
           description: ID not found on server
         '500':
@@ -373,20 +418,25 @@ paths:
       tags:
         - Docker Operations
       summary: Starts the specified instances' docker container
-      description: This command starts the docker container of the instance with the specified ID. Will change the instance state from 'Stopped' to 'Running'.
+      description: >-
+        This command starts the docker container of the instance with the
+        specified ID. Will change the instance state from 'Stopped' to
+        'Running'.
       operationId: start
       parameters:
         - in: query
-          name: InstanceID
+          name: Id
           description: The ID of the instance to be started
           required: true
           type: integer
           format: int64
       responses:
         '202':
-          description: Accepted, the operation will be completed in the future.
+          description: 'Accepted, the operation will be completed in the future.'
         '400':
-          description: Bad request, the instance with the specified ID is either not stopped or not deployed as a docker container at all.
+          description: >-
+            Bad request, the instance with the specified ID is either not
+            stopped or not deployed as a docker container at all.
         '404':
           description: ID not found on server
         '500':
@@ -396,28 +446,37 @@ paths:
       tags:
         - Docker Operations
       summary: Deletes the specified instances' docker container
-      description: This command deletes the docker container of the instance with the specified ID. The container needs to be stopped first. This will remove any data the instance registry holds about the instance.
+      description: >-
+        This command deletes the docker container of the instance with the
+        specified ID. The container needs to be stopped first. This will remove
+        any data the instance registry holds about the instance.
       operationId: delete
       parameters:
         - in: query
-          name: InstanceID
+          name: Id
           description: The ID of the instance to be deleted
           required: true
           type: integer
           format: int64
       responses:
         '202':
-          description: Accepted, the operation will be completed in the future.
+          description: 'Accepted, the operation will be completed in the future.'
         '400':
-          description: Bad request, the instance with the specified ID is either not stopped or not deployed as a docker container at all.
+          description: >-
+            Bad request, the instance with the specified ID is either not
+            stopped or not deployed as a docker container at all.
         '404':
           description: ID not found on server
         '500':
           description: Internal server error
 definitions:
   Instance:
     type: object
-    required: [host, portNumber, name, componentType]
+    required:
+      - host
+      - portNumber
+      - name
+      - componentType
     properties:
       id:
         type: integer
@@ -455,4 +514,3 @@ definitions:
           - Stopped
           - Paused
           - NotReachable
-      

src/main/scala/de/upb/cs/swt/delphi/instanceregistry/Configuration.scala

@@ -4,6 +4,17 @@ class Configuration( ) {
   val bindHost: String = "0.0.0.0"
   val bindPort: Int = 8087
   val recoveryFileName : String = "dump.temp"
+
+  val defaultCrawlerPort: Int = 8882
+  val defaultWebApiPort: Int = 8080
+  val defaultWepAppPort: Int  = 8085
+
+  val crawlerDockerImageName: String = "delphi-crawler:1.0.0-SNAPSHOT"
+  val webApiDockerImageName: String = "delphi-webapi:1.0.0-SNAPSHOT"
+  val webAppDockerImageName: String = "delphi-webapp:1.0.0-SNAPSHOT"
+
+
+
 }
 
 

src/main/scala/de/upb/cs/swt/delphi/instanceregistry/Docker/Commands.scala

@@ -0,0 +1,30 @@
+package de.upb.cs.swt.delphi.instanceregistry.Docker
+
+import akka.NotUsed
+import akka.http.scaladsl.model.{HttpResponse, StatusCodes}
+import akka.http.scaladsl.unmarshalling.Unmarshal
+import akka.stream.Materializer
+import akka.stream.scaladsl.{Sink, Source}
+import de.upb.cs.swt.delphi.instanceregistry.AppLogging
+
+import scala.concurrent.{ExecutionContext, Future}
+
+trait Commands extends AppLogging{
+  def unknownResponse(response: HttpResponse)(implicit ec: ExecutionContext, mat: Materializer): Source[Nothing, NotUsed] = {
+    import akka.http.scaladsl.unmarshalling.PredefinedFromEntityUnmarshallers._
+
+    Source.fromFuture(Unmarshal(response.entity).to[String](stringUnmarshaller, ec, mat).map { entity =>
+      if (response.status == StatusCodes.InternalServerError) {
+        //println("exception")
+
+        throw new ServerErrorException(response.status, entity)
+      } else {
+        throw new UnknownResponseException(response.status, entity)
+      }
+    })
+  }
+
+  def unknownResponseFuture(response: HttpResponse)(implicit ec: ExecutionContext, mat: Materializer): Future[Nothing] = {
+    unknownResponse(response).runWith(Sink.head)
+  }
+}

src/main/scala/de/upb/cs/swt/delphi/instanceregistry/Docker/Container.scala

@@ -0,0 +1,39 @@
+package de.upb.cs.swt.delphi.instanceregistry.Docker
+
+sealed trait ContainerId {
+  def value: String
+}
+
+case class ContainerName(name: String) extends ContainerId {
+  override def value = name
+
+  override def toString = name
+}
+
+case class CreateContainerResponse(Id: String, Warnings: Option[String])
+
+case class ContainerStatus(
+                            Command: String,
+                            Id: String,
+                            Image: String,
+                            Names: Seq[String],
+                            Labels: Map[String, String],
+                            Status: String
+                          )
+
+case class ContainerConfig(
+                            Image: String,
+                            Entrypoint: Option[Seq[String]] = None,
+                            Cmd: Seq[String] = Seq.empty,
+                            Env: Seq[String] = Seq.empty)
+
+case class Networks(
+                     IPAddress: String
+                   )
+
+object PortBinding {
+  def apply(HostPort: Int): PortBinding = new PortBinding(HostPort = HostPort)
+}
+
+case class PortBinding(HostIp: String = "0.0.0.0",
+                       HostPort: Int)