Managing clusters and cluster groups↑

You can follow the steps in the following demo video or follow the the instructions in the following sections to use the various CAEPE features.

This guide shows you how to manage clusters and cluster groups from the CAEPE account portal. You can access the configuration section from the Configuration -> Clusters menu item.

Viewing clusters↑

You can see the clusters associated with your account in the center of the page.

You can switch the view of the clusters between a "list" and "grid" view and filter the clusters by clicking the Filters button. You can filter by cluster name, status, and type.

For every cluster in the list, click the pencil icon to edit the cluster or the wastebasket icon to delete it.

Cluster details↑

Click the View Cluster link next to any cluster to see more details about the cluster including the name, type, groups, connection details, and any past and present applications deployed to the cluster.

You can also create deployment schedules from the cluster details page and perform pre-checks or cleanup tasks on the cluster.

You can also edit and delete the cluster from the details page.

Viewing cluster groups↑

You can see the cluster groups associated with your account in the center of the page.

You can switch the view of the cluster groups between a "list" and "grid" view and filter the cluster groups by clicking the Filters button. You can filter by cluster group name, status, and association.

Connect to live cluster↑

Connect a cluster by clicking the New Cluster button.

You can connect to a currently live cluster. Click Connect to Live Cluster button, and click Next

In the form that appears, set a name and description for the cluster and a region.

Set the cluster type based on where the cluster is running. CAEPE supports clusters running on multiple Kubernetes providers, including:

• Amazon EKS
• Azure AKS
• Google GKE
• Lightweight Kubernetes (K3s) running on private clusters and on-premises
• Kubernetes running on private clusters and on-premises
• OCI Container Engine for Kubernetes
• Rancher Kubernetes engine

Set the environment type based on how you intend to use the cluster. The options are:

• Development
• Production
• QA
• Staging
• Smoke test
• UAT
• Others

Set the infrastructure type based on how the cluster is hosted. The options are:

• Edge
• On-Prem
• Cloud
• Airgapped

Click Next.

Kubeconfig↑

For the connection details you can connect by uploading a kube config file for the cluster

Kubectl for GKE K8s/K3s↑

This section explains how to connect a Google Kubernetes Engine (GKE) K8s or K3s cluster to CAEPE using kubectl

Connect a GKE K8s cluster via kubectl↑

1. Complete the form, ensure - Cluster Type: K8s-Kubernetes is selected and click Next.
2. Select Kubectl, then click Next.
3. Click Connect Cluster.

4. Copy the generated curl command displayed after creation .

   

5. Run the curl command copied from Step 4, but save it to a file first:

   curl <cluster-creation-command> > agent1.yml
   

6. Apply the configuration file:

   KUBECONFIG=./kubeconfig kubectl apply -f agent1.yml
   

7. Wait for the cluster to appear as Healthy in the CAEPE. You can also verify manually:

   kubectl get pods -n caepe-system
   

   Once connected:

   • The GKE cluster appears under Clusters in CAEPE with status Healthy.
   • Applications can be deployed and monitored directly through the Web App.

Connect a GKE K3s cluster via kubectl↑

1. Complete the form, ensure - Cluster Type: K3s-Lightweight Kubernetes is selected and click Next.
2. Select Kubectl, then click Next.
3. Click Connect Cluster.

4. Copy the generated curl command displayed after creation .

   

5. Connect to the target node via SSH using the following command:

   ssh -i $PATH_TO_PEM_FILE azureuser@<node-ip>
   

6. Switch to root:

   sudo -i 
   

7. Navigate to the working directory.

8. Use the copied curl command and modify it to save output to a file:

   # Replace this:
   # | kubectl apply -f -
   # With this:
   curl <cluster-creation-command> > agent1.yml
   

9. Verify the file was created successfully and with valid content:

   cat agent1.yml
   

   10. Apply the configuration using the relevant K3s kubeconfig:

   KUBECONFIG=./kubeconfig-arm-1.yaml kubectl apply -f agent1.yml
   

10. Wait for the cluster to appear as Healthy in the CAEPE Web App. You can also check directly from the node:

    kubectl get nodes
    kubectl get pods --all-namespaces
    

    Deploy a test application (e.g., Webshop) from the CAEPE Web App to confirm successful connection and workload deployment

Build and connect a live cluster↑

If you choose the Build cluster and connect option, the creation form shows the various options for building a cluster, these are:

• Run a shell script
• An Ansible playbook
• A Terraform definition file
• An AWS CloudFormation template
• An Azure Cloud Resource Manager template
• A GCP Deployment Manager template

After selecting the build method, in the next step add a name and description for the cluster and the cluster, environment, and infrastructure type. You can also watch the cluster for changes and use a notification integration to send notifications when the cluster state changes.

Select the snapshot location or create a new snapshot location

Use the next section to add playbooks to run on creation and teardown of a cluster. This example uses Anisble. You host these scripts in repositories defined in the Application source -> Repositories section and they should contain the appropriate resource type to match the build option you selected.

After creation steps↑

When you create a cluster you can add it to a logical grouping of clusters. You can select a pre-existing group, or create a new one.

When the Pods are ready, the cluster shows in the list with a "Healthy" state.

Create a cluster group↑

Create a cluster group by clicking the New Cluster Group button.

In the form that appears, set a name and description for the cluster group and select the clusters to add to the group. You can select a pre-existing cluster, or create a new one.