Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
sr-remsha authored Jun 12, 2024
1 parent 9a9b320 commit 3180d18
Showing 1 changed file with 24 additions and 7 deletions.
31 changes: 24 additions & 7 deletions charts/dial/examples/generic/simple/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,14 +20,35 @@

## 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.\
**Important Warning**

Please note that this guide **does not use a persistent disk** for data storage.\
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.

**Scope**

By following the instructions in this guide, you will install the AI DIAL system with the selcted minimal configurations (defined in the [values.yaml](values.yaml) file) of the following components: AI DIAL Core, AI DIAL Chat, AI DIAL Chat Themes and a connection to the Azure GPT-3.5 API.

## What's next?

Having installed the system with minimal settings and a limited scope of features, you can go further and learn how to create a custom [Configuration](https://docs.epam-rail.com/Deployment/configuration) and add more components.

Refer to a repository of each component to view a full set of configuration parameters and guidelines:

* [Core](https://github.com/epam/ai-dial-core)
* [Chat](https://github.com/epam/ai-dial-chat)
* [Chat Themes](https://github.com/epam/ai-dial-chat-themes)
* [Assistant](https://github.com/epam/ai-dial-assistant)
* [Auth Helper](https://github.com/epam/ai-dial-auth-helper)
* Adapters
* [OpenAI](https://github.com/epam/ai-dial-adapter-openai)
* [Bedrock](https://github.com/epam/ai-dial-adapter-bedrock)
* [Vertex](https://github.com/epam/ai-dial-adapter-vertexai)

## Install

1. Create Kubernetes namespace, e.g. `dial`
1. Create a Kubernetes namespace, e.g. `dial`

**Command:**

Expand Down Expand Up @@ -67,7 +88,7 @@ Configuring authentication provider, encrypted secrets, model usage limits, Ingr
- Replace `%%AZURE_MODEL_KEY%%` with Azure OpenAI Model Key from [prerequisites](#prerequisites), e.g. `3F0UZREXNOTAREALKEYDCvzSkznPFa`
- 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:
2. Install `dial` helm chart in created namespace, applying a custom values.yaml file:

**Command:**

Expand Down Expand Up @@ -126,7 +147,3 @@ Configuring authentication provider, encrypted secrets, model usage limits, Ingr
```console
namespace "dial" deleted
```
## What's next?
- [Configuration](https://docs.epam-rail.com/Deployment/configuration)

0 comments on commit 3180d18

Please sign in to comment.