Alan AI Helm installation package¶

Below is a description of the contents of the installation package:

Package Structure¶

The installation package includes the following key files and folders:

Alan AI Helm package¶

alan-ai-chart/
├── cfg/
|  ├── <project>-development
|  ├── certs
|  |   ├── alan_local.crt
|  |   ├── alan_local.key
|  ├── alan_dialog_sa_key.json
|  ├── alan_models_sa_key.json
|  ├── alan_tutor_sa_key.json
|  ├── alan-common-config.yml
|  ├── openai_key.txt
├── scripts
|  ├── \_<project>_vars.sh
|  ├── local-delete-alan-pods.sh
|  ├── local-helm-install.sh
|  ├── local-helm-uninstall.sh
└── README.md
└── CHANGEOG.md

cfg/<project>-development/¶

The folder contains the following files and folders:

cert: Alan AI certificates
alan_dialog_sa_key.json, alan_models_sa_key.json, alan_tutor_sa_key.json, openai_key.txt: API keys required for Alan AI Cloud to function properly
Alan-common-config.yml: a file containing all the configurable Alan AI Cloud features and their respective settings. By default, most functionality is disabled.

For details, see Alan AI configuration.

scripts¶

The folder contains installation scripts and deployment-related variables:

\_<project>_vars.sh: a script that sets up all needed deployment-related variables. For details, see Alan AI configuration.
local-delete-alan-pods.sh: a script that deletes all Alan AI Cloud pods from the local Kubernetes cluster. Needed for troubleshooting and redeploying in some cases.
local-helm-install.sh: a script that installs Alan AI Cloud to the local Kubernetes cluster.
local-helm-uninstall.sh: a script that uninstalls Alan AI Cloud from the local Kubernetes cluster.

README and CHANGELOG¶

The files describe the installation process and the history of changes to the installation package.