Deploy the cloudbeaver helm chart on Rancher

Question

Pulumi · Accepted Answer

To deploy the CloudBeaver Helm chart on a Rancher-managed Kubernetes cluster using Pulumi, you need to install the pulumi-rancher2 package, which allows Pulumi to interact with Rancher's API. After installing the package, you can use its resources to manage your Rancher setup within a Pulumi program.

The following Pulumi program uses TypeScript, and it performs these steps:

Sets up a new Kubernetes cluster on Rancher (this assumes you want to create a new cluster; if you have an existing cluster, you'd use its ID instead).
Installs the CloudBeaver Helm chart into the cluster.

Below is the full Pulumi TypeScript program that performs these actions:

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

// Step 1: Set up a new Kubernetes cluster on Rancher
// Note: Adjust the cluster configuration to match your environment and requirements.
const cluster = new rancher2.Cluster("my-cluster", {
    // Replace these attributes with your specific cluster details or preferences
    // For a full list of Cluster parameters, check the documentation:
    // https://www.pulumi.com/registry/packages/rancher2/api-docs/cluster/
    name: "my-cluster",
    description: "Cluster for deploying CloudBeaver",
    rkeConfig: {
        // You would define your RKE (Rancher Kubernetes Engine) config here
        // This includes network plugin, services (etcd, kube-api, etc.), and other settings
    },
    // Other cluster configuration settings like cloud provider, Kubernetes version, etc.
});

// Step 2: Deploy the CloudBeaver Helm chart
// Wrap the Helm chart deployment in a call to `.apply()` which ensures it doesn't run until after
// the cluster is ready.
cluster.id.apply(clusterId => {
    // Set up the Kubernetes provider to deploy Helm charts to the Rancher cluster
    const k8sProvider = new kubernetes.Provider("k8sProvider", {
        kubeconfig: pulumi.secret(cluster.kubeConfigRaw),
    });

    // Deploy the CloudBeaver Helm chart using the K8s provider configured to point at our cluster
    const cloudbeaverChart = new kubernetes.helm.v3.Chart("cloudbeaver", {
        // Replace with the actual repository that hosts the CloudBeaver chart
        // Most Helm charts are hosted on public repositories, such as Helm Hub,
        // or private registries that you may use within your organization.
        chart: "cloudbeaver",
        // Specify the Helm repository here
        // If the chart is from a repository, you may need to add that repository to your Helm configuration
        // and reference it by name, using the `fetchOpts` property
        fetchOpts: {
            repo: "https://<repository_url>",
        },
        // Version of the CloudBeaver Helm chart you want to deploy
        version: "x.y.z",
        // Values to override in the CloudBeaver Helm chart values.yaml file
        // This is where you would specify any CloudBeaver-specific configuration you need
        values: {
            // Custom values for CloudBeaver deployment
        },
    }, { provider: k8sProvider });

    // Export the Kubernetes cluster name and the CloudBeaver application URL if available
    // This information can be used to access the cluster and application after deployment
    return {
        clusterName: cluster.name,
        // Depending on how CloudBeaver is exposed (e.g., LoadBalancer, NodePort, Ingress), the exact application URL may differ
        // You may need to configure an Ingress resource or get the LoadBalancer IP to form the complete URL
        cloudBeaverApplicationUrl: cloudbeaverChart.getResourceProperty("v1/Service", "<cloudbeaver-service-name>", "status").apply(status => {
            // Construct the application URL using the LoadBalancer IP or other means
            // This is a placeholder for the actual logic you would use
            return `http://${status.loadBalancer.ingress[0].ip}:<exposed-port>`;
        }),
    };
});

In the program above:

We create a Kubernetes cluster resource using Rancher's RKE configuration. In a real-world scenario, you'd replace this configuration with details specific to your Rancher environment and your Kubernetes configuration needs.
Next, we use cluster.id.apply(clusterId => {...}) to ensure we first wait for the cluster to be created. The code inside .apply() only runs once the id of the cluster is known.
We create a new instance of kubernetes.Provider using the kubeconfig from the cluster which is marked as a secret since it contains sensitive information.
We deploy the CloudBeaver Helm chart to the cluster using the kubernetes.helm.v3.Chart class. It requires the chart name and version, along with any custom values you wish to override. The fetchOpts is used to specify the Helm repository where the CloudBeaver chart is stored.
Lastly, we export the cluster name and a placeholder for the CloudBeaver application URL. To get the actual CloudBeaver URL, you'd use the LoadBalancer IP or another access method based on how CloudBeaver is exposed.

Please replace the placeholders with actual values that are applicable to your environment, such as repository URL, chart version, service name, and how you expose services in your Kubernetes cluster.