How to use custom container registries with Formance Operator

If you're experiencing rate limiting issues when pulling Docker images for your Formance deployment, you can use your own container registry to host the images. This article explains how to configure the Formance Operator to use a custom registry.

Understanding the issue

By default, Formance uses the GitHub Container Registry to host its Docker images. However, some users may encounter rate limiting issues when pulling images, especially in high-traffic environments. This can result in errors such as:

Failed to pull image: Too Many Requests - Server message: toomanyrequests: You have reached your pull rate limit. You may increase the limit by authenticating.

Solution: Using a custom container registry

To resolve this issue, you can copy the Formance Docker images to your own container registry (e.g., AWS ECR) and configure the Formance Operator to use this custom registry. Here's how to do it:

1. Copy the Formance Docker images to your own container registry.

2. Configure the Formance Operator to use your custom registry.

Configuring the Formance Operator

To point the Formance Operator to your custom registry, use the following setting in your Formance stack configuration:

registries.<name>.endpoint

Replace <name> with an identifier for your registry, and set the value to the endpoint of your custom registry.

For more detailed information on configuration options, refer to the Formance Operator Configuration Reference.

Alternative solutions

If you prefer not to use a custom registry, you can also consider the following options:

• Use Kubernetes webhooks to automatically add imagePullSecrets configuration to the pods.

• Implement authentication for your existing container registry to increase pull rate limits.

These alternatives may require more advanced Kubernetes knowledge and are not directly managed by the Formance Operator.