Add user event dev mode

apache · Oct 10, 2019 · b2cf2ca · b2cf2ca
1 parent 15709b6
commit b2cf2ca
Show file tree

Hide file tree

Showing 3 changed files with 56 additions and 35 deletions.
diff --git a/core/standalone/README.md b/core/standalone/README.md
@@ -93,23 +93,28 @@ $ java -jar openwhisk-standalone.jar -h
   -d, --data-dir  <arg>            Directory used for storage
       --dev-kcf                    Enables KubernetesContainerFactory for local
                                    development
-      --dev-mode                   Developer mode speeds up the startup by
-                                   disabling preflight checks and avoiding
-                                   explicit pulls.
-      --disable-color-logging      Disables colored logging
-      --kafka-docker-port  <arg>   Kafka port for use by docker based services.
-                                   If not specified then 9091 or some random
-                                   free port (if 9091 is busy) would be used
-      --kafka-port  <arg>          Kafka port. If not specified then 9092 or
-                                   some random free port (if 9092 is busy) would
-                                   be used
-  -p, --port  <arg>                Server port
+      --dev-mode                      Developer mode speeds up the startup by
+                                      disabling preflight checks and avoiding
+                                      explicit pulls.
+      --dev-user-events-port  <arg>   Specify the port for the user-event
+                                      service. This mode can be used for local
+                                      development of user-event service by
+                                      configuring the Prometheus to connect to
+                                      existing running service instance
+      --disable-color-logging         Disables colored logging
+      --kafka-docker-port  <arg>      Kafka port for use by docker based
+                                      services. If not specified then 9091 or
+                                      some random free port (if 9091 is busy)
+                                      would be used
+      --kafka-port  <arg>             Kafka port. If not specified then 9092 or
+                                      some random free port (if 9092 is busy)
+                                      would be used
+  -p, --port  <arg>                   Server port
   -v, --verbose
-      --zk-port  <arg>             Zookeeper port. If not specified then 2181 or
-                                   some random free port (if 2181 is busy) would
-                                   be used
-  -h, --help                       Show help message
-      --version                    Show version of this program
+      --zk-port  <arg>                Zookeeper port. If not specified then 2181
+                                      or some random free port (if 2181 is busy)
+                                      would be used
+  -h, --help                          Show help message
 
 OpenWhisk standalone server
 ```

diff --git a/core/standalone/src/main/scala/org/apache/openwhisk/standalone/StandaloneOpenWhisk.scala b/core/standalone/src/main/scala/org/apache/openwhisk/standalone/StandaloneOpenWhisk.scala
@@ -101,6 +101,10 @@ class Conf(arguments: Seq[String]) extends ScallopConf(Conf.expandAllMode(argume
 
   val devKcf = opt[Boolean](descr = "Enables KubernetesContainerFactory for local development")
 
+  val devUserEventsPort = opt[Int](
+    descr = "Specify the port for the user-event service. This mode can be used for local " +
+      "development of user-event service by configuring the Prometheus to connect to existing running service instance")
+
   mainOptions = Seq(manifest, configFile, apiGw, couchdb, userEvents, kafka, kafkaUi)
 
   verify()
@@ -219,7 +223,8 @@ object StandaloneOpenWhisk extends SLF4JLogging {
 
     val couchSvcs = if (conf.couchdb()) Some(startCouchDb(dataDir, dockerClient)) else None
     val userEventSvcs =
-      if (conf.userEvents()) startUserEvents(conf.port(), kafkaDockerPort, workDir, dataDir, dockerClient)
+      if (conf.userEvents() || conf.devUserEventsPort.isSupplied)
+        startUserEvents(conf.port(), kafkaDockerPort, conf.devUserEventsPort.toOption, workDir, dataDir, dockerClient)
       else Seq.empty
 
     val svcs = Seq(defaultSvcs, apiGwSvcs, couchSvcs.toList, kafkaSvcs, userEventSvcs).flatten
@@ -503,6 +508,7 @@ object StandaloneOpenWhisk extends SLF4JLogging {
 
   private def startUserEvents(owPort: Int,
                               kafkaDockerPort: Int,
+                              existingUserEventSvcPort: Option[Int],
                               workDir: File,
                               dataDir: File,
                               dockerClient: StandaloneDockerClient)(
@@ -511,7 +517,7 @@ object StandaloneOpenWhisk extends SLF4JLogging {
     ec: ExecutionContext,
     materializer: ActorMaterializer): Seq[ServiceContainer] = {
     implicit val tid: TransactionId = TransactionId(systemPrefix + "userevents")
-    val k = new UserEventLauncher(dockerClient, owPort, kafkaDockerPort, workDir, dataDir)
+    val k = new UserEventLauncher(dockerClient, owPort, kafkaDockerPort, existingUserEventSvcPort, workDir, dataDir)
 
     val f = k.run()
     val g = f.andThen {

diff --git a/core/standalone/src/main/scala/org/apache/openwhisk/standalone/UserEventLauncher.scala b/core/standalone/src/main/scala/org/apache/openwhisk/standalone/UserEventLauncher.scala
@@ -29,15 +29,19 @@ import pureconfig.loadConfigOrThrow
 
 import scala.concurrent.{ExecutionContext, Future}
 
-class UserEventLauncher(docker: StandaloneDockerClient, owPort: Int, kafkaDockerPort: Int, workDir: File, dataDir: File)(
-  implicit logging: Logging,
-  ec: ExecutionContext,
-  actorSystem: ActorSystem,
-  materializer: ActorMaterializer,
-  tid: TransactionId) {
+class UserEventLauncher(docker: StandaloneDockerClient,
+                        owPort: Int,
+                        kafkaDockerPort: Int,
+                        existingUserEventSvcPort: Option[Int],
+                        workDir: File,
+                        dataDir: File)(implicit logging: Logging,
+                                       ec: ExecutionContext,
+                                       actorSystem: ActorSystem,
+                                       materializer: ActorMaterializer,
+                                       tid: TransactionId) {
 
   //owPort+1 is used by Api Gateway
-  private val userEventPort = checkOrAllocatePort(owPort + 2)
+  private val userEventPort = existingUserEventSvcPort.getOrElse(checkOrAllocatePort(owPort + 2))
   private val prometheusPort = checkOrAllocatePort(9090)
   private val grafanaPort = checkOrAllocatePort(3000)
 
@@ -60,15 +64,21 @@ class UserEventLauncher(docker: StandaloneDockerClient, owPort: Int, kafkaDocker
   }
 
   def runUserEvents(): Future[ServiceContainer] = {
-    val env = Map("KAFKA_HOSTS" -> s"$hostIp:$kafkaDockerPort")
-
-    logging.info(this, s"Starting User Events: $userEventPort")
-    val name = containerName("user-events")
-    val params = Map("-p" -> Set(s"$userEventPort:9095"))
-    val args = createRunCmd(name, env, params)
-
-    val f = docker.runDetached(userEventConfig.image, args, true)
-    f.map(_ => ServiceContainer(userEventPort, s"http://localhost:$userEventPort", name))
+    existingUserEventSvcPort match {
+      case Some(_) =>
+        logging.info(this, s"Connecting to pre existing user-event service at $userEventPort")
+        Future.successful(ServiceContainer(userEventPort, s"http://localhost:$userEventPort", "Existing user-event"))
+      case None =>
+        val env = Map("KAFKA_HOSTS" -> s"$hostIp:$kafkaDockerPort")
+
+        logging.info(this, s"Starting User Events: $userEventPort")
+        val name = containerName("user-events")
+        val params = Map("-p" -> Set(s"$userEventPort:9095"))
+        val args = createRunCmd(name, env, params)
+
+        val f = docker.runDetached(userEventConfig.image, args, true)
+        f.map(_ => ServiceContainer(userEventPort, s"http://localhost:$userEventPort", name))
+    }
   }
 
   def runPrometheus(): Future[(StandaloneDockerContainer, ServiceContainer)] = {
@@ -107,7 +117,7 @@ class UserEventLauncher(docker: StandaloneDockerClient, owPort: Int, kafkaDocker
 
     val volParams = Map(
       "-v" -> Set(
-        s"${grafanaDataDir.getAbsolutePath}:/var/lib/grafanas",
+        s"${grafanaDataDir.getAbsolutePath}:/var/lib/grafana",
         s"${grafanaConfigDir.getAbsolutePath}/provisioning/:/etc/grafana/provisioning/",
         s"${grafanaConfigDir.getAbsolutePath}/dashboards/:/var/lib/grafana/dashboards/"))
     val name = containerName("grafana")