Deploy the helm-amq-broker helm chart on Rancher

Question

Pulumi · Accepted Answer

Deploying a Helm chart on a Kubernetes cluster managed by Rancher involves several steps, including setting up a `Cluster` where the Helm chart will be deployed, adding repositories (catalogs) which contain the Helm chart, and finally deploying the Helm chart itself.

Below, I provide a Pulumi program written in TypeScript to achieve this. The program demonstrates how to set up a Kubernetes cluster in Rancher, add a catalog, and deploy the `helm-amq-broker` Helm chart.

Please note that this is a conceptual demonstration that assumes you have existing Rancher credentials and an existing Kubernetes cluster managed by Rancher. For simplicity, the program simulates interacting with these resources rather than creating them anew. In a real-world scenario, you would need to connect to your actual Rancher setup and provide real identifiers for things like clusters and namespaces.

### Detailed Program Explanation

1. **Setup Rancher2 Provider**: We will set up a Rancher2 provider, which allows us to interact with a Rancher server. We need to configure it with the access credentials and Rancher server URL which are assumed to be already available to you.

2. **Create a Catalog**: A Rancher catalog (CatalogV2) is a set of Helm chart repositories that Rancher can access. We will add a new catalog, which includes the repository where the `helm-amq-broker` Helm chart is located.

3. **Deploy Helm Chart**: We will deploy the Helm chart from the repository that we added to the Rancher catalog. We'll specify the necessary details like chart name, chart version, and any required values.

Now, let's look at the actual Pulumi TypeScript program that performs the above steps.

```typescript
import * as rancher2 from "@pulumi/rancher2";

// Create a Rancher2 provider instance with the appropriate credentials.
// These should be securely stored and retrieved, for example, via Pulumi Config or environment variables.
const rancherProvider = new rancher2.Provider("rancher", {
    apiUrl: "https://rancher.your-domain.com/v3",  // Replace with your Rancher API URL
    accessKey: "xxxx",  // Replace with your access key
    secretKey: "xxxx",  // Replace with your secret key
});

// Assuming we have an existing cluster managed by Rancher, referenced by its ID.
const clusterId = "c-xxxxx";  // Replace with your actual cluster ID

// Create a catalog for the helm-amq-broker chart repository.
const catalog = new rancher2.CatalogV2("amq-broker-catalog", {
    clusterId: clusterId,
    name: "amq-broker",  // A user-defined name for the catalog
    url: "https://repository-url/for/amq-broker",  // Replace with the actual repo URL
    gitRepo: "https://github.com/actual/repo/for/amq-broker",  // Replace with the actual Git repo
    gitBranch: "master",  // Specify the branch if needed
    enabled: true,  // Enable this catalog
}, { provider: rancherProvider });

// Deploy the helm-amq-broker chart on the cluster within Rancher.
const amqBrokerHelmChart = new rancher2.HelmChart("amq-broker-helm-chart", {
    // Associate with the cluster ID where you want to deploy the chart.
    clusterId: clusterId,
    // Specify the namespace where the chart will reside, assuming it already exists.
    namespace: "helm-amq-broker-namespace",  // Replace with your actual namespace
    // Define the information about the helm chart.
    chartName: "amq-broker",
    repo: "amq-broker",  // Reference the name of the catalog created earlier
    kubernetes: { name: catalog.name },  // Use the name of the catalog as a reference
    values: "",  // Add required custom values YAML as a string, if necessary
    version: "1.0.0",  // Specify the version of the helm chart if necessary
    forceUpdate: true,
}, { provider: rancherProvider, dependsOn: [catalog] });

// Export the name of the cluster where the AMQ Broker will be deployed
export const deployedCluster = clusterId;
// Export the namespace where the AMQ Broker will be deployed
export const deployedNamespace = amqBrokerHelmChart.namespace;
```

In this program:

- Replace placeholder values like `https://rancher.your-domain.com/v3`, `xxxx` for keys, and `c-xxxxx` for `clusterId` with actual values from your Rancher environment.
- Update `https://repository-url/for/amq-broker` and the Git repo URL to the locations where the `helm-amq-broker` chart is hosted.
- Specify the correct namespace for deployment in `namespace`.

After running this Pulumi program, it will deploy the `helm-amq-broker` Helm chart on the specified cluster within Rancher. You can check the Rancher UI or use command-line tools to confirm that the deployment was successful.