Deploy the redis-replication helm chart on Rancher

Question

Pulumi · Accepted Answer

To deploy a Helm chart on Rancher using Pulumi, you will need to use the Rancher2 provider, which allows you to manage resources within Rancher. Specifically, you will use the rancher2.CatalogV2 resource to manage Helm chart repositories and the rancher2.AppV2 resource to deploy applications from Helm charts.

The first step is to add the Helm chart repository to Rancher, if it isn't already present. In this case, you'll want to add the official Helm chart repository for Redis, which is typically found at https://charts.bitnami.com/bitnami. Then, you will deploy the Redis chart with replication enabled.

Below is a Pulumi program in TypeScript that demonstrates how to accomplish this. To successfully run this program, you will need to have Pulumi installed, be authenticated with Rancher, and have the necessary permissions to create resources.

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

// You first create the Catalog, which is like adding a Helm repository in Rancher.
const catalog = new rancher2.CatalogV2("redis-catalog", {
    // The name of the catalog
    name: "redis",
    // Bitnami's Helm chart repo URL for Redis
    url: "https://charts.bitnami.com/bitnami",
    // The cluster that this catalog will belong to
    clusterId: "<YOUR-CLUSTER-ID>", // Replace with your actual cluster id
});

// Once the catalog is created, you can use it to install applications from, such as Redis.
const redisApp = new rancher2.AppV2("redis-replication-app", {
    // The name of the app
    name: "redis-replication",
    // The namespace where the app will be installed
    namespace: "default", // You may need to replace this with the actual namespace
    // The cluster id where the app will be installed
    clusterId: "<YOUR-CLUSTER-ID>", // Replace with your actual cluster id
    // The chart details: repository name and chart name
    repoName: catalog.name,
    chartName: "redis",
    // The version of the chart
    chartVersion: "14.6.1", // You may need to adjust the version as per the latest available
    // Values to be passed to the Helm chart for Redis customization
    values: pulumi.output({
        // These values will set up Redis with replication
        cluster: {
            enabled: true,
            // Required number of slave replicas
            slaveCount: 2,
        },
        // You can add other configuration parameters as needed here
    }),
});

// Output the Redis application endpoint
export const redisEndpoint = redisApp.status.apply(status => {
    // The application endpoint will be outputted once available
    return status?.urls.join(", ");
});

The program begins by defining a Redis chart catalog from Bitnami's Helm repository. Notice that you need to replace <YOUR-CLUSTER-ID> with your actual cluster ID where the app will be deployed. Then it proceeds to create an application that references the catalog and installs the Redis chart with replication enabled by setting the cluster.enabled value to true and specifying the number of slave replicas.

Make sure to replace placeholders with valid values relevant to your Rancher setup:

<YOUR-CLUSTER-ID> should be replaced with the actual cluster ID in your Rancher deployment. This value determines where the catalog and application are created.

The program outputs the endpoint for the Redis replication application, which can be retrieved from the Pulumi stack outputs after the deployment is successful.

To run the Pulumi program, you save the code in a file with a .ts extension, and run pulumi up in your terminal within the directory containing the program. Pulumi will perform the deployment according to this script, and you can monitor the progress in your terminal or through the Pulumi web interface if you've set up an account.