Skip to content

docs: link to app-version from Deployment for rolling updates #3276

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

Open
He-Pin wants to merge 1 commit into
base: main
Choose a base branch
from
+5 −0
Open

docs: link to app-version from Deployment for rolling updates #3276

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
4 changes: 4 additions & 0 deletions docs/src/main/paradox/additional/rolling-updates.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,10 @@ pekko.cluster.app-version = 1.2.3
To understand which is old and new it compares the version numbers using normal conventions,
see @apidoc[util.Version] for more details.

When using [Kubernetes Deployments](https://kubernetes.io/docs/concepts/workloads/controllers/deployment/) with `RollingUpdate`
strategy you should enable the @extref:[app-version from Deployment feature from Pekko Management](pekko-management-snapshot:rolling-updates.html#app-version-from-deployment)
to automatically define the `app-version` from the Kubernetes `deployment.kubernetes.io/revision` annotation.

Rebalance is also disabled during rolling updates, since shards from stopped nodes are anyway supposed to be
started on new nodes. Messages to shards that were stopped on the old nodes will allocate corresponding shards
on the new nodes, without waiting for rebalance actions.
Expand Down
1 change: 1 addition & 0 deletions project/Paradox.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ object Paradox {
.url(version.value), // for links like this: @github[#1](#1) or @github[83986f9](83986f9)
"extref.pekko.http.base_url" -> s"$pekkoBaseURL/docs/pekko-http/current/%s",
"extref.pekko-management.base_url" -> s"$pekkoBaseURL/docs/pekko-management/current/%s",
"extref.pekko-management-snapshot.base_url" -> s"$pekkoBaseURL/docs/pekko-management/snapshot/%s",
"extref.platform-guide.base_url" -> "https://developer.lightbend.com/docs/akka-platform-guide/%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
Expand Down
Loading