Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: add repository info #1177

Merged
merged 1 commit into from
Jul 28, 2023
Merged

docs: add repository info #1177

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions docs/src/main/paradox/akka-management.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,16 @@ and you have to combine it with the management extension libraries that you want
or cluster bootstrap). This design choice enables users to include only the minimal set of features they
actually want to use (and load) in their project.

The Akka dependencies are available from Akka's library repository. To access them there, you need to configure the URL for this repository.

@@repository [sbt,Gradle,Maven] {
id="akka-repository"
name="Akka library repository"
url="https://repo.akka.io/maven"
}

Additionally, add the dependency as below.

@@dependency[sbt,Gradle,Maven] {
symbol1=AkkaManagementVersion
value1="$project.version$"
Expand Down
12 changes: 11 additions & 1 deletion docs/src/main/paradox/bootstrap/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,17 @@ A discovery mechanism needs to be chosen. A good default choice is DNS.
Add `akka-management-cluster-bootstrap` and one or more discovery mechanisms to use for the discovery process.

For example, you might choose to use the @extref:[DNS discovery](akka:discovery/index.html#discovery-method-dns)
and bootstrap extensions:
and bootstrap extensions.

The Akka dependencies are available from Akka's library repository. To access them there, you need to configure the URL for this repository.

@@repository [sbt,Gradle,Maven] {
id="akka-repository"
name="Akka library repository"
url="https://repo.akka.io/maven"
}

Additionally, add the dependencies as below.

@@dependency[sbt,Gradle,Maven] {
symbol=AkkaVersion
Expand Down
13 changes: 11 additions & 2 deletions docs/src/main/paradox/bootstrap/recipes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,8 +58,17 @@ Note that the `app` is the same for both services as they both refer to the same
### Health checks

`akka-management` includes a HTTP route for readiness and liveness checks.
`akka-management-cluster-http` includes readiness check for the Akka Cluster membership. To use it
add the following dependency:
`akka-management-cluster-http` includes readiness check for the Akka Cluster membership.

The Akka dependencies are available from Akka's library repository. To access them there, you need to configure the URL for this repository.

@@repository [sbt,Gradle,Maven] {
id="akka-repository"
name="Akka library repository"
url="https://repo.akka.io/maven"
}

Additionally, add the dependency as below.

@@dependency[sbt,Gradle,Maven] {
symbol1=AkkaManagementVersion
Expand Down
12 changes: 11 additions & 1 deletion docs/src/main/paradox/cluster-http-management.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,17 @@ The operations exposed are comparable to the Command Line Management tool or the
## Dependencies

The Akka Cluster HTTP Management is a separate jar file.
Make sure to include it along with the core akka-management library in your project:
Make sure to include it along with the core akka-management library in your project.

The Akka dependencies are available from Akka's library repository. To access them there, you need to configure the URL for this repository.

@@repository [sbt,Gradle,Maven] {
id="akka-repository"
name="Akka library repository"
url="https://repo.akka.io/maven"
}

Additionally, add the dependencies as below.

@@dependency[sbt,Gradle,Maven] {
symbol1=AkkaManagementVersion
Expand Down
10 changes: 9 additions & 1 deletion docs/src/main/paradox/discovery/aws.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,15 @@ ensure the "Tag New Instances" option is checked.

#### Dependencies and usage (EC2 Tag-Based Discovery)

This is a separate JAR file:
The Akka dependencies are available from Akka's library repository. To access them there, you need to configure the URL for this repository.

@@repository [sbt,Gradle,Maven] {
id="akka-repository"
name="Akka library repository"
url="https://repo.akka.io/maven"
}

Additionally, add the dependency as below.

@@dependency[sbt,Gradle,Maven] {
symbol1=AkkaManagementVersion
Expand Down
10 changes: 10 additions & 0 deletions docs/src/main/paradox/discovery/consul.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,16 @@ If you are using Consul to do the service discovery this would allow you to base

@@project-info{ projectId="akka-discovery-consul" }

The Akka dependencies are available from Akka's library repository. To access them there, you need to configure the URL for this repository.

@@repository [sbt,Gradle,Maven] {
id="akka-repository"
name="Akka library repository"
url="https://repo.akka.io/maven"
}

Additionally, add the dependency as below.

@@dependency[sbt,Gradle,Maven] {
symbol1=AkkaManagementVersion
value1=$project.version$
Expand Down
10 changes: 9 additions & 1 deletion docs/src/main/paradox/discovery/kubernetes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,15 @@ The typical way to consume a service in Kubernetes is to discover it through DNS

### Dependencies and usage

First, add the dependency on the component:
The Akka dependencies are available from Akka's library repository. To access them there, you need to configure the URL for this repository.

@@repository [sbt,Gradle,Maven] {
id="akka-repository"
name="Akka library repository"
url="https://repo.akka.io/maven"
}

Additionally, add the dependency as below.

@@dependency[sbt,Gradle,Maven] {
symbol1=AkkaManagementVersion
Expand Down
10 changes: 9 additions & 1 deletion docs/src/main/paradox/discovery/marathon.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,15 @@ is bound to this port.

### Dependencies and usage

This is a separate JAR file:
The Akka dependencies are available from Akka's library repository. To access them there, you need to configure the URL for this repository.

@@repository [sbt,Gradle,Maven] {
id="akka-repository"
name="Akka library repository"
url="https://repo.akka.io/maven"
}

Additionally, add the dependency as below.

@@dependency[sbt,Gradle,Maven] {
symbol1=AkkaManagementVersion
Expand Down
10 changes: 10 additions & 0 deletions docs/src/main/paradox/kubernetes-deployment/forming-a-cluster.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,16 @@ Add the following dependencies to your application:
* @ref[Akka Discovery Kubernetes](../discovery/kubernetes.md): This provides a discovery mechanism that queries the Kubernetes API
* @ref[Akka Bootstrap](../bootstrap/index.md): This bootstraps the cluster from nodes discovered via the Kubernetes API

The Akka dependencies are available from Akka's library repository. To access them there, you need to configure the URL for this repository.

@@repository [sbt,Gradle,Maven] {
id="akka-repository"
name="Akka library repository"
url="https://repo.akka.io/maven"


Additionally, add the dependencies as below.

@@dependency[sbt,Gradle,Maven] {
symbol1=AkkaManagementVersion
value1=$project.version$
Expand Down
10 changes: 10 additions & 0 deletions docs/src/main/paradox/kubernetes-lease.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,16 @@ applications, you must ensure different `ActorSystem` names because they all nee

#### Dependency

The Akka dependencies are available from Akka's library repository. To access them there, you need to configure the URL for this repository.

@@repository [sbt,Gradle,Maven] {
id="akka-repository"
name="Akka library repository"
url="https://repo.akka.io/maven"
}

Additionally, add the dependency as below.

@@dependency[sbt,Maven,Gradle] {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And again a different order :)

symbol1=AkkaManagementVersion
value1=$project.version$
Expand Down
10 changes: 10 additions & 0 deletions docs/src/main/paradox/loglevels/log4j2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,16 @@ Dynamic Log Levels for Log4j2 hooks into Akka Management and provides a route wh

Requires @ref:[Akka Management](../akka-management.md) and that the application uses [Log4j2](https://logging.apache.org/log4j/2.x/) as logging backend.

The Akka dependencies are available from Akka's library repository. To access them there, you need to configure the URL for this repository.

@@repository [sbt,Gradle,Maven] {
id="akka-repository"
name="Akka library repository"
url="https://repo.akka.io/maven"
}

Additionally, add the dependencies as below.

@@dependency[sbt,Gradle,Maven] {
symbol1=AkkaManagementVersion
value1=$project.version$
Expand Down
10 changes: 10 additions & 0 deletions docs/src/main/paradox/loglevels/logback.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,16 @@ Dynamic Log Levels for Logback hooks into Akka Management and provides a route w

Requires @ref:[Akka Management](../akka-management.md) and that the application uses [Logback](http://logback.qos.ch) as logging backend.

The Akka dependencies are available from Akka's library repository. To access them there, you need to configure the URL for this repository.

@@repository [sbt,Gradle,Maven] {
id="akka-repository"
name="Akka library repository"
url="https://repo.akka.io/maven"
}

Additionally, add the dependencies as below.

@@dependency[sbt,Gradle,Maven] {
symbol1=AkkaManagementVersion
value1=$project.version$
Expand Down
8 changes: 8 additions & 0 deletions docs/src/main/paradox/rolling-updates.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,14 @@ This module provides the Pod Deletion Cost extension which automatically annotat

### Dependency

The Akka dependencies are available from Akka's library repository. To access them there, you need to configure the URL for this repository.

@@repository [sbt,Gradle,Maven] {
id="akka-repository"
name="Akka library repository"
url="https://repo.akka.io/maven"
}

Add `akka-rolling-update-kubernetes` to your dependency management tool:

@@dependency[sbt,Gradle,Maven] {
Expand Down
2 changes: 1 addition & 1 deletion project/plugins.sbt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ addSbtPlugin("com.github.sbt" % "sbt-native-packager" % "1.9.16")
addSbtPlugin("de.heikoseeberger" % "sbt-header" % "5.10.0")
addSbtPlugin("org.scalameta" % "sbt-scalafmt" % "2.4.3")
addSbtPlugin("com.github.sbt" % "sbt-dynver" % "5.0.1")
addSbtPlugin("com.lightbend.akka" % "sbt-paradox-akka" % "0.49")
addSbtPlugin("com.lightbend.akka" % "sbt-paradox-akka" % "0.51")
addSbtPlugin("com.github.sbt" % "sbt-unidoc" % "0.5.0")
addSbtPlugin("com.github.sbt" % "sbt-site-paradox" % "1.5.0")
addSbtPlugin("com.lightbend.sbt" % "sbt-publish-rsync" % "0.2")
Expand Down
Loading