Deploy the tmf-component helm chart on Kubernetes

Question

Pulumi · Accepted Answer

To deploy a Helm chart on Kubernetes using Pulumi, you will need to write a Pulumi program in TypeScript that describes the desired state of your Kubernetes resources, including the Helm chart you want to deploy.

Pulumi's Kubernetes provider is used to manage resources on a Kubernetes cluster, and for Helm charts specifically, Pulumi provides a Chart resource that can be used to deploy charts from Helm repositories.

Here's a detailed break-down of what needs to be done:

Setup the Pulumi Program: Initialize a new Pulumi program if you haven't yet. You can do this by running pulumi new typescript in your command-line interface.
Install the Kubernetes Package: Ensure you have the Pulumi Kubernetes package installed by running npm install @pulumi/kubernetes.
Kubernetes Cluster Configuration: You'll need access to a Kubernetes cluster. Pulumi assumes you have a kubeconfig file with the cluster access configurations on your local machine (usually located at ~/.kube/config).
Create a Helm Chart Resource: You will use the Chart class from the Pulumi Kubernetes package to deploy your Helm chart. The specific chart we're deploying is tmf-component. You'll need to provide the necessary information such as repository URL, chart name, version, and any custom values you may need for your deployment.
Deploy: Run pulumi up to deploy your Helm chart to the cluster.

Below is the TypeScript program that illustrates these steps. Make sure to replace placeholders like <YOUR CHART REPO URL> with the actual values pertinent to your Helm chart:

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

// Place to specify Helm chart configuration.
const tmfComponentChart = new k8s.helm.v3.Chart("tmf-component", {
    // If your helm chart is in a Helm repository, specify the repo URL here.
    // repo: "<YOUR CHART REPO URL>",
    
    // Specify the name of the chart. Make sure this is correct.
    chart: "tmf-component",
    
    // Specify the namespace where the chart will be installed. Change if necessary.
    namespace: "default",
    
    // If you know the version of the chart, you can pin it down here.
    // version: "<CHART VERSION>",
    
    // If you have custom values you want to override, you can specify them here.
    // values: {
    //     key: "value",
    // },
    
    // Optionally specify transformations if you need to manipulate any resource before it is created.
    // transformations: [
    //     (resource: any) => {
    //         // Example transformation: add an annotation to each resource.
    //         if (resource.metadata.annotations == null) {
    //             resource.metadata.annotations = {};
    //         }
    //         resource.metadata.annotations["example-annotation"] = "example-value";
    //     },
    // ],

    // It's good practice to set resource options if you're working within a team or CI/CD environment.
    // For instance, here's how you specify a custom provider instance.
    // provider: myK8sProvider,
});

// Export the resulting base DNS name when the program is deployed.
export const tmfComponentBaseName = tmfComponentChart.getResourceProperty("v1/Service", "tmf-component", "metadata").apply(md => md.name);

This Pulumi program declares that we want to deploy the tmf-component Helm chart into the default namespace. Replace <YOUR CHART REPO URL> and <CHART VERSION> with the appropriate values for your Helm chart repository and the version of the chart you want to deploy.

The values field lets you specify any customizations you would like to apply to the default Helm chart values. This is useful if you need to change any default configurations provided by the Helm chart.

If the tmf-component Helm chart creates a Kubernetes Service, the final export will output the Service's name once the deployment is complete.

The transformations field indicates optional code blocks that can transform the Kubernetes resources created by the Helm chart on deployment. This is useful if you have special modifications that are not covered by the Helm values.

Remember to run pulumi up after writing your code to initiate the deployment. Pulumi will show you a preview of the resources that will be created. If the preview looks good, confirm the deployment, and Pulumi will do the rest.