Alan AI Cloud deployment

Alan AI is a cloud-agnostic, Kubernetes-based solution distributed as a Helm chart. The Helm chart encapsulates all necessary Kubernetes resources, defines required dependencies, and manages the configuration of all Alan AI Cloud components.

System Requirements

Operating Systems

  • Linux:

    • Bit version: 64-bit

    • OS version:

      • Ubuntu: LTS version Ubuntu Jammy Jellyfish 22.04, or the current non-LTS version (Ubuntu Mantic Minotaur 23.10) or later

      • Debian: 12 or later

      • Red Hat Enterprise: RHEL 8 or later

      • Fedora: 39 or later

  • macOS:

    • Bit version: 64-bit

    • OS version: 10.15 (Catalina) or later

Software

Component

Recommended version

Kubernetes

1.30+

Docker

26.0+

Helm

3.15+

Hardware Requirements (Kubernetes Nodes)

  • CPU: Minimum 2 CPU cores (Recommended 4+ cores)

  • Memory: Minimum 4 GB RAM (Recommended 8+ GB RAM)

  • Storage: Minimum 16 GB free disk space

Prerequisites

Before installing the Alan AI Cloud, make sure the following prerequisites are met:

  • Docker Desktop: You can download and install Docker Desktop from the official Docker website.

  • A running Kubernetes cluster: To learn how to enable the Kubernetes cluster in Docker Desktop, refer to the Docker documentation.

  • Helm: Helm CLI installed. You can download and install Helm from the official Helm website.

  • (For Linux OS) kubectl: Kubernetes command-line tool to interact with your cluster. To learn how to download and install kubectl for Linux, refer to the Kubernetes documentation.

Installing the Alan AI Cloud locally

To install the Alan AI Cloud:

  1. Currently, the Alan AI installation package is available upon request. Contact the Alan AI team to obtain the most recent installation package.

  2. Extract the installation package from the archive to a location on the target machine.

  3. In the terminal, go to the folder containing the installation scripts.

  4. Run the following command to install the Alan AI Helm chart into the Kubernetes cluster:

    Terminal
    ./scripts/local-helm-install.sh

Validation

To make sure the installation was successful:

  1. In the terminal, run the following command:

    Terminal
    kubectl get pods

  2. Make sure the status for all pods is ready and running:

    Terminal
    % kubectl get pods

NAME                          READY   STATUS    RESTARTS
<project>-alan-dialog-175     1/1     Running   0
<project>-alan-dialog-176     1/1     Running   0
...

  3. In a web browser, navigate to https://127.0.0.1/login to access Alan AI Studio.

Uninstalling the Alan AI Cloud

To uninstall the Alan AI Cloud:

  1. In the terminal, go to the directory where the installation package was extracted.

  2. Run the following command to uninstall the Alan AI Helm chart from the Kubernetes cluster:

    Terminal
    ./scripts/local-helm-uninstall.sh

  3. If the Helm uninstall process has failed, run the following command to delete Alan AI pods:

    Terminal
    ./scripts/local-delete-alan-pods.sh

  4. Repeat step 2 above.