Deploy the workload-operator helm chart on Rancher

Question

Pulumi · Accepted Answer

To deploy a Helm chart on Rancher using Pulumi, you would typically need to:

Set up Pulumi with the Rancher2 provider.
Use the provider to interact with your Rancher instance.
Define the Helm chart deployment using the appropriate Pulumi resources.

Given that the provided Pulumi Registry Results mention Rancher-related resources, we will focus on rancher2.CatalogV2 to add the Helm chart repository and rancher2.AppV2 to deploy the Helm chart, which, although not directly listed, is a common resource for Helm operations in the Rancher2 provider context.

First, ensure you're authenticated with your Rancher server and have your Pulumi stack set up for the correct Kubernetes cluster and namespace where you want to deploy the Helm chart.

Here is a program in TypeScript that demonstrates how to achieve this (assuming that the workload-operator Helm chart is publically available or you have access to it):

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

// Initialize the Rancher provider using configuration parameters for Rancher's URL and access credentials.
const rancherProvider = new rancher2.Provider("rancher", {
    apiUrl: "https://<RANCHER_API_URL>",         // Replace with your Rancher API URL
    accessKey: "<RANCHER_ACCESS_KEY>",           // Replace with your Rancher Access Key
    secretKey: "<RANCHER_SECRET_KEY>",           // Replace with your Rancher Secret Key
});

// Add the Helm repository to the Rancher server as a Catalog in the Rancher control plane.
const catalog = new rancher2.CatalogV2("workload-operator-repo", {
    // Configure the URL to the Helm chart repository containing the `workload-operator` chart
    url: "https://charts.example.com/",                 // Replace with the actual helm chart repository URL
    clusterId: "<RANCHER_CLUSTER_ID>",                  // Replace with your cluster ID in Rancher
    gitBranch: "main",                                  // Use the correct branch if the URL is a Git repository
}, { provider: rancherProvider });

// Deploy the workload-operator Helm chart using the App resource.
const workloadOperatorChart = new rancher2.AppV2("workload-operator", {
    repoName: catalog.name,                             // Use the created catalog name  
    chartName: "workload-operator",                     // The name of the chart to install
    namespace: "default",                               // Define the namespace where the chart should be installed
    clusterId: "<RANCHER_CLUSTER_ID>",                  // The target cluster's ID in Rancher
    values: {                                           // Configuration values for the deployment (add your own values)
        // For example:
        image: {
            repository: "example/workload-operator",
            tag: "latest",
        },
        // Add other configuration values here
    },
}, { provider: rancherProvider, dependsOn: [catalog] });  // Make sure the chart deployment depends on the catalog creation 

// Export any necessary information, like the app's name or namespace.
export const workloadOperatorName = workloadOperatorChart.metadata.apply(m => m.name);
export const workloadOperatorNamespace = workloadOperatorChart.metadata.apply(m => m.namespace);

In this program:

We create a new instance of the Rancher provider, initializing it with the necessary API URL and access keys for authentication.
We add a CatalogV2 resource which represents a Helm chart repository in Rancher. This is where workload-operator Helm chart is located.
We deploy the workload-operator Helm chart using the AppV2 resource. We pass the repository name, chart name, and any configuration values for that chart.
Finally, we export some of the metadata of the deployed app, such as its name and namespace, which might be useful for querying and managing afterward.

Replace the placeholder values in angle brackets (<RANCHER_API_URL>, <RANCHER_ACCESS_KEY>, <RANCHER_SECRET_KEY>, and <RANCHER_CLUSTER_ID>) with your actual Rancher instance's API URL, access key, secret key, and cluster ID.

Adjust the values property within the workloadOperatorChart resource to match the configuration values required by the workload-operator chart. The example above assumes an image configuration, but it will vary depending on the chart's requirements.

After defining the program, run pulumi up to execute the deployment. Pulumi will communicate with Rancher to deploy the specified Helm chart to your Kubernetes cluster.

Remember to review the Rancher2 Pulumi provider documentation for more detailed examples and explanations of each resource and property.