From 9b8c72fadd942b2d7b0328e94dbe50632da03eb5 Mon Sep 17 00:00:00 2001 From: Enno <458526+ennru@users.noreply.github.com> Date: Mon, 30 Sep 2019 15:54:33 +0200 Subject: [PATCH] Docs: Akka Discovery links to Akka Management (#27824) --- akka-docs/src/main/paradox/discovery/index.md | 29 +++++++++++++------ project/Paradox.scala | 1 + 2 files changed, 21 insertions(+), 9 deletions(-) diff --git a/akka-docs/src/main/paradox/discovery/index.md b/akka-docs/src/main/paradox/discovery/index.md index 4e5a49f4df..df92f48f00 100644 --- a/akka-docs/src/main/paradox/discovery/index.md +++ b/akka-docs/src/main/paradox/discovery/index.md @@ -3,23 +3,34 @@ project.description: Service discovery with Akka using DNS, Kubernetes, AWS, Con --- # Discovery -Akka Discovery provides an interface around various ways of locating services. The built in methods are: +The Akka Discovery API enables **service discovery** to be provided by different technologies. +It allows to delegate endpoint lookup so that services can be configured depending on the environment by other means than configuration files. -* Configuration -* DNS -* Aggregate +Implementations provided by the Akka Discovery module are -In addition [Akka Management](https://doc.akka.io/docs/akka-management/current/) contains methods such as: +* @ref:[Configuration](#discovery-method-configuration) (HOCON) +* @ref:[DNS](#discovery-method-dns) (SRV records) +* @ref:[Aggregate](#discovery-method-aggregate-multiple-discovery-methods) multiple discovery methods -* Kubernetes API -* AWS -* Consul -* Marathon API +In addition the @extref:[Akka Management](akka-management:) toolbox contains Akka Discovery implementations for + +* @extref:[Kubernetes API](akka-management:discovery/kubernetes.html) +* @extref:[AWS API: EC2 Tag-Based Discovery](akka-management:discovery/aws.html#discovery-method-aws-api-ec2-tag-based-discovery) +* @extref:[AWS API: ECS Discovery](akka-management:discovery/aws.html#discovery-method-aws-api-ecs-discovery) +* @extref:[Consul](akka-management:discovery/consul.html) +* @extref:[Marathon API](akka-management:discovery/marathon.html) + + +@@@ note Discovery used to be part of Akka Management but has become an Akka module as of `2.5.19` of Akka and version `1.0.0` of Akka Management. If you're also using Akka Management for other service discovery methods or bootstrap make sure you are using at least version `1.0.0` of Akka Management. +See @ref:[Migration hints](#migrating-from-akka-management-discovery-before-1-0-0-) + +@@@ + ## Dependency @@dependency[sbt,Gradle,Maven] { diff --git a/project/Paradox.scala b/project/Paradox.scala index a8e5bd5cb7..34731a02de 100644 --- a/project/Paradox.scala +++ b/project/Paradox.scala @@ -18,6 +18,7 @@ object Paradox { "github.base_url" -> GitHub .url(version.value), // for links like this: @github[#1](#1) or @github[83986f9](83986f9) "extref.akka.http.base_url" -> "https://doc.akka.io/docs/akka-http/current/%s", + "extref.akka-management.base_url" -> "https://doc.akka.io/docs/akka-management/current/%s", "extref.wikipedia.base_url" -> "https://en.wikipedia.org/wiki/%s", "extref.github.base_url" -> (GitHub.url(version.value) + "/%s"), // for links to our sources "extref.samples.base_url" -> "https://developer.lightbend.com/start/?group=akka&project=%s",