Deploy the tyk-dashboard helm chart on Oracle Kubernetes Engine (OKE)

Question

Pulumi · Accepted Answer

To deploy the Tyk Dashboard Helm chart on Oracle Kubernetes Engine (OKE), we'll proceed with the following steps:

Set up an Oracle Kubernetes Engine (OKE) cluster.
Deploy the Tyk Dashboard using a Helm chart on the OKE cluster.

Before we start, ensure you have the Pulumi CLI installed and configured to access your Oracle Cloud Infrastructure. You will also need to set up kubectl and Helm if you want to interact with your Kubernetes cluster and Helm charts directly.

Below is a Pulumi TypeScript program that demonstrates how to accomplish your goal:

Step 1: Import Required Modules

We'll start by importing the necessary Pulumi and Kubernetes packages.

Step 2: Create an OKE Cluster

Create a new OKE cluster or use an existing one. Please ensure you have the correct configurations like the compartmentID, node pool setup, and others, which might be specific to the needs of your application.

Step 3: Deploy the Helm Chart

With the OKE cluster in place, we use Pulumi's Kubernetes provider to deploy the Tyk Dashboard Helm chart. You need to provide the chart version and any custom values you wish to override in the Helm chart.

Step 4: Export Outputs

Finally, we'll export any necessary outputs, such as the Kubernetes cluster's name or the service's endpoint, after deploying the Helm chart.

Here's the Pulumi program:

import * as pulumi from '@pulumi/pulumi';
import * as oci from '@pulumi/oci';
import * as k8s from '@pulumi/kubernetes';

// Step 2: Assuming you have an existing OKE cluster set up, 
// we'll fetch its kubeconfig. Replace `<your_cluster_name>` with your actual cluster name 
// and provide proper selectors if you have more than one cluster.
const cluster = oci.containerservice.getCluster({
    name: "<your_cluster_name>",
    // Provide additional selection criteria if needed.
});

const provider = new k8s.Provider('oke-k8s', {
    kubeconfig: cluster.kubeconfigs[0].content,
});

// Step 3: Deploy the Tyk Dashboard Helm chart
const tykDashboardChart = new k8s.helm.v3.Chart('tyk-dashboard', {
    chart: "tyk-dashboard",
    version: "<chart_version>", // Specify the Helm chart version you want to deploy
    fetchOpts: {
        repo: "https://helm.tyk.io/public/helm/charts/", // Tyk's official Helm chart repository
    },
    // Set any custom values for the Tyk Dashboard Helm chart that you require here.
    values: {
        // Example: Set the MongoDB address if you are using an external MongoDB instance
        mongodb: {
            enabled: false,
            host: "<mongodb_service_host>",
            port: "<mongodb_service_port>"
        }
    },
}, { 
    provider: provider 
});

// Step 4: Export the endpoint of the Tyk Dashboard service
// If your service is of type LoadBalancer, then you can export the endpoint
export const tykDashboardEndpoint = tykDashboardChart.getResourceProperty("v1/Service", "tyk-dashboard-tyk-dashboard", "status")
    .apply(status => status.loadBalancer.ingress[0].ip || status.loadBalancer.ingress[0].hostname);

In this program we do the following:

We use oci.containerservice.getCluster to fetch information about your OKE cluster, including the kubeconfig, which is needed to interact with the cluster using the Kubernetes provider.
We then instantiate a new Kubernetes provider that Pulumi uses to deploy resources into the OKE cluster.
Following that, we deploy the Tyk Dashboard Helm chart by creating a k8s.helm.v3.Chart resource. Replace <chart_version> with the version of the Tyk Dashboard Helm chart you wish to install.
We provide the official Tyk Helm chart repository URL, which Pulumi uses to fetch and deploy the Helm chart.
We export the tykDashboardEndpoint, which would allow us to access the Tyk Dashboard service once it is up and running.

Keep in mind that you might need to customize the Helm chart values based on the Tyk Dashboard configuration you desire. This includes connecting to MongoDB, configuring access settings, and so forth. You can add those custom values into the values field of the Helm chart resource.

This should get you started with deploying the Tyk Dashboard on the OKE. Make sure your Pulumi stack is set up correctly to run this program successfully.