Deploy the kafdrop helm chart on Opensshift

Question

Pulumi · Accepted Answer

Deploying a Helm chart on OpenShift with Pulumi involves a few steps. Primarily, it requires setting up Kubernetes and Helm providers to interact with your OpenShift cluster. Once providers are configured, you can instantiate a Helm chart resource using Pulumi's Chart class within the Kubernetes package.

Kafdrop is a web UI for viewing Kafka topics and browsing consumer groups. The tool displays information such as the messages within a Kafka topic, consumer group offset, and more.

Here's a step-by-step description of the code needed to deploy the Kafdrop Helm chart on OpenShift:

Set up the Kubernetes Provider: To interact with your OpenShift cluster, you'll use Pulumi's Kubernetes provider, which will be configured to use the context of your kubectl that is already set up to communicate with OpenShift.
Deploy the Helm Chart: Using the Chart resource, you'll specify the kafdrop chart and the required configurations such as values, namespace, and version, among any others needed by the chart.
Export Outputs (if necessary): Optionally, you might want to export certain outputs, such as the service URL or any other relevant details post-deployment.

Here is the TypeScript code with detailed explanations:

import * as k8s from '@pulumi/kubernetes';

// Create a provider to interact with OpenShift. Assuming kubeconfig is set up correctly,
// this provider will use the current context to deploy resources in OpenShift.
const openshiftProvider = new k8s.Provider('openshift-provider', {
    // You can specify the context, cluster, and namespace if needed, for example:
    // kubeconfig: ...,
    // context: "my-context",
    // cluster: "my-cluster",
    // namespace: "my-namespace",
});

// Deploy the Kafdrop Helm chart using the Pulumi Kubernetes provider.
// The chart version, release name, and namespace can be customized as needed.
const kafdropChart = new k8s.helm.v3.Chart('kafdrop', {
    repo: 'obsidiandynamics',        // The repository where Kafdrop Helm chart is located.
    chart: 'kafdrop',                // The name of the chart we want to deploy.
    version: '1.0.0',                // Replace with the desired chart version.
    namespace: 'kafka-dashboard',    // The namespace where Kafdrop should be deployed.
    fetchOpts: { repo: 'https://obsidiandynamics.github.io/kafdrop' },
    // Add any required Helm values here.
    // For example, to integrate with your Kafka cluster, specify broker hosts:
    values: {
        // This is an example configuration. Each Helm chart has its own set of configurable values.
        // Refer to the Kafdrop Helm chart documentation for the full list of configurable values.
        applicationInsights: {
            instrumentationKey: '<YOUR-INSTRUMENTATION-KEY>'
        },
        kafka: {
            brokerConnect: '<YOUR-KAFKA-BROKER-CONNECT>'
        },
    },
}, { provider: openshiftProvider });

// Export the Kafdrop service URL
export const kafdropServiceUrl = kafdropChart.getResourceProperty('v1/Service', 'kafdrop', 'status').apply(status => {
    const ingress = status.loadBalancer.ingress[0];
    return ingress ? `${ingress.ip || ingress.hostname}` : undefined;
});

Before running the Pulumi program, ensure the following:

You have installed Pulumi and set up the Pulumi CLI.
You're logged in to OpenShift and the kubeconfig is configured to manage your OpenShift cluster.
You have access to the Kafdrop Helm chart repository, or it's publicly available.

To run this Pulumi program, you would execute it like any other TypeScript program:

Save the above code to a file, e.g., index.ts.
Run npm install @pulumi/kubernetes to install the necessary Pulumi Kubernetes package.
Execute pulumi up to preview and deploy the resources.

After the deployment, the kafdropServiceUrl will return the access point of your Kafdrop UI, which you can use to access the Kafka dashboard.

Remember to replace placeholders such as <YOUR-INSTRUMENTATION-KEY> and <YOUR-KAFKA-BROKER-CONNECT> with your actual configuration values. If the Helm chart requires more values for deployment, make sure to fill them out accordingly.

Please note that I've provided a starting point for the values you might need to pass to the Kafdrop chart. You should refer to the official Helm chart documentation or values.yaml for an exhaustive list of configuration options.