Skip to content

Latest commit

 

History

History
53 lines (41 loc) · 1.79 KB

custom-image.md

File metadata and controls

53 lines (41 loc) · 1.79 KB

Custom Image

Currently, the limitador image being used in the deployment is read from different sources with some order of precedence:

  • If Limtador CR's spec.image is set -> image = ${spec.image}
  • If Limtador CR's spec.version is set -> image = quay.io/kuadrant/limitador:${spec.version} (note the repo is hardcoded)
  • if RELATED_IMAGE_LIMITADOR env var is set -> image = $RELATED_IMAGE_LIMITADOR
  • else: hardcoded to quay.io/kuadrant/limitador:latest

The spec.image field is not meant to be used in production environments. It is meant to be used for dev/testing purposes. The main drawback of the spec.image usage is that upgrades cannot be supported as the limitador operator cannot ensure the operation to be safe.

---
apiVersion: limitador.kuadrant.io/v1alpha1
kind: Limitador
metadata:
  name: limitador-instance-1
spec:
  image: example.com/myorg/limitador-repo:custom-image-v1
EOF

Pull an Image from a Private Registry

To pull an image from a private container image registry or repository, you need to provide credentials.

Create a Secret of type kubernetes.io/dockerconfigjson by providing credentials. For example, using kubectl tool with the following command line:

kubectl create secret docker-registry regcred --docker-server=<your-registry-server> --docker-username=<your-name> --docker-password=<your-pword>

That will create a secret named regcred.

Deploy limitador instance with the imagePullSecrets field having a reference to the regcred.

---
apiVersion: limitador.kuadrant.io/v1alpha1
kind: Limitador
metadata:
  name: limitador-instance-1
spec:
  image: example.com/myorg/limitador-repo:custom-image-v1
  imagePullSecrets:
  - name: regcred

NOTE: It is mandatory that the secret and limitador CR are created in the same namespace.