envoy-ratelimit-fips

packaged by Chainguard

Chainguard Container for envoy-ratelimit-fips

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/envoy-ratelimit-fips: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 envoy-ratelimit-fips image is the FIPS-enabled variant of the envoy-ratelimit image, a Go/gRPC service that enables generic global rate limiting. Its entrypoint is /usr/bin/ratelimit, and it requires a Redis instance as its caching layer. For general usage instructions, see the non-FIPS envoy-ratelimit image README.

This image is version-streamed by Envoy Gateway release (1.5, 1.6, 1.7, 1.8, ...), and each stream is published with several tags:

• Version-stream tags — e.g. 1, 1.5, 1.6, 1.7, 1.8 and their fully-qualified forms 1.8.2, 1.8.2-r3: these all follow the Envoy Gateway release version. The shorter aliases (1, 1.8) always resolve to the newest build within that stream, while the fully-qualified tags pin a specific ratelimit package version and Chainguard build revision (-r<N>). latest points to the newest stream.
• Commit-SHA tags — e.g. fe26676d, 3fb70258, a90e0e5d: the upstream envoyproxy/ratelimit git commit the image is built from. Upstream tags its ratelimit images by commit rather than by a semantic release version, so these images mirror that commit tag. The commit is the same upstream ratelimit commit as the matching non-FIPS stream.

Because a single ratelimit commit can back more than one Envoy Gateway stream (for example, Envoy Gateway 1.6 and 1.7 both ship ratelimit commit 3fb70258), the commit-SHA tag is published exactly once — on the newest stream that carries it — to avoid a tag collision within the repository. As a result, an older stream that shares its commit with a newer stream will not carry the commit-SHA tag itself (so 1.6 above has no commit tag).

To find which ratelimit commit (and Envoy Proxy version) a given Envoy Gateway release ships, refer to the upstream Envoy Gateway Compatibility Matrix, which maps each Envoy Gateway release to its bundled Envoy Proxy, Rate Limit commit, Gateway API, and Kubernetes versions.

FIPS Support

The envoy-ratelimit-fips Chainguard Container ships with a validated redistribution of OpenSSL's FIPS provider module and includes openssl-config-fipshardened, which configures OpenSSL to run in FIPS mode so that all cryptographic operations use only FIPS-approved algorithms. For more on FIPS support in Chainguard Containers, consult the guide on FIPS-enabled Chainguard Containers on Chainguard Academy.

Getting Started

The recommended way to run ratelimit is as part of Envoy Gateway, which deploys and configures it automatically when you define a global rate limit. See the Envoy Gateway Global Rate Limit task for a full walkthrough.

To pull a specific stream, use one of the tags described above:

docker pull cgr.dev/ORGANIZATION/envoy-ratelimit-fips:1.8

To run the service standalone, point it at a Redis instance and provide a runtime configuration directory:

docker run -d --name ratelimit \
  -e USE_STATSD=false \
  -e LOG_LEVEL=debug \
  -e REDIS_SOCKET_TYPE=tcp \
  -e REDIS_URL=redis:6379 \
  -e RUNTIME_ROOT=/data \
  -e RUNTIME_SUBDIRECTORY=ratelimit \
  -v "$(pwd)/config:/data/ratelimit/config" \
  cgr.dev/ORGANIZATION/envoy-ratelimit-fips:latest

Documentation and Resources

• envoyproxy/ratelimit GitHub repository
• envoyproxy/ratelimit examples
• Envoy Gateway Global Rate Limit task
• Envoy Gateway Compatibility Matrix
• FIPS-enabled Chainguard Containers
• Envoy global rate limiting
• Envoy local rate limiting

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.