Deploy the openapi helm chart on Kubernetes

Question

Pulumi · Accepted Answer

To deploy the OpenAPI Helm chart on Kubernetes using Pulumi, you will use the Chart resource from the Pulumi Kubernetes provider. This resource allows you to deploy Helm charts in a Kubernetes cluster. The Helm chart deployment will include specifying the chart name (in this case, we assume it's openapi), potentially the chart version, and any configuration options that are specific to the OpenAPI chart. Additionally, the Helm chart might be found in a specific Helm repository, in which case you'd need to provide the repository URL.

Below you will find a Pulumi program written in TypeScript that demonstrates how to deploy the OpenAPI Helm chart. Please replace the placeholder values with the actual values for your specific chart, such as repo URL, chart name, and version.

The values property is used to provide configuration to the chart. It is equivalent to passing a values file or using --set parameters in the helm CLI. If your chart has specific mandatory configurations, you will need to set them in the values object.

Assuming that you have Pulumi installed and your Kubernetes cluster is configured for Pulumi to interact with (i.e., kubectl is configured), you can use this program to deploy the OpenAPI Helm chart:

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

// Create a Helm Chart resource for the OpenAPI chart.
// You will need to provide the correct repository and chart details,
// as well as any necessary configuration options.
const openApiChart = new k8s.helm.v3.Chart("openapi", {
    // If your Helm chart is hosted in a custom Helm repository,
    // specify its URL here. For example:
    // repo: "http://myhelmrepo.org/charts",
    repo: "<HELM CHART REPOSITORY URL>", // TODO: replace with actual repository URL if necessary
    chart: "openapi", // The name of the Helm chart you wish to deploy
    version: "<CHART VERSION>", // The version of the Helm chart (optional, remove if you want latest)
    namespace: "default", // The Kubernetes namespace in which to deploy the chart (optional)
    // Provide configuration values for the Helm chart.
    // This is equivalent to passing a values file or setting values using the --set flag in Helm.
    values: {
        // Configuration values for the OpenAPI Helm chart.
        // Example: setting the service type to LoadBalancer
        service: {
            type: "LoadBalancer",
        },
        // Additional configuration values may be set here.
    },
    // Additional options can be set if necessary.
    // fetchOpts, transformations, etc.
});

// Export the base URL of the OpenAPI service
// This assumes that the service is of type LoadBalancer and has an IP allocated.
export const openApiUrl = openApiChart.getResourceProperty("v1/Service", "openapi", "status").apply(status => `http://${status.loadBalancer.ingress[0].ip}`);

This script will create a new Helm chart instance for OpenAPI. The getResourceProperty function is used to retrieve the external IP of the LoadBalancer once it's allocated, and that IP is exported as openApiUrl so you can easily access the service. If your service type is not LoadBalancer, or if you need to access a different service property, you would adjust the export accordingly.

Note: Please ensure that the chart name and version you provide are correct for the OpenAPI chart you wish to install. The provided namespace must also exist in your cluster, or you can choose to omit the namespace property to deploy to the default namespace.

After saving your code in a TypeScript file (e.g., index.ts), you can deploy this configuration to your Kubernetes cluster using the Pulumi CLI commands:

pulumi stack init dev (for the first time, to create a new stack called 'dev')
pulumi up (to preview and apply your Pulumi program changes)

The pulumi up command will show you a preview of the resources that will be created and prompt for confirmation before proceeding to apply the changes.

Please ensure that you understand the configuration options for the specific OpenAPI Helm chart you are deploying, as these can vary between different charts and may require additional setup or prerequisites in your Kubernetes cluster.