Skip to content

docs: link published management docs #2955

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

Draft
He-Pin wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

docs: link published management docs #2955

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
9 changes: 4 additions & 5 deletions docs/src/main/paradox/additional/deploying.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,19 @@ project.description: How to deploy an Apache Pekko Cluster to Kubernetes and Doc

## Deploying to Kubernetes

Deploy to Kubernetes according to the guide and example project for [Deploying a Pekko Cluster to Kubernetes]($pekko.doc.dns$/docs/pekko-management/current/kubernetes-deployment/index.html), but that requires more expertise of Kubernetes.
Deploy to Kubernetes according to the guide and example project for @extref:[Deploying a Pekko Cluster to Kubernetes](pekko-management:kubernetes-deployment/index.html), but that requires more expertise of Kubernetes.

### Cluster bootstrap

To take advantage of running inside Kubernetes while forming a cluster,
[Pekko Cluster Bootstrap]($pekko.doc.dns$/docs/pekko-management/current/bootstrap/) helps forming or joining a cluster using Pekko Discovery with
To take advantage of running inside Kubernetes while forming a cluster,
@extref:[Pekko Cluster Bootstrap](pekko-management:bootstrap/) helps forming or joining a cluster using Pekko Discovery with
the Kubernetes API or Kubernetes via DNS to discover peer nodes.

You can look at the
@java[[Cluster with Kubernetes example project](https://github.com/apache/pekko-samples/tree/main/pekko-sample-cluster-kubernetes-java)]
@scala[[Cluster with Kubernetes example project](https://github.com/apache/pekko-samples/tree/main/pekko-sample-cluster-kubernetes-scala)]
to see what this looks like in practice.

### Resource limits

To avoid CFS scheduler limits, it is best not to use `resources.limits.cpu` limits, but use `resources.requests.cpu` configuration instead.
Expand Down Expand Up @@ -50,4 +50,3 @@ the allowed CPU usage even when more CPU cycles are available from the host syst
starved of CPU time, but your system appears idle.

For this reason, it is best to avoid `--cpus` and `--cpu-quota` entirely, and instead specify relative container weights using `--cpu-shares` instead.

2 changes: 1 addition & 1 deletion 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 @@ -79,7 +79,7 @@ Otherwise, in the worst case cluster singletons may be migrated from node to nod
overhead several times.

[Kubernetes Deployments](https://kubernetes.io/docs/concepts/workloads/controllers/deployment/) with `RollingUpdate`
strategy will roll out updates in this preferred order, from newest to oldest.
strategy will roll out updates in this preferred order, from newest to oldest.

## Cluster Shutdown

Expand Down
11 changes: 5 additions & 6 deletions docs/src/main/paradox/common/other-modules.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,9 +40,8 @@ A Pekko Persistence journal and snapshot store for use with R2DBC-compatible dat

## Apache Pekko Management

* [Pekko Management]($pekko.doc.dns$/docs/pekko-management/current/) provides a central HTTP endpoint for Pekko management extensions.
* [Pekko Cluster Bootstrap]($pekko.doc.dns$/docs/pekko-management/current/bootstrap/) helps bootstrapping a Pekko cluster using Pekko Discovery.
* [Pekko Management Cluster HTTP]($pekko.doc.dns$/docs/pekko-management/current/cluster-http-management.html) provides HTTP endpoints for introspecting and managing Pekko clusters.
* [Pekko Discovery for Kubernetes, Consul, Marathon, and AWS]($pekko.doc.dns$/docs/pekko-management/current/discovery/)
* [Kubernetes Lease]($pekko.doc.dns$/docs/pekko-management/current/kubernetes-lease.html)

* @extref:[Pekko Management](pekko-management:) provides a central HTTP endpoint for Pekko management extensions.
* @extref:[Pekko Cluster Bootstrap](pekko-management:bootstrap/) helps bootstrapping a Pekko cluster using Pekko Discovery.
* @extref:[Pekko Management Cluster HTTP](pekko-management:cluster-http-management.html) provides HTTP endpoints for introspecting and managing Pekko clusters.
* @extref:[Pekko Discovery for Kubernetes, Consul, Marathon, and AWS](pekko-management:discovery/)
* @extref:[Kubernetes Lease](pekko-management:kubernetes-lease.html)
2 changes: 1 addition & 1 deletion docs/src/main/paradox/coordination.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ Leases can be used for @ref[Split Brain Resolver](split-brain-resolver.md#lease)

## Lease implementations

* [Kubernetes API]($pekko.doc.dns$/docs/pekko-management/current/kubernetes-lease.html)
* @extref:[Kubernetes API](pekko-management:kubernetes-lease.html)

## Implementing a lease

Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/paradox/project/downstream-upgrade-strategy.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ project.description: Upgrade strategy for downstream libraries
# Downstream upgrade strategy

When a new Pekko version is released, downstream projects (such as
[Pekko Management]($pekko.doc.dns$/docs/pekko-management/current/),
@extref:[Pekko Management](pekko-management:),
[Pekko HTTP]($pekko.doc.dns$/docs/pekko-http/current/) and
[Pekko gRPC]($pekko.doc.dns$/docs/pekko-grpc/current/))
do not need to update immediately: because of our
Expand Down
4 changes: 2 additions & 2 deletions docs/src/main/paradox/split-brain-resolver.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -345,7 +345,7 @@ before trying to acquire the lease on the minority side.

There is currently one supported implementation of the lease which is backed by a
[Custom Resource Definition (CRD)](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/)
in Kubernetes. It is described in the [Kubernetes Lease]($pekko.doc.dns$/docs/pekko-management/current/kubernetes-lease.html)
in Kubernetes. It is described in the @extref:[Kubernetes Lease](pekko-management:kubernetes-lease.html)
documentation.

This strategy is very safe since coordination is added by an external arbiter. The trade-off compared to other
Expand Down Expand Up @@ -376,7 +376,7 @@ pekko {

@@snip [reference.conf](/cluster/src/main/resources/reference.conf) { #lease-majority }

See also configuration and additional dependency in [Kubernetes Lease]($pekko.doc.dns$/docs/pekko-management/current/kubernetes-lease.html)
See also configuration and additional dependency in @extref:[Kubernetes Lease](pekko-management:kubernetes-lease.html)

## Indirectly connected nodes

Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/paradox/typed/cluster-membership.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,7 @@ startup if a node to join have been specified in the configuration

* **leave** - tell a node to leave the cluster gracefully, normally triggered by ActorSystem or JVM shutdown through @ref[coordinated shutdown](../coordinated-shutdown.md)

* **down** - mark a node as down. This action is required to remove crashed nodes (that did not 'leave') from the cluster. It can be triggered manually, through [Cluster HTTP Management]($pekko.doc.dns$/docs/pekko-management/current/cluster-http-management.html#put-cluster-members-address-responses), or automatically by a @ref[downing provider](cluster.md#downing) like @ref:[Split Brain Resolver](../split-brain-resolver.md)
* **down** - mark a node as down. This action is required to remove crashed nodes (that did not 'leave') from the cluster. It can be triggered manually, through @extref:[Cluster HTTP Management](pekko-management:cluster-http-management.html#put-cluster-members-address-responses), or automatically by a @ref[downing provider](cluster.md#downing) like @ref:[Split Brain Resolver](../split-brain-resolver.md)

#### Leader Actions

Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/paradox/typed/cluster-sharding.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -708,7 +708,7 @@ for more information about `min-nr-of-members`.

## Health check

An [Pekko Management compatible health check]($pekko.doc.dns$/docs/pekko-management/current/healthchecks.html) is included that returns healthy once the local shard region
An @extref:[Pekko Management compatible health check](pekko-management:healthchecks.html) is included that returns healthy once the local shard region
Copy link
Copy Markdown
Member

@pjfanning pjfanning May 9, 2026

Choose a reason for hiding this comment

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

Suggested change
An @extref:[Pekko Management compatible health check](pekko-management:healthchecks.html) is included that returns healthy once the local shard region
A @extref:[Pekko Management compatible health check](pekko-management:healthchecks.html) is included that returns healthy once the local shard region

has registered with the coordinator. This health check should be used in cases where you don't want to receive production traffic until the local shard region is ready to retrieve locations
for shards. For shard regions that aren't critical and therefore should not block this node becoming ready do not include them.

Expand Down