Deploy the rox-deployment-check helm chart on Rancher

Question

Pulumi · Accepted Answer

To deploy a Helm chart on Rancher using Pulumi, you'll first need the rancher2 provider configured in your Pulumi project. The rancher2 provider allows you to interact with Rancher's resources, like clusters, namespaces, and Helm charts.

In this case, we want to deploy the rox-deployment-check Helm chart on Rancher. We assume that:

You have an existing Rancher cluster where you want to install the Helm chart.
You have the Helm chart available in a chart repository that Rancher can access or it's a built-in chart in Rancher's catalog.

Here's a step-by-step guide in TypeScript on how to accomplish this:

Set up the rancher2 provider: You need to import the rancher2 module and create an instance of the provider.
Create a namespace: If not already present, create a Kubernetes namespace on the Rancher cluster where you want to install the Helm chart.
Deploy the Helm chart: Use the HelmChart resource from the rancher2 provider to deploy the rox-deployment-check Helm chart.

Here's a full example of how you might set up your Pulumi program to deploy the Helm chart:

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

// Initialize the Rancher2 provider.
const provider = new rancher2.Provider("my-rancher", {
    apiVersion: "v3",
    baseUrl: "https://your-rancher-api-endpoint",
    accessToken: "your-rancher-access-token", // You should get this token from your Rancher UI/API
});

// Create a namespace in Rancher for the helm chart (if it doesn't already exist).
const roxNamespace = new rancher2.Namespace("rox-deployment-check-namespace", {
    name: "rox-check",
    projectId: "<PROJECT_ID>", // Replace with your project ID in Rancher
}, { provider: provider });

// Deploy the Helm chart in the created namespace.
const roxChart = new rancher2.HelmChart("rox-deployment-check-chart", {
    repository: "https://your.chart.repository", // The URL of the chart repository.
    chart: "rox-deployment-check",  // The name of the chart in the repository.
    version: "1.0.0",               // The specific version of the chart you want to deploy.
    namespace: roxNamespace.name,   // Deploy the chart in the newly created namespace.
    // Set values for the helm chart as needed. This is equivalent to `--set` in helm CLI.
    values: {
        // Example: set some value if the chart supports it.
        serviceName: "some-service",
    }
}, { provider: provider });

// Export the namespace name and chart name as stack outputs.
export const namespaceName = roxNamespace.name;
export const chartName = roxChart.name;

In the code above:

We create a Pulumi provider for Rancher which is authenticated using a Rancher access token. You'll need to replace https://your-rancher-api-endpoint and your-rancher-access-token with the appropriate Rancher API endpoint and a valid access token.
We define a new Kubernetes namespace where the Helm chart will be deployed. Replace <PROJECT_ID> with the ID of the Rancher project that your cluster lives in.
We create a HelmChart resource named rox-deployment-check-chart that points to the 'rox-deployment-check' Helm chart.

Please note that this code assumes that the chart rox-deployment-check is available in the repository at the provided URL and that you have already configured your Pulumi program to use credentials that have the necessary permissions on Rancher.

Before running this Pulumi program, ensure you have installed the Pulumi CLI and configured it with the appropriate account credentials.

Remember to handle sensitive information, such as the Rancher access token, securely. Ideally, it should be stored in a secure storage system and accessed via Pulumi's secret management features or environment variables, rather than hardcoding it in your program.