kates-connect

packaged by Chainguard

Chainguard Container for kates-connect

Kafka Connect image for the Strimzi operator, bundling Debezium CDC connectors for PostgreSQL, MySQL, MongoDB and SQL Server, Apicurio Registry converters, and Aiven JDBC source and sink connectors.

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/kates-connect:latest

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

Compatibility Notes

This image is comparable to the upstream Connect image and is built on the same Strimzi Kafka base, with four differences:

• The Debezium Scripting SMT is installed inside every connector directory rather than as its own entry on the plugin path. Kafka gives each plugin.path entry an isolated classloader, and ContentBasedRouter and Filter extend a base class that ships only inside the connector directories, so a standalone entry leaves both transformations undiscoverable. Upstream's image has this defect.
• The Oracle CDC connector is not included. Its artifact is Apache-2.0, but building it requires Oracle-licensed dependencies.
• Provided-scope JARs such as connect-api, kafka-clients and slf4j-api are not bundled. A Connect worker supplies these from its own classpath, so shipping them adds unreachable code and its vulnerabilities.
• Component versions are newer: Debezium 3.6.2, Aiven JDBC 6.12.0, and Apicurio Registry 3.3.3.

Prerequisites

• A running Strimzi Cluster Operator.
• A Kafka cluster the worker can reach, such as a Strimzi Kafka resource.

Getting Started

This image has no entrypoint. The Strimzi Cluster Operator supplies the command, so deploy it through a KafkaConnect resource rather than running it directly.

Tell the operator about the image by listing it against the Kafka versions it supports, in a values file:

# operator-values.yaml
extraEnvs:
  - name: STRIMZI_KAFKA_CONNECT_IMAGES
    value: |
      4.2.0=cgr.dev/ORGANIZATION/kates-connect:latest
      4.2.1=cgr.dev/ORGANIZATION/kates-connect:latest
      4.3.0=cgr.dev/ORGANIZATION/kates-connect:latest
      4.3.1=cgr.dev/ORGANIZATION/kates-connect:latest

Install the operator with that file:

helm install strimzi oci://quay.io/strimzi-helm/strimzi-kafka-operator -f operator-values.yaml

The operator validates this variable at startup and requires an entry for every Kafka version its release supports. A missing version stops the operator from starting.

Create the KafkaConnect resource:

# connect.yaml
apiVersion: kafka.strimzi.io/v1
kind: KafkaConnect
metadata:
  name: kates
spec:
  version: 4.3.1
  replicas: 1
  bootstrapServers: my-cluster-kafka-bootstrap:9093
  tls:
    trustedCertificates:
      - secretName: my-cluster-cluster-ca-cert
        pattern: "*.crt"
  groupId: kates-connect
  configStorageTopic: connect-configs
  offsetStorageTopic: connect-offsets
  statusStorageTopic: connect-status
  config:
    config.storage.replication.factor: 1
    offset.storage.replication.factor: 1
    status.storage.replication.factor: 1
    plugin.discovery: service_load

Apply it and wait for the worker to become ready:

kubectl apply -f connect.yaml
kubectl wait kafkaconnect/kates --for=condition=Ready --timeout=10m

Forward the worker's REST API port:

kubectl port-forward svc/kates-connect-api 8083:8083

From another shell, list the bundled plugins:

curl -s "http://localhost:8083/connector-plugins?connectorsOnly=false"

connectorsOnly=false is required to see transformations and converters. The default returns connectors only, so a check for a transformation appears to fail when the plugin is present and working.

Configuration

Set plugin.discovery to service_load in the KafkaConnect resource, as shown above. Every plugin in this image carries a ServiceLoader manifest, so the worker can resolve plugins from those manifests instead of scanning the classpath reflectively, which cuts worker startup scan time substantially. Kafka warns on startup under the default setting, and service_load is becoming the upstream default.

Documentation and Resources

• Chainguard Containers documentation
• Strimzi documentation
• Debezium connector documentation
• Apicurio Registry SerDes documentation
• Aiven JDBC connector documentation

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.