chore: Deprecate marathon-api (#1320)

README.md

@@ -30,9 +30,9 @@ between releases. Breaking API changes may be introduced without notice as we re
 A module may be dropped in any release without prior deprecation. The Lightbend subscription does not cover support
 for the following modules.
 
-* akka-discovery-marathon-api
 * akka-discovery-aws-api
 * akka-discovery-aws-api-async
+* akka-discovery-marathon-api (End of Life)
 
 License
 -------

discovery-marathon-api/src/main/resources/reference.conf

@@ -6,6 +6,7 @@ akka.discovery {
   # Set the following in your application.conf if you want to use this discovery mechanism:
   # method = marathon-api
   # ApiMayChange
+  # Deprecated: Use another discovery method instead. Since 1.6.0.
   marathon-api {
     class = akka.discovery.marathon.MarathonApiServiceDiscovery
 

discovery-marathon-api/src/main/scala/akka/discovery/marathon/AppList.scala

@@ -6,6 +6,7 @@ package akka.discovery.marathon
 
 import scala.collection.immutable.Seq
 
+@deprecated("Use another discovery method instead.", "1.6.0")
 object AppList {
   case class App(container: Option[Container], portDefinitions: Option[Seq[PortDefinition]], tasks: Option[Seq[Task]])
   case class Container(portMappings: Option[Seq[PortMapping]], docker: Option[Docker])
@@ -17,4 +18,5 @@ object AppList {
 
 import AppList._
 
+@deprecated("Use another discovery method instead.", "1.6.0")
 case class AppList(apps: Seq[App])

discovery-marathon-api/src/main/scala/akka/discovery/marathon/JsonFormat.scala

@@ -8,6 +8,7 @@ import akka.http.scaladsl.marshallers.sprayjson.SprayJsonSupport
 import spray.json._
 import AppList._
 
+@deprecated("Use another discovery method instead.", "1.6.0")
 object JsonFormat extends SprayJsonSupport with DefaultJsonProtocol {
   implicit val taskFormat: JsonFormat[Task] = jsonFormat2(Task.apply)
   implicit val portDefinitionFormat: JsonFormat[PortDefinition] = jsonFormat2(PortDefinition.apply)

discovery-marathon-api/src/main/scala/akka/discovery/marathon/MarathonApiServiceDiscovery.scala

@@ -23,6 +23,7 @@ import akka.discovery.ServiceDiscovery.{ Resolved, ResolvedTarget }
 import akka.event.Logging
 
 @ApiMayChange
+@deprecated("Use another discovery method instead.", "1.6.0")
 object MarathonApiServiceDiscovery {
 
   /**
@@ -74,6 +75,7 @@ object MarathonApiServiceDiscovery {
  * Service discovery that uses the Marathon API.
  */
 @ApiMayChange
+@deprecated("Use another discovery method instead.", "1.6.0")
 class MarathonApiServiceDiscovery(implicit system: ActorSystem) extends ServiceDiscovery {
   import MarathonApiServiceDiscovery._
   import system.dispatcher

discovery-marathon-api/src/main/scala/akka/discovery/marathon/Settings.scala

@@ -8,6 +8,7 @@ import akka.actor._
 import akka.annotation.ApiMayChange
 
 @ApiMayChange
+@deprecated("Use another discovery method instead.", "1.6.0")
 final class Settings(system: ExtendedActorSystem) extends Extension {
   private val marathonApi = system.settings.config.getConfig("akka.discovery.marathon-api")
 
@@ -22,6 +23,7 @@ final class Settings(system: ExtendedActorSystem) extends Extension {
 }
 
 @ApiMayChange
+@deprecated("Use another discovery method instead.", "1.6.0")
 object Settings extends ExtensionId[Settings] with ExtensionIdProvider {
   override def get(system: ActorSystem): Settings = super.get(system)
 

discovery-marathon-api/src/test/scala/akka/discovery/marathon/MarathonApiServiceDiscoverySpec.scala

@@ -12,6 +12,7 @@ import scala.io.Source
 import org.scalatest.matchers.should.Matchers
 import org.scalatest.wordspec.AnyWordSpec
 
+@deprecated("Use another discovery method instead.", "1.6.0")
 class MarathonApiServiceDiscoverySpec extends AnyWordSpec with Matchers {
   "targets" should {
     "calculate the correct list of resolved targets" in {

docs/src/main/paradox/bootstrap/index.md

@@ -186,7 +186,7 @@ that your deployment is robust.
 
 Since the target environments for this module are dynamic, that is, instances can come and go, failure needs to be
 considered. The following configuration will result in your application being shut down after 30 seconds if it is unable to
-join the discovered seed nodes. In this case, the orchestrator (i.e. Kubernetes or Marathon) will restart your node
+join the discovered seed nodes. In this case, the orchestrator (i.e. Kubernetes) will restart your node
 and the operation will (presumably) eventually succeed. You'll want to specify the following in your `application.conf` file:
 
 @@snip [CompileOnly.scala](/integration-test/local/src/main/resources/application.conf) { #coorindated-shutdown }

docs/src/main/paradox/discovery/index.md

@@ -7,7 +7,6 @@ Akka Discovery module in Akka.
 Akka Management contains methods for:
 
  * @ref[Kubernetes](kubernetes.md)
- * @ref[Marathon](marathon.md)
  * @ref[AWS](aws.md)
  * @ref[Azure](azure.md)
 
@@ -18,7 +17,6 @@ part of the build and release process.
 @@@ index
 
   - [Kubernetes](kubernetes.md)
-  - [Marathon](marathon.md)
   - [AWS](aws.md)
   - [Azure](azure.md)
   - [Consul (discontinued)](consul.md)

docs/src/main/paradox/index.md

@@ -16,7 +16,6 @@ Akka Management consists of multiple modules:
  As well as @extref:[Akka Discovery](akka:discovery/index.html) methods for:
 
  * @ref[Kubernetes API](discovery/kubernetes.md)
- * @ref[Marathon API](discovery/marathon.md)
  * @ref[AWS](discovery/aws.md)
  * @ref[Azure](discovery/azure.md)