Access K8ssandra Repair with Traefik

Expose access to your Reaper for Apache Cassandra® repair interface using Traefik ingress.
We haven't updated the descriptions in this topic yet for the K8ssandra Operator implementation. The content below applies to the earlier K8ssandra 1.4.x deployments. We will provide an updated version of this K8ssandra Operator topic soon. In the meantime, please join our K8ssandra Community Discord channel and we'll answer your questions there. Thanks!

Follow these steps to configure and install Traefik Ingress custom resources for accessing your K8ssandra cluster’s repair interface (provided by Reaper for Apache Cassandra®).

Tools

  • Helm

Prerequisites

  1. Kubernetes cluster with the following elements deployed:

    See the Configuring Kind for an example of how to set up a local installation.

  2. DNS name where the repair service should be listening.

Helm Parameters

The k8ssandra Helm chart contains templates for the Traefik IngressRoute and custom resource. This may be enabled at any time either through a values.yaml file or via command-line flags.

For the latest, see the sample values.yaml.

Note the host parameter: this is where the DNS name must be provided. You will reference this DNS when accessing Reaper in a Web URL.

If you maintain a values.yaml or traefik.values.yaml file, change the reaper.ingress.enabled Boolean from false to true. Or, specify --set reaper.ingress.enabled=true on the helm install command line.

Enabling Traefik Ingress

Traefik ingress may be enabled on the command-line or via a values.yaml file. The K8ssandra team recommends storing this information in a values.yaml as that may be version controlled and managed in a DevOps friendly manner. Examples of both approaches are provided below as reference.

values.yaml

New install:

helm install cluster-name k8ssandra/k8ssandra -f traefik.values.yaml

Existing Cluster:

helm upgrade cluster-name k8ssandra/k8ssandra -f traefik.values.yaml

Command-line

New install:

helm install cluster-name k8ssandra/k8ssandra --set reaper.ingress.enabled=true,reaper.ingress.host=localhost

Existing cluster:

helm install cluster-name k8ssandra/k8ssandra --set reaper.ingress.enabled=true,reaper.ingress.host=localhost

Validate Traefik Configuration

With the ingress routes configured and deployed to Kubernetes we can access the Traefik dashboard to validate the configuration has been picked up and is detecting the appropriate services:

  1. Open your web browser and point it at the Traefik dashboard. This may require kubectl port-forward or the steps in our Configuring Kind guide.

    Traefik Dashboard

  2. Navigate to the HTTP Routers page

    Traefik HTTP Routers

    There should be an entry representing the hostname based rule created as part of the Helm command. Note the Kubernetes logo to the right of the table indicating it was provisioned via a Kubernetes custom resource.

  3. Navigate to the HTTP Services page Traefik HTTPServices

    There should be an entry representing the Reaper service. Note the Kubernetes logo to the right of the table indicating it was provisioned via a Kubernetes custom resource.

Next steps

Feel free to explore the other Traefik ingress topics. Also see Monitor Cassandra.



Last modified December 8, 2022: Fix installation docs (#1546) (9184626)