Kubernetes

Commit-Boost can be deployed on Kubernetes using the Helm chart available in the repository's provisioning/k8s/commit-boost/ directory.

Scope limitation

warning

The current Helm chart supports only the PBS Service. It does not support the Signer Service or custom commit modules. If you need Signer or module support, please use the Docker or Binary deployment methods instead.

Prerequisites

• A Kubernetes cluster
• Helm installed (v3+)

Installation

1. Clone the repository or navigate to the chart directory:

git clone https://github.com/Commit-Boost/commit-boost-client.git
cd commit-boost-client/provisioning/k8s/commit-boost

2. Edit the values.yaml file to configure the PBS service according to your needs. The key configuration options are described in the Values table below.

3. Install the chart:

helm install commit-boost . -f values.yaml

This will deploy the Commit-Boost PBS service. By default, the PBS service is available on port 18550. Point your beacon nodes and validator clients to this port.

Values

The PBS service is configured through the values.yaml file. The chart exposes the following key configuration options under the commitBoost.pbs section:

Parameter	Type	Default	Description
commitBoost.pbs.enable	bool	true	Enable the PBS service
commitBoost.pbs.image.repository	string	ghcr.io/commit-boost/commit-boost	PBS container image repository
commitBoost.pbs.image.tag	string	v0.4.0	PBS container image tag
commitBoost.pbs.config.chain	string	Hoodi	Ethereum network (e.g. Holesky, Hoodi)
commitBoost.pbs.config.pbs.port	int	18550	PBS service port
commitBoost.pbs.config.relays	list	[]	List of relays to connect to
commitBoost.pbs.config.mux	list	[]	Multiplexer configuration for validator-specific relay routing
commitBoost.pbs.config.metrics.server_port	int	10000	Metrics server port. Note: the config key Commit-Boost actually reads is metrics.start_port, so changing server_port is currently a no-op (the port stays at the built-in default of 10000)
replicaCount	int	1	Number of PBS pod replicas
service.type	string	ClusterIP	Kubernetes service type
service.pbs_port	int	18550	Service port for PBS
resources	object	{}	Pod resource requests and limits
autoscaling.enabled	bool	false	Enable horizontal pod autoscaling

warning

The chart's default commitBoost.pbs.image.tag is v0.4.0, which is far behind the current release and predates the unified commit-boost pbs CLI the chart invokes. Always set the tag explicitly to the release you want (e.g. v0.11.0) before installing.

For the full list of available values and their descriptions, see the README.md in the chart directory.

Upgrading

To upgrade an existing release after modifying values.yaml:

helm upgrade commit-boost . -f values.yaml

Uninstalling

To uninstall the release:

helm uninstall commit-boost