Skip to content

Commit

Permalink
Solved issue 5: Improve documentation removing manual steps and updat…
Browse files Browse the repository at this point in the history
…ing architecture diagram (#56)

* - Removed `Manual steps` from documentation in `infra/README.md`.
* Updated deployment instructions in main documentation.
* Updated image for High-Level Design.
* Added Visio file with the new HLD.
* Minor tweak.
  • Loading branch information
rliberoff authored Jun 4, 2024
1 parent 5171865 commit 08956e4
Show file tree
Hide file tree
Showing 4 changed files with 30 additions and 31 deletions.
Binary file added assets/HLD v0.2.vsdx
Binary file not shown.
57 changes: 30 additions & 27 deletions docs/content/en/docs/Deployment/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,39 +10,42 @@ The following diagram shows the high-level architecture of the **AI Hub** soluti

![High-level Architecture](/aihub/img/AI-Hub-HLD.png)

### Create a new resource group
```bash
az group create --name aihub-rg --location westeurope
```
### Create a new storage account
```bash
az storage account create --name aihubstorage --resource-group aihub-rg --location westeurope --sku Standard_LRS
```
## Deployment

### Create a new app service plan
```bash
az appservice plan create --name aihub-appservice --resource-group aihub-rg --sku S1
```
To deploy the AI Hub on your own Azure subscription, please follow these instructions.

### Create a new web app using dot net 8
```bash
az webapp create --name aihub-webapp --resource-group aihub-rg --plan aihub-appservice --runtime "DOTNET|8.0"
```
### Prerequisites

### Create an Azure multi service cognitive service account
```bash
az cognitiveservices account create --name aihub-cognitiveservice --resource-group aihub-rg --kind CognitiveServices --sku S0 --location westeurope --yes
```
Before deploying the Azure AI Hub, please ensure the following prerequisites are met:

- Please review the values in the `variables.tf` file to create the appropriate `.tfvars` file with the values you prefer. Take into account that some elements in the architecture are optional, like for example private endpoints which by default are not deployed unless the value of the `use_private_endpoints` variable is set to `true`.
- You have Azure CLI version `2.56.0` or higher installed, or using the Azure Cloud Shell.
- During deployment, the script will create two application registrations on Microsoft Entra ID. Please verify that your user account has the necessary privileges.
- The Azure AI Hub uses various cognitive services like Azure Computer Vision, Azure Speech Service or Azure Document Intelligence. To deploy these Cognitive Services, you must manually accept the "Responsible AI" terms. This can currently only be done by deploying any of these services from the Azure Portal.


### Deploying the infrastructure - From Windows

Run the following command to deploy the infrastructure:

### Create an Azure OpenAI resource
```bash
az openai create --name aihub-openai --resource-group aihub-rg --location westeurope
az login
az account set -s <target subscription_id or subscription_name>
powershell -Command "iwr -useb https://raw.githubusercontent.com/azure/aihub/master/install/install.ps1 | iex"
```

### Create a Content Safety Cognitive Service
### Deploying the infrastructure - From Linux

For installation on Linux, we recommend using `Ubuntu 22.04` or a newer version. Before executing the installation script, ensure that the following applications are installed and up-to-date:

- `curl`, version `7.x` or higher.
- `jq`, version `1.6` or higher.
- `unzip`, version `6.x` or higher.

To deploy the infrastructure, execute the following command:

```bash
az cognitiveservices account create --name aihub-contentsafety --resource-group aihub-rg --kind ContentSafety --sku F0 --location westeurope
az login
az account set -s <target subscription_id or subscription_name>
bash -c "$(curl -fsSL https://raw.githubusercontent.com/azure/aihub/master/install/install_linux.sh)"
```

### Configure the web app
As a last step, we need to configure the web app to use the storage account and the cognitive service account we created earlier. To do this, we need to rename appsettings.json.template file to appsettings.json and replace the placeholders with the values we got from the previous steps.
Binary file modified docs/static/img/AI-Hub-HLD.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 0 additions & 4 deletions infra/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,3 @@ az login
az account set -s <target subscription_id or subscription_name>
bash -c "$(curl -fsSL https://raw.githubusercontent.com/azure/aihub/master/install/install_linux.sh)"
```

## Manual steps

For details on manual deployment, please refer to the [Deployment](https://azure.github.io/aihub/docs/deployment/) section in the Azure AI Hub documentation.

0 comments on commit 08956e4

Please sign in to comment.