Deploy the brave-sync helm chart on Kubernetes

Question

Pulumi · Accepted Answer

Deploying a Helm chart on a Kubernetes cluster with Pulumi involves several steps. The example below outlines how you would use Pulumi to deploy the brave-sync Helm chart on a Kubernetes cluster. Before diving into the code, let's understand the main components we will be dealing with:

Kubernetes Cluster: This is the cluster where your Helm chart will be deployed. It's assumed that you have a Kubernetes cluster already running and that kubectl is configured to interact with it. Pulumi will use your current context from ~/.kube/config, unless specified otherwise.
Helm Chart: Helm charts are collections of pre-configured Kubernetes resources. In this case, brave-sync would be the chart we want to deploy.
Pulumi Kubernetes Provider: This is a Pulumi package that allows you to interact with Kubernetes resources within a Pulumi program.

Here's the Pulumi TypeScript program that deploys a Helm chart:

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

// Create a Kubernetes provider instance that uses our existing cluster configuration.
const provider = new k8s.Provider("k8s-provider", {
    kubeconfig: '<KUBECONFIG_CONTENT>',
});

// Define the Helm chart, its version, and the values to pass in.
const chart = new k8s.helm.v3.Chart("brave-sync", {
    chart: "brave-sync",
    version: "<CHART_VERSION>", // Replace with the specific chart version you wish to deploy
    fetchOpts: { repo: "https://helm-repository-url/" }, // Replace with the Helm chart repository URL
    // Values to pass to the Helm chart.
    values: {
        /* Add any specific configuration here */
    },
}, { provider });

// Export the name of the chart
export const chartName = chart.metadata.apply(m => m.name);

In this program:

We import the Pulumi Kubernetes package.
We instantiate a Kubernetes provider, k8s.Provider, by providing it with your Kubernetes cluster's kubeconfig information. If your kubeconfig is already set up in the environment, you don't need to explicitly pass it.
We create a new instance of the Chart class from the Pulumi Kubernetes Helm package (@pulumi/kubernetes/helm/v3), and we pass it the chart name, version, and any required configuration values. The chart version and Helm repo URL have to be specified to match the brave-sync chart details.
We export the name of the chart, which is a Pulumi output that will display the name of the deployed Helm chart once the program is run.

With this Pulumi program, when you use pulumi up, Pulumi will reach out to your Kubernetes cluster and apply the chart in the same way Helm does. You will be able to see the resources created in the Pulumi CLI output, and you can manage the lifecycle of these resources using Pulumi's CLI as well.

To run this program, save it to a file with a .ts extension, such as index.ts. Make sure you have Pulumi installed and have a Pulumi project created. Place the index.ts file inside your Pulumi project's directory and run pulumi up. Pulumi will perform the deployment according to the configuration specified in the program.

Remember, if you omit the kubeconfig parameter in the k8s.Provider, Pulumi will default to using the kubeconfig file from the environment where you're running the Pulumi command, which is usually located at ~/.kube/config.