Chainguard Container for thanos-receive-controller

Kubernetes controller to automatically configure Thanos receive hashrings

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/thanos-receive-controller:latest

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

Compatibility Notes

Chainguard's thanos-receive-controller container image is comparable to the observatorium/thanos-receive-controller image on quay.io, with the following differences:

• Like all other Chainguard Containers, thanos-receive-controller features a stripped down, minimal design
• It has few-to-zero CVEs

Getting Started

First you need to create a ConfigMap that contains the initial hashring configuration. For example, create a file named hashrings.json with the following content:

{
  "hashrings": [
    {
      "hashring": "hashring0",
      "tenants": ["foo", "bar"]
    },
    {
      "hashring": "hashring1",
      "tenants": ["baz"]
    }
  ]
}

Then, create the ConfigMap in your Kubernetes cluster:

kubectl create configmap thanos-receive --from-file=hashrings.json

then create the Deployment:

deployment.yaml:

cat <<'EOF' | kubectl apply -f -
apiVersion: apps/v1
kind: Deployment
metadata:
  name: thanos-receive-controller
  labels:
    app.kubernetes.io/name: thanos-receive-controller
spec:
  replicas: 1
  selector:
    matchLabels:
      app.kubernetes.io/name: thanos-receive-controller
  template:
    metadata:
      labels:
        app.kubernetes.io/name: thanos-receive-controller
    spec:
      containers:
      - args:
        - --configmap-name=thanos-receive
        - --configmap-generated-name=thanos-receive-generated
        - --file-name=hashrings.json
        image: cgr.dev/ORGANIZATION/thanos-receive-controller:latest
        name: thanos-receive-controller
EOF

Make sure to replace ORGANIZATION with your organization's name.

After deploying, you can check if the ConfigMap was created successfully:

kubectl get configmap thanos-receive-generated -o yaml

You should see the thanos-receive-generated ConfigMap with the same data as the original thanos-receive ConfigMap.

Next, deploy StatefulSets of Thanos receivers labeled with controller.receive.thanos.io=thanos-receive-controller. The controller lists all of the StatefulSets with that label and matches the value of their controller.receive.thanos.io/hashring labels to the hashring names in the configuration file. The endpoints for each hashring will be populated automatically by the controller and the complete configuration file will be placed in a ConfigMap named thanos-receive-generated. This configuration should be consumed as a ConfigMap volume by the Thanos receivers.

Documentation and Resources

• Hashring management and autoscaling in Kubernetes
• GitHub Repository

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.