Deploy the devlake helm chart on AWS EKS

Question

Pulumi · Accepted Answer

To deploy the DevLake Helm chart on AWS EKS, you'll need to take the following steps:

1. **Set up an EKS Cluster**: You'll first need to provision an EKS cluster, which is where your applications will run.
2. **Install and Configure Helm**: Next, you'll need to install Helm on your local machine or wherever you perform your deployments, and then configure it to work with your EKS cluster.
3. **Deploy the Helm Chart**: Finally, using Helm, you will deploy the DevLake Helm chart to your EKS cluster.

Below is a detailed Pulumi program written in TypeScript that accomplishes these steps. The program includes:

- Importing necessary packages
- Creating an EKS cluster
- Configuring the Kubeconfig
- Deploying the Helm chart

Please ensure you have set up `aws` CLI with the necessary permissions and configured `pulumi` CLI with your desired Pulumi account. Your AWS credentials should be appropriately configured to create these resources.

### Detailed Pulumi Program

```typescript
import * as pulumi from '@pulumi/pulumi';
import * as awsx from '@pulumi/awsx';
import * as eks from '@pulumi/eks';
import * as k8s from '@pulumi/kubernetes';

// Create an EKS cluster.
const cluster = new eks.Cluster('my-cluster', {
    desiredCapacity: 2,
    minSize: 1,
    maxSize: 2,
    instanceType: 't2.medium',
    providerCredentialOpts: {
        profileName: 'aws-profile', // Replace with your AWS CLI profile name
    },
});

// Export the clusters' kubeconfig.
export const kubeconfig = cluster.kubeconfig;

// Create a Kubernetes provider instance that uses our cluster from above.
const provider = new k8s.Provider('my-provider', {
    kubeconfig: cluster.kubeconfig.apply(JSON.stringify),
});

// Deploy the DevLake Helm chart to the EKS cluster using the Helm provider.
const devLakeChart = new k8s.helm.v3.Chart('devlake', {
    chart: 'devlake',
    version: 'desired-chart-version', // Specify the version of DevLake Helm chart
    fetchOpts: {
        repo: 'https://helm-repository-url/', // Replace with the DevLake Helm repository URL
    },
    values: {
        service: {
            type: 'LoadBalancer',
        },
        // Define other values required for the DevLake chart
    },
}, { provider: provider });

// When using custom values from a file (e.g., values.yaml), you can read the file and pass it to the 'values' property:
// const devLakeChart = new k8s.helm.v3.Chart('devlake', {
//     chart: 'devlake',
//     values: pulumi.output(require('fs').readFileSync('path-to-your-values.yaml').toString()).apply(yaml => JSON.parse(yaml)),
//     ...
// }, { provider: provider });

// Export any of the values that the Helm chart exposes for easy access.
export const devLakeEndpoint = devLakeChart.getResourceProperty('v1/Service', 'devlake-devlake', 'status').apply(status => status.loadBalancer.ingress[0].hostname);
```

This program uses the `@pulumi/eks` library to create an EKS cluster (`eks.Cluster`). Make sure to replace `'aws-profile'` with the name of your AWS CLI profile and specify your desired instance type and the size of the cluster.

It also assumes that you have the `@pulumi/kubernetes` library installed in order to work with Kubernetes resources and Helm charts.

The `kubeconfig` exported by the program will allow you to manually interact with your Kubernetes cluster using `kubectl` if necessary.

The `devLakeChart` object represents the DevLake Helm chart. Replace `'desired-chart-version'` with the version number of the chart you wish to deploy and `'https://helm-repository-url/'` with the URL of the Helm repository that hosts the DevLake chart.

After running this program with `pulumi up`, the DevLake application will be deployed to the EKS cluster.

### Additional Notes

- Helm charts often have numerous configurable parameters. You should check the documentation of the DevLake Helm chart for the parameters that you can configure and add them to the `values` if necessary.

- Ensure that the Docker images used by DevLake Helm chart are available for your Kubernetes nodes. If they are hosted in a private container registry, you will need to set up image pull secrets in Kubernetes.

- This program assumes that you're deploying the Helm chart with the default values. If you have a `values.yaml` file that you need to use for the deployment, you can read the content of the file into the `values` property. There's a commented-out section in the program where you'd use it for that purpose.

- The EKS cluster setup in this example is minimal for illustration; depending on your actual needs, you may want to customize the EKS cluster further.