Deploy the benthos helm chart on Rancher

Question

Pulumi · Accepted Answer

To deploy the Benthos Helm chart on Rancher, we will use Pulumi's Rancher 2 provider. The provider allows us to interact with Rancher's API to manage resources within a Rancher Kubernetes environment.

Before we dive into the program, let's understand the components involved:

Rancher: It's a Kubernetes management platform that allows you to operate Kubernetes clusters on any provider.
Helm: A package manager for Kubernetes which simplifies deployment of applications and services.
Benthos: An open-source data stream processing tool that we are looking to deploy using its Helm chart.

Here is what we will do in the Pulumi program:

Set up the Rancher provider configuration to connect with your Rancher instance.
Define a CatalogV2 resource that adds the Helm repository containing the Benthos chart to Rancher.
Define a AppV2 resource that deploys the Benthos Helm chart into a specified namespace.

Below is the full Pulumi TypeScript program that will deploy the Benthos Helm chart on a Rancher-managed Kubernetes cluster:

import * as pulumi from "@pulumi/pulumi";
import * as rancher2 from "@pulumi/rancher2";

// Replace these placeholders with actual values
const rancherUrl = "https://<RANCHER_API_URL>";
const accessToken = "<RANCHER_BEARER_TOKEN>";
const clusterId = "<RANCHER_CLUSTER_ID>";

// Configure the Rancher provider to connect to your Rancher API endpoint with proper credentials
const provider = new rancher2.Provider("rancher-provider", {
    apiUrl: rancherUrl,
    tokenKey: accessToken,
});

// Adding the Helm chart repository to Rancher
const benthosHelmRepo = new rancher2.CatalogV2("benthos-helm-repo", {
    clusterId: clusterId,
    name: "benthos",
    url: "https://charts.benthos.dev", // This is the official Benthos Helm chart repository, replace if needed
    gitBranch: "main",
}, { provider });

// Deploy the Benthos Helm chart using the rancher2.AppV2 resource
const benthosHelmApp = new rancher2.AppV2("benthos-helm-app", {
    chartName: "benthos", // Replace with the name of the chart in the Helm repository, if different
    clusterId: clusterId,
    namespace: "default", // Specify the namespace where Benthos will be deployed
    releaseName: "benthos-release", // Release name for deployment, can be customized
    repoName: benthosHelmRepo.name, // Refers to the CatalogV2 resource we defined earlier
    values: `
      # Your custom values here, for example:
      replicaCount: 1
      benthos: 
        config: |
          http:
            address: 0.0.0.0:4195
            read_timeout: 5s
            root_path: /benthos
            debug_endpoints: false
    `, // Customize Benthos configuration here, using multiline string
});

// Export the Helm app's name and version
export const helmAppName = benthosHelmApp.chartName;
export const helmAppReleaseName = benthosHelmApp.releaseName;

In this Pulumi program, you'll notice that we have defined two main resources: CatalogV2 and AppV2.

CatalogV2 is responsible for registering the Benthos Helm chart repository with Rancher.
AppV2 actually deploys the application (Benthos, in this case) using the Helm chart from the repository we added.

Ensure that you replace the placeholders <RANCHER_API_URL>, <RANCHER_BEARER_TOKEN>, and <RANCHER_CLUSTER_ID> with the actual values that correspond to your Rancher setup. These will be required to authenticate and identify the target cluster in Rancher where you wish to deploy the Benthos chart.

Additionally, under values, you can customize the Benthos deployment with your required number of replicas, configurations, and so on by modifying the YAML structure as per your requirements.

To execute this Pulumi program, save it in a file (for example, index.ts), and then run pulumi up through the Pulumi CLI. This command will prompt you to review the changes before applying them.

Remember, Pulumi programs use your cloud credentials from your environment or the Pulumi configuration, so make sure your environment is set up with the necessary access tokens for Rancher prior to running the program.