Deploy the openid helm chart on Rancher

Question

Pulumi · Accepted Answer

Deploying a Helm chart on a Rancher-managed Kubernetes cluster involves several steps. We'll assume that you have an existing Rancher server and a Kubernetes cluster managed by Rancher. The following program demonstrates how to deploy an OpenID Connect (OIDC)-enabled Helm chart on a Kubernetes cluster managed by Rancher using Pulumi.

To achieve this with Pulumi and the rancher2 provider, we will proceed as follows:

Import the necessary Pulumi and rancher2 packages.
Create a namespace within your Rancher-managed Kubernetes cluster where the Helm chart will be deployed.
Add the Helm chart repository to Rancher.
Deploy the Helm chart to the namespace.

The OpenID Connect (OIDC) Helm chart is typically used for installing an OIDC provider (like Keycloak, Dex, etc.). Here we'll just use the term 'openid' Helm chart but you would substitute the actual chart name and any additional configuration values it requires.

Below is the TypeScript program to accomplish this:

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

// Step 1: Create a namespace for the Helm chart
const openidNamespace = new rancher2.Namespace("openid-namespace", {
    name: "openid",
    // Replace '<PROJECT_ID>' with the actual Rancher Project ID
    projectId: "<PROJECT_ID>",
    // You can add labels and annotations as needed here
});

// Step 2: Add the Helm chart repository to Rancher
// Replace 'CHART_REPO_URL' with the actual Helm chart repository URL
const catalog = new rancher2.CatalogV2("openid-catalog", {
    name: "openid-catalog",
    // 'url' is the repository URL where the chart is located
    url: "CHART_REPO_URL",
    // This is the cluster ID of your Kubernetes cluster managed by Rancher
    clusterId: "<CLUSTER_ID>",
});

// Step 3: Deploy the Helm chart within the cluster namespace
const openidApp = new rancher2.AppV2("openid-app", {
    // You will need to replace this with the name of your chart
    chartName: "openid",
    // Define the version of your Helm chart here
    chartVersion: "<CHART_VERSION>",
    // Assigning to the created namespace
    namespace: openidNamespace.name,
    // This is the project ID within Rancher where the app is deployed
    projectId: "<PROJECT_ID>",
    // Define values for your Helm chart like service type, replicas etc.
    values: {
        // This is an example of how you might set a value, but it is not
        // specific to any Helm chart. You would have to adjust these to match the
        // values for the OpenID Helm chart you're using. 
        service: {
            type: "ClusterIP",
        },
        // ... other necessary values
    },
});

// Step 4: Export relevant information that may be required after deployment
export const appNamespace = openidNamespace.name;
export const appCatalogName = catalog.name;
export const appName = openidApp.name;

In this program:

Namespace: A Kubernetes namespace provides a mechanism for isolating groups of resources within a single cluster. Namespaces are a way to divide cluster resources between multiple users via resource quota.
Catalog: This is Rancher's representation of a Helm chart repository. We add the repository which contains our desired Helm chart to Rancher.
AppV2: This is a workload managed by Rancher, which in this case, will be the Helm chart that we want to deploy. It holds the configuration for deploying the Helm chart including the values that are usually found in a values.yaml file for Helm charts.

Replace placeholders like <PROJECT_ID>, <CLUSTER_ID>, CHART_REPO_URL, and <CHART_VERSION> with your specific information.

In the configuration for openidApp, the values object will depend on the specifics of the Helm chart you're trying to deploy. For example, if the OpenID Helm chart exposes configuration options for defining the number of replicas or what image to use, that's what you would define here.

Once you have completed your setup, you may deploy the resources using the Pulumi CLI with the following commands:

pulumi up to create or update the resources
pulumi stack output to view the stack outputs after deployment
pulumi destroy to tear down the resources when they're no longer needed