Deploy the kube-janitor helm chart on Kubernetes

Question

Pulumi · Accepted Answer

To deploy the kube-janitor Helm chart on Kubernetes using Pulumi, first, you need to have a Kubernetes cluster available. You can use an existing cluster, or you can create one using Pulumi. For this purpose, we will assume that you already have a Kubernetes cluster configured and your kubectl is set up to communicate with it.

Pulumi allows you to leverage existing Helm charts to deploy applications into your Kubernetes cluster. Here we will use the Chart resource from the @pulumi/kubernetes package, which can deploy a Helm chart from a repository.

In the following Pulumi TypeScript program, we're going to:

Import the necessary Pulumi classes.
Use the Chart class from the @pulumi/kubernetes/helm/v3 module to deploy the kube-janitor Helm chart.

Here is the code to do this:

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

// Name of the Helm Chart
const chartName = "kube-janitor";

// Create an instance of the Helm Chart.
// This will install the kube-janitor chart from the Helm repository.
const kubeJanitor = new k8s.helm.v3.Chart(chartName, {
    // Replace `<REPO_URL>` with the actual Helm repository URL that hosts the kube-janitor chart
    // If the chart is in a public repository, you can omit the `repo` argument.
    repo: "<REPO_URL>",
    chart: chartName,
    // Specify the chart version you want to deploy
    version: "<CHART_VERSION>",
    // Override default values from the chart
    // Replace the values or add additional configurations suitable for your use case.
    values: {
        // For example, you might want to specify the time-to-live (TTL) for the resources.
        // This will cleanup resources older than the specified TTL.
        ttl: "720h", // 30 days
        // ... other values to override
    },
});

// Export the chart's status
export const status = kubeJanitor.status;

In the values object, you can override default settings provided by the kube-janitor Helm chart. An example of such an override is setting the ttl parameter which dictates the lifetime of the resources that the kube-janitor will clean up. You would replace <REPO_URL> with the URL of the repository containing the kube-janitor chart, and <CHART_VERSION> with the specific version of the chart that you want to use. Please make sure to replace them with the actual values before running the program.

After writing this program to a .ts file, you will run the following Pulumi CLI commands to deploy it:

# Login to the Pulumi service, where state will be stored for your stack
pulumi login

# Install the NPM dependencies, including @pulumi/kubernetes
npm install

# Create a new Pulumi stack for your Kubernetes deployment (if it doesn't already exist)
pulumi stack init dev

# Review the deployment plan to understand what actions Pulumi will take
pulumi preview

# Deploy the kube-janitor Helm chart to your Kubernetes cluster
pulumi up

The pulumi preview command shows what Pulumi is planning to do and pulumi up actually performs the deployment.

Remember to give your Kubernetes provider and Pulumi program the right permissions to interact with your Kubernetes cluster. Your Pulumi provider must be configured with the context of the Kubernetes cluster you wish to deploy to.

If you need to find the kube-janitor Helm chart repository URL, you can typically find this information on the project's homepage or in the public Helm chart repository listings.