Added endpoint to retreive configuration information (traefik uri)

Updated readme with the config values. Updated Api specification

Author: Johannes Duesing

OpenAPISpecification.yaml

@@ -24,6 +24,25 @@ schemes:
   - https
   - http
 paths:
+  /configuration:
+    get:
+      tags:
+        - Meta
+      summary: Retreives general configuration information
+      description: Retrieves an object containing the most important configuration values of the registry. This contains the docker and traefik URIs.
+      operationId: configurationInfo
+      responses:
+        '200':
+          description: Configuration object
+          schema:
+            type: object
+            properties:
+              DockerHttpApi:
+                type: string
+                example: "172.0.2.1:9095"
+              TraefikProxyUri:
+                type: string
+                example: "172.0.2.1:80"
   /instances/register:
     post:
       tags:
@@ -374,12 +393,15 @@ paths:
           description: 'Bad request, your label exceeded the character limit'
         '404':
           description: 'Not found, the id you specified could not be found'
-  /instances/{Id}/logs:
+  '/instances/{Id}/logs':
     get:
       tags:
         - Basic Operations
       summary: Retrieve the logging output of the specified instance
-      description: This command retrieves the docker container logging output for the specified instance, if the instance is in fact running inside a docker container.
+      description: >-
+        This command retrieves the docker container logging output for the
+        specified instance, if the instance is in fact running inside a docker
+        container.
       operationId: retreiveLogs
       parameters:
         - name: Id
@@ -395,22 +417,28 @@ paths:
           type: boolean
       responses:
         '200':
-          description: Success, log string is being returned
+          description: 'Success, log string is being returned'
           schema:
             type: string
-            example: "I am logging output .."
+            example: I am logging output ..
         '400':
           description: Selected instance not running inside docker container
         '404':
           description: Id not found on the server
         '500':
           description: Internal Server Error
-  /instances/{Id}/attach:
+  '/instances/{Id}/attach':
     get:
       tags:
         - Basic Operations
       summary: Stream logging output from instance
-      description: 'This command streams the docker container logging output for the specified instance. NOTE: This is a websocket endpoint, so only valid websocket requests will be processed. Swagger does not provide sufficient support for websockets, so this documentation might be confusing as it defines a HTTP method, etc. The names of parameters and response-codes are valid though.'
+      description: >-
+        This command streams the docker container logging output for the
+        specified instance. NOTE: This is a websocket endpoint, so only valid
+        websocket requests will be processed. Swagger does not provide
+        sufficient support for websockets, so this documentation might be
+        confusing as it defines a HTTP method, etc. The names of parameters and
+        response-codes are valid though.
       operationId: streamLogs
       parameters:
         - name: Id
@@ -426,7 +454,7 @@ paths:
           type: boolean
       responses:
         '200':
-          description: Success, logs are being streamed via websocket connection.
+          description: 'Success, logs are being streamed via websocket connection.'
         '400':
           description: Selected instance not running inside docker container
         '404':
@@ -747,13 +775,12 @@ paths:
           description: One of the ids was not found on the server
         '500':
           description: Internal server error
-  /instances/{Id}/command:
+  '/instances/{Id}/command':
     post:
       tags:
         - Docker Operations
       summary: Runs a command into a docker container
-      description: >-
-        This command runs a specified command inside a docker container.
+      description: This command runs a specified command inside a docker container.
       operationId: command
       parameters:
         - in: path
@@ -773,23 +800,21 @@ paths:
             properties:
               Command:
                 type: string
-                example: "rm -rf *"
+                example: rm -rf *
               Privileged:
                 type: boolean
               User:
                 type: string
                 example: root
       responses:
         '200':
-          description: 'OK'
+          description: OK
         '400':
-          description: >-
-            Cannot run command, ID is no docker container.
+          description: 'Cannot run command, ID is no docker container.'
         '404':
-          description: Cannot run command, ID not found.
+          description: 'Cannot run command, ID not found.'
         '500':
-          description: Internal server error, unknown operation result DESCRIPTION
-  
+          description: 'Internal server error, unknown operation result DESCRIPTION'
 definitions:
   InstanceLink:
     type: object

README.md

@@ -47,6 +47,9 @@ Before you can start the application, you have to make sure your configuration f
 | :---: | :---: | :---: | :--- |
 |```bindHost``` | ```String``` | ```"0.0.0.0"``` | Host address that the registry server should be bound to |
 |```bindPort``` | ```Int``` | ```8087``` | Port that the registry server should be reachable at |
+|```traefikBaseHost``` | ```String``` | ```"delphi.cs.upb.de"``` | The host part of the URL that traefik is configured to append to instance URLs. |
+|```traefikDockerNetwork``` | ```String``` | ```"web"``` | The Docker network Traefik is configured to use. |
+|```traefikUri``` | ```String``` | ```"http://172.17.0.1:80"``` | The URI that the Traefik reverse-proxy is hosted at.|
 |```defaultCrawlerPort``` | ```Int``` | ```8882``` | Port that Delphi Crawlers are reachable at. This may only be adapted if you manually changed the default port of crawlers before registering the respective image. |
 |```defaultWebApiPort``` | ```Int``` | ```8080``` | Port that Delphi WebAPIs are reachable at. This may only be adapted if you manually changed the default port of WebAPIs before registering the respective image. |
 |```defaultWebAppPort``` | ```Int``` | ```8085``` | Port that Delphi WebApps are reachable at. This may only be adapted if you manually changed the default port of WebApps before registering the respective image. |
@@ -58,7 +61,7 @@ Before you can start the application, you have to make sure your configuration f
 |```uriInLocalNetwork``` | ```String``` | ```"http://172.17.0.1:8087"``` | URI that the registry is reachable at for all docker containers. In most of the use-cases this is going to be the gateway of the default docker bridge.<br>**Note:** For OSX you have to set this value to the DNS name of the docker host, which is ```http://host.docker.internal:8087``` (If the registry is running on the host).|
 |```maxLabelLength``` | ```Int``` | ```50``` | Maximum number of characters for instance labels. Longer labels will be rejected.|
 |```dockerOperationTimeout``` | ```Timeout``` | ```Timeout(20 seconds)``` | Default timeout for docker operations. If any of the async Docker operations (deploy, stop, pause, ..) takes longer than this, it will be aborted.|
-|```defaultDockerUri``` | ```String``` | ```http://localhost:9095``` | Default uri to connect to docker. It will be used if the environment variable ```DELPHI_DOCKER_HOST``` is not specified.|
+|```dockerUri``` | ```String``` | ```http://localhost:9095``` | Default uri to connect to docker. It will be used if the environment variable ```DELPHI_DOCKER_HOST``` is not specified.|
 |```jwtSecretKey``` | ```String``` | ```changeme``` | Secret key to use for JWT signature (HS256). This setting can be overridden by specifying the ```JWT_SECRET``` environment variable.|
 |```useInMemoryDB``` | ```Boolean``` | ```true``` | If set to true, all instance data will be kept in memory instead of using a MySQL database.|
 |```databaseHost``` | ```String``` | ```"jdbc:mysql://localhost/"``` | Host that the MySQL database is reachable at (only necessary if *useInMemoryDB* is false).|

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

@@ -12,6 +12,7 @@ class Configuration( ) {
   //Traefik data
   val traefikBaseHost: String = "delphi.cs.upb.de"
   val traefikDockerNetwork: String = "web"
+  val traefikUri: String = "http://172.17.0.1:80"
 
 
   val recoveryFileName : String = "dump.temp"
@@ -36,7 +37,7 @@ class Configuration( ) {
   val maxLabelLength: Int = 50
 
   val dockerOperationTimeout: Timeout = Timeout(20 seconds)
-  val defaultDockerUri: String = "http://localhost:9095"
+  val dockerUri: String = sys.env.getOrElse("DELPHI_DOCKER_HOST", "http://localhost:9095")
 
   val jwtSecretKey: String = sys.env.getOrElse("JWT_SECRET", "changeme")
 

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

@@ -12,13 +12,8 @@ import scala.concurrent.Future
 object DockerConnection {
 
 
-  def fromEnvironment(configuration: Configuration)(implicit system: ActorSystem, materializer: Materializer): DockerConnection = {
-    def env(key: String): Option[String] = sys.env.get(key).filter(_.nonEmpty)
-
-    val host = env("DELPHI_DOCKER_HOST").getOrElse {
-      configuration.defaultDockerUri
-    }
-    DockerHttpConnection(host)
+  def fromEnvironment(configuration: Configuration) (implicit system: ActorSystem, mat: Materializer): DockerConnection = {
+    DockerHttpConnection(configuration.dockerUri)
   }
 }
 

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

@@ -121,6 +121,10 @@ class RequestHandler(configuration: Configuration, instanceDao: InstanceDAO, con
     instanceDao.getEventsFor(id)
   }
 
+  def generateConfigurationInfo(): ConfigurationInfo = {
+    ConfigurationInfo(DockerHttpUri = configuration.dockerUri, TraefikProxyUri = configuration.traefikUri)
+  }
+
   def getMatchingInstanceOfType(callerId: Long, compType: ComponentType): (OperationResult.Value, Try[Instance]) = {
     log.info(s"Started matching: Instance with id $callerId is looking for instance of type $compType.")
     if (!instanceDao.hasInstance(callerId)) {

src/main/scala/de/upb/cs/swt/delphi/instanceregistry/connection/Server.scala

@@ -10,7 +10,7 @@ import akka.stream.scaladsl.{Flow, Sink, Source}
 import de.upb.cs.swt.delphi.instanceregistry.authorization.AccessTokenEnums.UserType
 import de.upb.cs.swt.delphi.instanceregistry.authorization.{AccessToken, AuthProvider}
 import de.upb.cs.swt.delphi.instanceregistry.io.swagger.client.model.InstanceEnums.ComponentType
-import de.upb.cs.swt.delphi.instanceregistry.io.swagger.client.model.{EventJsonSupport, Instance, InstanceJsonSupport, InstanceLinkJsonSupport}
+import de.upb.cs.swt.delphi.instanceregistry.io.swagger.client.model._
 import de.upb.cs.swt.delphi.instanceregistry.requestLimiter.{IpLogActor, RequestLimitScheduler}
 import de.upb.cs.swt.delphi.instanceregistry.{AppLogging, Registry, RequestHandler}
 import spray.json.JsonParser.ParsingException
@@ -26,6 +26,7 @@ class Server(handler: RequestHandler) extends HttpApp
   with InstanceJsonSupport
   with EventJsonSupport
   with InstanceLinkJsonSupport
+  with ConfigurationInfoJsonSupport
   with AppLogging {
 
   implicit val system: ActorSystem = Registry.system
@@ -130,6 +131,9 @@ class Server(handler: RequestHandler) extends HttpApp
     } ~
     path("events") {
       streamEvents()
+    } ~
+    path("configuration") {
+      configurationInfo()
     }
 
 
@@ -412,6 +416,23 @@ class Server(handler: RequestHandler) extends HttpApp
     }
   }
 
+  /**
+    * Returns general configuration information containing the docker uri and the traefik host
+    *
+    * @return ConfigurationInfo object
+    */
+  def configurationInfo(): server.Route = {
+    authenticateOAuth2[AccessToken]("Secure Site", AuthProvider.authenticateOAuthRequire(_, userType = UserType.Admin)) { token =>
+      get {
+        log.debug(s"GET /configuration has been called")
+
+        complete {
+          handler.generateConfigurationInfo().toJson(ConfigurationInfoFormat).toString
+        }
+      }
+    }
+  }
+
   /**
     * Deploys a new container of the specified type. Also adds the resulting instance to the database. The mandatory
     * parameter 'ComponentType' is passed as a query argument. The optional parameter 'InstanceName' may also be passed as

src/main/scala/de/upb/cs/swt/delphi/instanceregistry/io/swagger/client/model/ConfigurationInfo.scala

@@ -0,0 +1,10 @@
+package de.upb.cs.swt.delphi.instanceregistry.io.swagger.client.model
+
+import akka.http.scaladsl.marshallers.sprayjson.SprayJsonSupport
+import spray.json.{DefaultJsonProtocol, JsonFormat}
+
+trait ConfigurationInfoJsonSupport extends SprayJsonSupport with DefaultJsonProtocol {
+  implicit val ConfigurationInfoFormat: JsonFormat[ConfigurationInfo] = jsonFormat2(ConfigurationInfo)
+}
+
+final case class ConfigurationInfo (DockerHttpUri: String, TraefikProxyUri: String)