Deploy the opendistro-es helm chart on Linode Kubernetes Engine

Question

Pulumi · Accepted Answer

To deploy the Opendistro for Elasticsearch (a community-driven, open source fork of Elasticsearch) using Helm on the Linode Kubernetes Engine (LKE), these are the steps and the corresponding Pulumi TypeScript program to achieve it.

Prerequisites

Before using this Pulumi program you need:

A Linode account with an active Kubernetes cluster.
kubectl configured to connect to your Kubernetes cluster.
Helm CLI installed.
Pulumi CLI installed and authenticated with an account.
Node.js and TypeScript installed to run the Pulumi program.

Introduction to Pulumi and Helm

Pulumi is an infrastructure as code tool that allows you to declare cloud resources using familiar programming languages. One of Pulumi's strengths is its ability to use Helm charts to deploy applications on Kubernetes clusters.

Helm is a package manager for Kubernetes that packages multiple Kubernetes resources into a single logical deployment unit called a Helm chart. Using Pulumi, we can deploy Helm charts on any Kubernetes cluster, including Linode Kubernetes Engine.

The Pulumi Program

The program below uses the Pulumi Kubernetes provider to deploy a Helm chart. We'll specify the Opendistro Elasticsearch Helm chart using the kubernetes.helm.v3.Chart resource.

Here's a detailed breakdown of the Pulumi TypeScript code that you can use to deploy the opendistro-es Helm chart to a Kubernetes cluster running on Linode:

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

// Create an instance of the Kubernetes provider linked to the Linode Kubernetes Engine.
const provider = new k8s.Provider('lke_k8s_provider', {
    kubeconfig: '<YOUR_KUBECONFIG_CONTENTS>',
});

// Deploy the opendistro-es chart using the `Chart` resource from the Pulumi Kubernetes provider.
// Replace `chartOptions` with the required configuration for the opendistro-es Helm chart.
// Note: The `kubeconfig` passed to the provider needs to have the necessary permissions to deploy the chart.
const opendistroESChart = new k8s.helm.v3.Chart('opendistro-es', {
    chart: 'opendistro-es', // The name of the chart.
    version: '<HELM_CHART_VERSION>', // Specify the version of the Helm chart to use.
    fetchOpts: {
        // Optionally, specify the Helm repository.
        repo: 'https://opendistro.github.io/for-elasticsearch/'
    },
    namespace: 'default', // The Kubernetes namespace to deploy the chart into.
    values: {
        // Set the values for the Helm chart here.
        // These values should be configured according to your specific needs.
        // For example:
        elasticsearch: {
            replicas: 3,
            minimumMasterNodes: 2,
        },
        // Add other value overrides here based on the opendistro-es Helm chart's `values.yaml`
    }
}, { provider });

// Export the necessary endpoints such as the Kibana endpoint.
// For an actual deployment, you would likely need to export other endpoints as well.
export const kibanaEndpoint = opendistroESChart.getResourceProperty('v1/Service', 'opendistro-es-kibana', 'status')
.then(status => status.loadBalancer.ingress[0].ip);

Replace <YOUR_KUBECONFIG_CONTENTS> with the contents of your kubeconfig file which you get from your Linode account. This will authenticate Pulumi with your LKE cluster. The <HELM_CHART_VERSION> is the version of the Opendistro Elasticsearch Helm chart you wish to deploy. You can find the latest version in the Helm repository for Opendistro Elasticsearch.

The fetchOpts property is used to specify the Helm repository URL where the chart is located. The values property is where you can specify the chart configuration options to fit your needs based on the values.yaml file provided by the opendistro-es Helm chart.

To find the actual configuration options and the latest Helm chart version, you should refer to the official Opendistro Elasticsearch Helm chart documentation or repository.

Running the Program

Save the above TypeScript code to a file such as index.ts, set up your Pulumi stack (if you haven't already), and run the following commands:

pulumi up

This command will start the deployment process managed by Pulumi. If you have everything configured correctly, Pulumi will communicate with Linode Kubernetes Engine to deploy Opendistro Elasticsearch. Once done, the Kibana endpoint IP address will be exported, which you can use to access the Kibana interface and interact with Elasticsearch.