gubernator

packaged by Chainguard

Chainguard Container for gubernator

Gubernator is a distributed, high-performance, cloud-native, and stateless rate limiting service with HTTP and gRPC APIs.

Chainguard Containers are regularly-updated, secure-by-default container images.

Download this Container Image

For those with access, this container image is available on cgr.dev:

docker pull cgr.dev/ORGANIZATION/gubernator:latest

Be sure to replace the ORGANIZATION placeholder with the name used for your organization's private repository within the Chainguard Registry.

Compatibility Notes

The Chainguard Gubernator image is a drop-in replacement for ghcr.io/gubernator-io/gubernator. It preserves the upstream /gubernator entrypoint, includes the /healthcheck helper, runs as non-root UID 1001 with primary GID 0, and uses ports 1050 (HTTP), 1051 (gRPC), and 7946 (memberlist). The image is minimal and does not include a shell or package manager.

Gubernator listens on loopback by default. Set GUBER_HTTP_ADDRESS=0.0.0.0:1050 and GUBER_GRPC_ADDRESS=0.0.0.0:1051 when clients outside the container need to connect. The /healthcheck binary is included, but the upstream Dockerfile's HEALTHCHECK metadata is not reproduced; configure a container-runtime or Kubernetes probe explicitly.

Getting Started

Docker

Create a single-node memberlist cluster and expose the HTTP and gRPC APIs:

docker network create gubernator
docker run -d \
  --name gubernator \
  --hostname gubernator \
  --network gubernator \
  -p 1050:1050 \
  -p 1051:1051 \
  -e GUBER_HTTP_ADDRESS=0.0.0.0:1050 \
  -e GUBER_GRPC_ADDRESS=0.0.0.0:1051 \
  -e GUBER_ADVERTISE_ADDRESS=gubernator:1051 \
  -e GUBER_MEMBERLIST_KNOWN_NODES=gubernator:7946 \
  cgr.dev/ORGANIZATION/gubernator:latest

Verify the bundled health check and make a rate-limit request:

docker exec gubernator /healthcheck

curl http://localhost:1050/v1/GetRateLimits \
  --header 'Content-Type: application/json' \
  --data '{
    "requests": [{
      "name": "requests_per_minute",
      "unique_key": "account:12345",
      "hits": "1",
      "limit": "10",
      "duration": "60000",
      "behavior": "NO_BATCHING"
    }]
  }'

Kubernetes with Helm

The official Gubernator Helm chart uses Kubernetes EndpointSlice discovery. Enable its service account and RBAC, and override the image with a values file:

cat > values.yaml <<'EOF'
gubernator:
  image:
    repository: cgr.dev/ORGANIZATION/gubernator
    tag: latest
  serviceAccount:
    create: true
EOF

helm install gubernator oci://ghcr.io/gubernator-io/charts/gubernator \
  --namespace gubernator \
  --create-namespace \
  --values values.yaml

Documentation and Resources

• Gubernator documentation
• Gubernator Helm chart
• Gubernator configuration reference
• Chainguard Academy

What are Chainguard Containers?

Chainguard's free tier of Starter container images are built with Wolfi, our minimal Linux undistro.

All other Chainguard Containers are built with Chainguard OS, Chainguard's minimal Linux operating system designed to produce container images that meet the requirements of a more secure software supply chain.

The main features of Chainguard Containers include:

• Minimal design, without unnecessary software bloat
• Daily builds to ensure container images are up-to-date with available security patches
• High quality build-time SBOMs attesting to the provenance of all artifacts within the image
• Verifiable signatures provided by Sigstore
• Reproducible builds with Cosign and apko (read more about reproducibility)

For cases where you need container images with shells and package managers to build or debug, most Chainguard Containers come paired with a development, or -dev, variant.

In all other cases, including Chainguard Containers tagged as :latest or with a specific version number, the container images include only an open-source application and its runtime dependencies. These minimal container images typically do not contain a shell or package manager.

Although the -dev container image variants have similar security features as their more minimal versions, they include additional software that is typically not necessary in production environments. We recommend using multi-stage builds to copy artifacts from the -dev variant into a more minimal production image.

Need additional packages?

To improve security, Chainguard Containers include only essential dependencies. Need more packages? Chainguard customers can use Custom Assembly to add packages, either through the Console, chainctl, or API.

To use Custom Assembly in the Chainguard Console: navigate to the image you'd like to customize in your Organization's list of images, and click on the Customize image button at the top of the page.

Learn More

Refer to our Chainguard Containers documentation on Chainguard Academy. Chainguard also offers VMs and Libraries — contact us for access.

Trademarks

This software listing is packaged by Chainguard. The trademarks set forth in this offering are owned by their respective companies, and use of them does not imply any affiliation, sponsorship, or endorsement by such companies.