-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Co-authored-by: Aleksey <[email protected]>
- Loading branch information
1 parent
6a70f28
commit 030338e
Showing
13 changed files
with
596 additions
and
38 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,136 @@ | ||
| # AI DIAL AKS Installation Simple Guide | ||
|
|
||
| - [AI DIAL AKS Installation Simple Guide](#ai-dial-aks-installation-simple-guide) | ||
| - [Prerequisites](#prerequisites) | ||
| - [Expected Outcome](#expected-outcome) | ||
| - [Install](#install) | ||
| - [Uninstall](#uninstall) | ||
| - [What's next?](#whats-next) | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| - AKS 1.24+ | ||
| - [kubectl](https://kubernetes.io/docs/tasks/tools/#kubectl) installed and configured | ||
| - [Helm](https://helm.sh/docs/intro/install/) `3.8.0+` installed | ||
| - [NGINX Ingress controller](https://docs.nginx.com/nginx-ingress-controller/installation/) installed in the cluster | ||
| - [cert-manager](https://cert-manager.io/docs/installation/) installed in the cluster (optional) | ||
| - [external-dns](https://github.com/kubernetes-sigs/external-dns) installed in the cluster (optional) | ||
| - [Azure AD Workload Identity](https://azure.github.io/azure-workload-identity/docs/introduction.html) | ||
| - [Azure Blob storage](https://learn.microsoft.com/en-us/azure/storage/blobs/storage-blobs-overview) | ||
| - [Azure OpenAI](https://learn.microsoft.com/en-us/azure/ai-services/openai/overview) `gpt-35-turbo` model deployed: | ||
| - [Azure Model Deployment Guide](https://docs.epam-rail.com/Deployment/OpenAI%20Model%20Deployment) | ||
|
|
||
| ## Expected Outcome | ||
|
|
||
| By following the instructions in this guide, you will successfully install the AI DIAL system with configured connection to the Azure GPT-3.5 API.\ | ||
| Please note that this guide represents a very basic deployment scenario, and **should never be used in production**.\ | ||
| Configuring authentication provider, encrypted secrets, model usage limits, Ingress allowlisting and other security measures are **out of scope** of this guide. | ||
|
|
||
| ## Install | ||
|
|
||
| 1. Create Kubernetes namespace, e.g. `dial` | ||
|
|
||
| **Command:** | ||
|
|
||
| ```sh | ||
| kubectl create namespace dial | ||
| ``` | ||
|
|
||
| **Output:** | ||
|
|
||
| ```console | ||
| namespace/dial created | ||
| ``` | ||
|
|
||
| 1. Add Helm chart repository | ||
|
|
||
| **Command:** | ||
|
|
||
| ```sh | ||
| helm repo add dial https://charts.epam-rail.com | ||
| ``` | ||
|
|
||
| **Output:** | ||
|
|
||
| ```console | ||
| "dial" has been added to your repositories | ||
| ``` | ||
|
|
||
| 1. Copy [values.yaml](values.yaml) file to your working directory and fill in missing values: | ||
| - Replace `%%NAMESPACE%%` with namespace created above, e.g. `dial` | ||
| - Replace `%%DOMAIN%%` with your domain name, e.g. `example.com` | ||
| - Replace `%%DIAL_API_KEY%%` with generated value (`pwgen -s -1 64`) | ||
| - Replace `%%CORE_ENCRYPT_PASSWORD%%` with generated value (`pwgen -s -1 32`) | ||
| - Replace `%%CORE_ENCRYPT_SALT%%` with generated value (`pwgen -s -1 32`) | ||
| - Replace `%%NEXTAUTH_SECRET%%` with generated value (`openssl rand -base64 64`) | ||
| - Replace `%%REDIS_PASSWORD%%` with generated value (`pwgen -s -1 32`) | ||
| - Replace `%%AZURE_MODEL_ENDPOINT%%` with Azure OpenAI Model Endpoint from [prerequisites](#prerequisites), e.g. `https://not-a-real-endpoint.openai.azure.com/openai/deployments/gpt-35-turbo/chat/completions` | ||
| - Replace `%%AZURE_MODEL_KEY%%` with Azure OpenAI Model Key from [prerequisites](#prerequisites), e.g. `3F0UZREXNOTAREALKEYDCvzSkznPFa` | ||
| - Replace `%%AZURE_CORE_CLIENT_ID%%` with managed identity client ID from [prerequisites](#prerequisites) | ||
| - Replace `%%AZURE_CORE_BLOB_STORAGE_NAME%%` with Azure Blob storage name from [prerequisites](#prerequisites) | ||
| - Replace `%%AZURE_CORE_BLOB_STORAGE_ENDPOINT%%` with Azure Blob storage endpoint from [prerequisites](#prerequisites) | ||
| - It's assumed you've configured **external-dns** and **cert-manager** beforehand, so replace `%%CLUSTER_ISSUER%%` with your cluster issuer name, e.g. `letsencrypt-production` | ||
|
|
||
| 2. Install `dial` helm chart in created namespace, applying custom values file: | ||
|
|
||
| **Command:** | ||
|
|
||
| ```sh | ||
| helm install dial dial/dial -f values.yaml --namespace dial | ||
| ``` | ||
|
|
||
| **Output:** | ||
|
|
||
| ```console | ||
| Release "dial" does not exist. Installing it now. | ||
| NAME: dial | ||
| LAST DEPLOYED: Thu Nov 30 16:35:54 2023 | ||
| NAMESPACE: dial | ||
| STATUS: deployed | ||
| REVISION: 1 | ||
| TEST SUITE: None | ||
| NOTES: | ||
| CHART NAME: dial | ||
| CHART VERSION: 1.0.0 | ||
| APP VERSION: 1.0 | ||
| ** Please be patient while the chart is being deployed ** | ||
| ``` | ||
| 3. Now you can access: | ||
| - Chat by the following URL: `https://chat.%%DOMAIN%%/`, e.g. `https://chat.example.com/` | ||
| - API by the following URL: `https://dial.%%DOMAIN%%/`, e.g. `https://dial.example.com/` | ||
| - Use previously generated `%%DIAL_API_KEY%%` value | ||
| ## Uninstall | ||
| 1. Uninstall `dial` helm chart from created namespace | ||
| **Command:** | ||
| ```sh | ||
| helm uninstall dial --namespace dial | ||
| ``` | ||
| **Output:** | ||
| ```console | ||
| release "dial" uninstalled | ||
| ``` | ||
| 1. Delete Kubernetes namespace, e.g. `dial` | ||
| **Command:** | ||
| ```sh | ||
| kubectl delete namespace dial | ||
| ``` | ||
| **Output:** | ||
| ```console | ||
| namespace "dial" deleted | ||
| ``` | ||
| ## What's next? | ||
| - [Configuration](https://docs.epam-rail.com/Deployment/configuration) |
Oops, something went wrong.