specify contact-point-discovery.port-name

Fixes #177

This specifies the management endpoint name explicity to `-Dakka.management.cluster.bootstrap.contact-point-discovery.port-name`.
By default the management endpoint name will fallback to `"akka-mgmt-http"` for backward compatibility.

In the future, sbt-reactive-app can declare the management endpoint name using "management-endpoint" as a label on the Docker image. See lightbend/sbt-reactive-app#164.

These changes combined together provides softlanding of the switch to `"management"` in akka/akka-management#274.

Author: eed3si9n

cli/shared/src/main/scala/com/lightbend/rp/reactivecli/annotations/Annotations.scala

@@ -36,6 +36,8 @@ case class Annotations(
   memory: Option[Long],
   cpu: Option[Double],
   endpoints: Map[String, Endpoint],
+  remotingEndpointName: Option[String],
+  managementEndpointName: Option[String],
   secrets: Seq[Secret],
   annotations: Seq[Annotation] = Seq.empty,
   privileged: Boolean,
@@ -116,6 +118,8 @@ object Annotations extends LazyLogging {
       memory = args.memory.orElse(memory(labels)),
       cpu = args.cpu.orElse(cpu(labels)),
       endpoints = endpoints(selectArrayWithIndex(labels, ns("endpoints")), applicationVersion),
+      remotingEndpointName = remotingEndpointName(labels),
+      managementEndpointName = managementEndpointName(labels),
       secrets = secrets(selectArray(labels, ns("secrets"))),
       annotations = annotations(selectArray(labels, ns("annotations"))),
       privileged = privileged(labels),
@@ -211,6 +215,14 @@ object Annotations extends LazyLogging {
       value <- annotation.get("value")
     } yield Annotation(key, value)
 
+  private[annotations] def remotingEndpointName(labels: Map[String, String]): Option[String] =
+    labels
+      .get(ns("remoting-endpoint"))
+
+  private[annotations] def managementEndpointName(labels: Map[String, String]): Option[String] =
+    labels
+      .get(ns("management-endpoint"))
+
   private[annotations] def endpoints(endpoints: Seq[(Int, Map[String, String])], version: Option[String]): Map[String, Endpoint] =
     endpoints.flatMap(v => endpoint(v._2, v._1, version)).toMap
 

cli/shared/src/main/scala/com/lightbend/rp/reactivecli/annotations/package.scala

@@ -17,5 +17,5 @@
 package com.lightbend.rp.reactivecli
 
 package object annotations {
-  val AkkaManagementPortName = "akka-mgmt-http"
+  val legacyAkkaManagementPortName = "akka-mgmt-http"
 }

cli/shared/src/main/scala/com/lightbend/rp/reactivecli/runtime/kubernetes/PodTemplate.scala

@@ -58,7 +58,14 @@ object PodTemplate {
         appTypeEnvs(annotations.appType, annotations.modules),
         configEnvs(annotations.configResource),
         endpointEnvs(annotations.endpoints),
-        akkaClusterEnvs(annotations.modules, annotations.namespace, serviceResourceName, noOfReplicas, annotations.akkaClusterBootstrapSystemName, akkaClusterJoinExisting),
+        akkaClusterEnvs(
+          annotations.modules,
+          annotations.namespace,
+          serviceResourceName,
+          annotations.managementEndpointName.getOrElse(legacyAkkaManagementPortName),
+          noOfReplicas,
+          annotations.akkaClusterBootstrapSystemName,
+          akkaClusterJoinExisting),
         externalServicesEnvs(annotations.modules, externalServices))
 
     private[kubernetes] def appNameEnvs(appName: Option[String]): Map[String, EnvironmentVariable] =
@@ -71,14 +78,22 @@ object PodTemplate {
           if (modules.isEmpty) Seq.empty else Seq("RP_MODULES" -> LiteralEnvironmentVariable(modules.toVector.sorted.mkString(","))))
     }.toMap
 
-    private[kubernetes] def akkaClusterEnvs(modules: Set[String], namespace: Option[String], serviceResourceName: String, noOfReplicas: Int, akkaClusterBootstrapSystemName: Option[String], akkaClusterJoinExisting: Boolean): Map[String, EnvironmentVariable] =
+    private[kubernetes] def akkaClusterEnvs(
+      modules: Set[String],
+      namespace: Option[String],
+      serviceResourceName: String,
+      managementEndpointName: String,
+      noOfReplicas: Int,
+      akkaClusterBootstrapSystemName: Option[String],
+      akkaClusterJoinExisting: Boolean): Map[String, EnvironmentVariable] =
       if (!modules.contains(Module.AkkaClusterBootstrapping))
         Map.empty
       else
         Map(
           "RP_JAVA_OPTS" -> LiteralEnvironmentVariable(
             Seq(
               s"-Dakka.management.cluster.bootstrap.contact-point-discovery.discovery-method=kubernetes-api",
+              s"-Dakka.management.cluster.bootstrap.contact-point-discovery.port-name=$managementEndpointName",
               s"-Dakka.management.cluster.bootstrap.contact-point-discovery.effective-name=$serviceResourceName",
               s"-Dakka.management.cluster.bootstrap.contact-point-discovery.required-contact-point-nr=$noOfReplicas",
               akkaClusterBootstrapSystemName.fold("-Dakka.discovery.kubernetes-api.pod-label-selector=appName=%s")(systemName => s"-Dakka.discovery.kubernetes-api.pod-label-selector=actorSystemName=$systemName"),
@@ -316,13 +331,18 @@ object PodTemplate {
     val enableChecks =
       annotations.modules.contains(Module.Status) && annotations.modules.contains(Module.AkkaManagement)
 
+    lazy val managementPortName =
+      annotations
+        .managementEndpointName
+        .getOrElse(legacyAkkaManagementPortName)
+
     val livenessProbe =
       if (enableChecks)
         Json("livenessProbe" ->
           Json(
             "httpGet" -> Json(
               "path" -> jString(HealthCheckUrl),
-              "port" -> jString(AkkaManagementPortName)),
+              "port" -> jString(managementPortName)),
             "periodSeconds" -> jNumber(StatusPeriodSeconds),
             "initialDelaySeconds" -> jNumber(LivenessInitialDelaySeconds)))
       else
@@ -334,7 +354,7 @@ object PodTemplate {
           Json(
             "httpGet" -> Json(
               "path" -> jString(ReadyCheckUrl),
-              "port" -> jString(AkkaManagementPortName)),
+              "port" -> jString(managementPortName)),
             "periodSeconds" -> jNumber(StatusPeriodSeconds)))
       else
         jEmptyObject

cli/shared/src/main/scala/com/lightbend/rp/reactivecli/runtime/marathon/RpEnvironmentVariables.scala

@@ -38,7 +38,7 @@ object RpEnvironmentVariables {
       appTypeEnvs(annotations.appType, annotations.modules),
       configEnvs(annotations.configResource),
       endpointEnvs(annotations.endpoints),
-      akkaClusterEnvs(annotations.modules, annotations.namespace, serviceResourceName, noOfReplicas, annotations.akkaClusterBootstrapSystemName, akkaClusterJoinExisting),
+      akkaClusterEnvs(annotations.modules, annotations.namespace, serviceResourceName, annotations.managementEndpointName.getOrElse(legacyAkkaManagementPortName), noOfReplicas, annotations.akkaClusterBootstrapSystemName, akkaClusterJoinExisting),
       externalServicesEnvs(annotations.modules, externalServices))
 
   private def appNameEnvs(appName: Option[String]): Map[String, String] =
@@ -51,13 +51,21 @@ object RpEnvironmentVariables {
         if (modules.isEmpty) Seq.empty else Seq("RP_MODULES" -> modules.toVector.sorted.mkString(",")))
   }.toMap
 
-  private def akkaClusterEnvs(modules: Set[String], namespace: Option[String], serviceResourceName: String, noOfReplicas: Int, akkaClusterBootstrapSystemName: Option[String], akkaClusterJoinExisting: Boolean): Map[String, String] =
+  private def akkaClusterEnvs(
+    modules: Set[String],
+    namespace: Option[String],
+    serviceResourceName: String,
+    managementEndpointName: String,
+    noOfReplicas: Int,
+    akkaClusterBootstrapSystemName: Option[String],
+    akkaClusterJoinExisting: Boolean): Map[String, String] =
     if (!modules.contains(Module.AkkaClusterBootstrapping))
       Map.empty
     else
       Map(
         "RP_JAVA_OPTS" -> Seq(
           s"-Dakka.management.cluster.bootstrap.contact-point-discovery.discovery-method=marathon-api",
+          s"-Dakka.management.cluster.bootstrap.contact-point-discovery.port-name=$managementEndpointName",
           s"-Dakka.management.cluster.bootstrap.contact-point-discovery.effective-name=$serviceResourceName",
           s"-Dakka.management.cluster.bootstrap.contact-point-discovery.required-contact-point-nr=$noOfReplicas",
           akkaClusterBootstrapSystemName.fold("-Dakka.discovery.marathon-api.app-label-query=APP_NAME==%s")(systemName => s"-Dakka.discovery.marathon-api.app-label-query=ACTOR_SYSTEM_NAME==$systemName"),

cli/shared/src/main/scala/com/lightbend/rp/reactivecli/runtime/marathon/package.scala

@@ -134,12 +134,17 @@ package object marathon {
                   val enableChecks =
                     annotations.modules.contains(Module.Status) && annotations.modules.contains(Module.AkkaManagement)
 
+                  val managementPortName =
+                    annotations
+                      .managementEndpointName
+                      .getOrElse(legacyAkkaManagementPortName)
+
                   val checkPortName =
-                    portName(AkkaManagementPortName)
+                    portName(managementPortName)
 
                   val checkPortIndex =
                     sortedEndpoints
-                      .find(_.name == AkkaManagementPortName)
+                      .find(_.name == managementPortName)
                       .map(_.index)
                       .getOrElse(0)
 

cli/shared/src/test/scala/com/lightbend/rp/reactivecli/annotations/AnnotationsTest.scala

@@ -120,6 +120,8 @@ object AnnotationsTest extends TestSuite {
           memory = None,
           cpu = None,
           endpoints = Map.empty,
+          remotingEndpointName = None,
+          managementEndpointName = None,
           secrets = Seq.empty,
           privileged = false,
           environmentVariables = Map.empty,
@@ -176,6 +178,8 @@ object AnnotationsTest extends TestSuite {
               "com.lightbend.rp.endpoints.2.name" -> "ep3",
               "com.lightbend.rp.endpoints.2.protocol" -> "udp",
               "com.lightbend.rp.endpoints.2.port" -> "1234",
+              "com.lightbend.rp.remoting-endpoint" -> "remoting",
+              "com.lightbend.rp.management-endpoint" -> "management",
               "com.lightbend.rp.annotations.0.key" -> "annotationKey0",
               "com.lightbend.rp.annotations.0.value" -> "annotationValue0",
               "com.lightbend.rp.annotations.1.key" -> "annotationKey1",
@@ -198,6 +202,8 @@ object AnnotationsTest extends TestSuite {
                 "ep1" -> HttpEndpoint(0, "ep1", 0, Seq(HttpIngress(Seq(80, 443), Seq("hello.com"), Seq("^/.*")))),
                 "ep2" -> TcpEndpoint(1, "ep2", 1234),
                 "ep3" -> UdpEndpoint(2, "ep3", 1234)),
+              remotingEndpointName = Some("remoting"),
+              managementEndpointName = Some("management"),
               secrets = Seq.empty,
               annotations = Vector(
                 Annotation("annotationKey0", "annotationValue0"),
@@ -240,6 +246,8 @@ object AnnotationsTest extends TestSuite {
               memory = Some(1024),
               cpu = Some(0.5),
               endpoints = Map.empty,
+              remotingEndpointName = None,
+              managementEndpointName = None,
               secrets = Seq.empty,
               privileged = false,
               environmentVariables = Map(
@@ -266,6 +274,8 @@ object AnnotationsTest extends TestSuite {
               memory = None,
               cpu = None,
               endpoints = Map.empty,
+              remotingEndpointName = None,
+              managementEndpointName = None,
               secrets = Seq.empty,
               privileged = false,
               environmentVariables = Map.empty,
@@ -288,6 +298,8 @@ object AnnotationsTest extends TestSuite {
               memory = None,
               cpu = None,
               endpoints = Map.empty,
+              remotingEndpointName = None,
+              managementEndpointName = None,
               secrets = Seq.empty,
               privileged = false,
               environmentVariables = Map.empty,
@@ -310,6 +322,8 @@ object AnnotationsTest extends TestSuite {
               memory = None,
               cpu = None,
               endpoints = Map.empty,
+              remotingEndpointName = None,
+              managementEndpointName = None,
               secrets = Seq.empty,
               privileged = false,
               environmentVariables = Map.empty,
@@ -338,6 +352,8 @@ object AnnotationsTest extends TestSuite {
               cpu = None,
               endpoints = Map(
                 "ep2" -> TcpEndpoint(1, "ep2", 1234)),
+              remotingEndpointName = None,
+              managementEndpointName = None,
               secrets = Seq.empty,
               privileged = false,
               environmentVariables = Map.empty,
@@ -364,6 +380,8 @@ object AnnotationsTest extends TestSuite {
               cpu = None,
               endpoints = Map(
                 "ep2" -> TcpEndpoint(1, "ep2", 1234)),
+              remotingEndpointName = None,
+              managementEndpointName = None,
               secrets = Seq.empty,
               privileged = false,
               environmentVariables = Map.empty,