kko.pekko-management_2.12.1.1.0.source-code.reference.conf Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of pekko-management_2.12 Show documentation
Apache Pekko Management is a suite of tools for operating Apache Pekko Clusters.
The newest version!
# SPDX-License-Identifier: Apache-2.0

##############################################################
# Apache Pekko Http Cluster Management Reference Config File #
##############################################################

# This is the reference config file that contains all the default settings.
# Make your edits/overrides in your application.conf.

pekko.management {
  http {
    # The hostname where the HTTP Server for Http Cluster Management will be started.
    # This defines the interface to use.
    # InetAddress.getLocalHost.getHostAddress is used not overridden or empty
    hostname = ""

    # The port where the HTTP Server for Http Cluster Management will be bound.
    # The value will need to be from 0 to 65535.
    port = 7626 # PMAN (Pekko MANagement) on a telephone keypad (ITU E.161)

    # Use this setting to bind a network interface to a different hostname or ip
    # than the HTTP Server for Http Cluster Management.
    # Use "0.0.0.0" to bind to all interfaces.
    # pekko.management.http.hostname if empty
    bind-hostname = ""

    # Use this setting to bind a network interface to a different port
    # than the HTTP Server for Http Cluster Management. This may be used
    # when running Pekko nodes in a separated networks (under NATs or docker containers).
    # Use 0 if you want a random available port.
    #
    # pekko.management.http.port if empty
    bind-port = ""

    # path prefix for all management routes, usually best to keep the default value here. If
    # specified, you'll want to use the same value for all nodes that use Pekko management so
    # that they can know which path to access each other on.
    base-path = ""

    # Definition of management route providers which shall contribute routes to the management HTTP endpoint.
    # Management route providers should be regular extensions that additionally extend the
    # `org.apache.pekko.management.scaladsl.ManagementRoutesProvider` or
    # `org.apache.pekko.management.javadsl.ManagementRoutesProvider` interface.
    #
    # Libraries may register routes into the management routes by defining entries to this setting
    # the library `reference.conf`:
    #
    # pekko.management.http.routes {
    #   name = "FQCN"
    # }
    #
    # Where the `name` of the entry should be unique to allow different route providers to be registered
    # by different libraries and applications.
    #
    # The FQCN is the fully qualified class name of the `ManagementRoutesProvider`.
    #
    # By default the `org.apache.pekko.management.HealthCheckRoutes` is enabled, see `health-checks` section of how
    # configure specific startup, readiness and liveness checks.
    #
    # Route providers included by a library (from reference.conf) can be excluded by an application
    # by using "" or null as the FQCN of the named entry, for example:
    #
    # pekko.management.http.routes {
    #   health-checks = ""
    # }
    routes {
      health-checks = "org.apache.pekko.management.HealthCheckRoutes"
    }

    # Should Management route providers only expose read only endpoints? It is up to each route provider
    # to adhere to this property
    route-providers-read-only = true
  }

  # Health checks for startup, readiness and liveness
  health-checks {
    # When exposing health checks via Pekko Management, the path to expose startup checks on
    startup-path = "startup"
    # When exposing health checks via Pekko Management, the path to expose readiness checks on
    readiness-path = "ready"
    # When exposing health checks via Pekko Management, the path to expose readiness checks on
    liveness-path = "alive"
    # All readiness checks are executed in parallel and given this long before the check is timed out
    check-timeout = 1s
    # Add readiness and liveness checks to the below config objects with the syntax:
    #
    # name = "FQCN"
    #
    # For example:
    #
    # cluster-membership = "org.apache.pekko.management.cluster.scaladsl.ClusterMembershipCheck"
    #
    # Libraries and frameworks that contribute checks are expected to add their own checks to their reference.conf.
    # Applications can add their own checks to application.conf.
    startup-checks {

    }
    readiness-checks {

    }
    liveness-checks {

    }
  }

}