Deploy the tyk-gateway helm chart on Kubernetes

Question

Pulumi · Accepted Answer

Deploying a Helm chart on a Kubernetes cluster with Pulumi is straightforward. Using Pulumi's Kubernetes provider, you can instantiate a Helm chart within your Kubernetes cluster. In this case, we'll deploy the `tyk-gateway` Helm chart.

To use a Helm chart with Pulumi, you should be aware of the following principal components:

- `kubernetes.helm.v3.Chart`: This is a Pulumi resource that represents a Helm chart. When defining this resource in Pulumi, you specify the chart name, version, and configuration parameters. Pulumi will then ensure that the Helm chart is applied to your Kubernetes cluster.

Below is the TypeScript program that deploys the `tyk-gateway` Helm chart on a Kubernetes cluster using Pulumi. This assumes you've already set up your Pulumi environment and have configured kubectl to connect to your Kubernetes cluster.

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

// Create an instance of the Kubernetes Helm Chart class to deploy `tyk-gateway`.
const tykGatewayChart = new k8s.helm.v3.Chart("tyk-gateway", {
  repo: "tyk-helm", // repository name where the chart is hosted
  chart: "tyk-gateway", // chart name
  // Specify the version of the chart (optional).
  // If you omit the version, the latest version will be installed.
  version: "1.0.0",
  // Values to pass to the Helm chart. This object structure depends on the chart itself.
  values: {
    // Values here would adjust the chart's configurations, e.g.,
    // namespace where tyk-gateway should be deployed, 
    // resource constraints, and other chart-specific settings.
  },
  // If your Helm chart needs to be installed in a specific namespace,
  // you can specify it with the `namespace` property.
  namespace: "tyk", // Adjust the namespace as needed
});

// Export any resources that your program creates, if needed.
export const chartName = tykGatewayChart.metadata.apply(metadata => metadata.name);
```

Before you run the above program, make sure you have the Tyk Helm repository added to your Helm environment with the following command:

```bash
helm repo add tyk-helm https://helm.tyk.io/public/helm/charts/
```

In the Pulumi program, we instantiate a `Chart` object from the Pulumi Kubernetes library, specifying the repository (`repo`), the chart name (`chart`), and potentially the version. The `values` property is an object where you can specify configuration parameters that overwrite default chart values, just as you would with a `values.yaml` file when using Helm CLI.

You can modify the `values` field to match the specific Tyk configuration you need. You can find the configuration options in the official [Tyk Gateway Helm chart documentation](https://tyk.io/docs/tyk-stack/tyk-gateway/installation/with-kubernetes/with-helm/).

Remember to replace `1.0.0` with the actual chart version you want to deploy.

Once the program is set up, you can deploy it using the Pulumi CLI commands:

1. Navigate to the directory containing your Pulumi program.
2. Run `pulumi up` to preview and deploy the changes.

Please make sure you have Pulumi and kubectl installed, and you are logged in to your Kubernetes cluster where you intend to deploy the `tyk-gateway`.