Prerequisites

Page content

• Prerequisites
  • Prerequisites for unix-based OS
  • Prerequisites for Windows users
• Login into your Azure Tenant
• Download workshop repository from GitHub
• Docker
  • Build docker image
  • Run docker container
  • Exec into the docker container
• Set environment variables
• Create Azure resource group

Prerequisites

• Azure subscription, and permission to create and access following Azure resources:

  • Azure Resource Groups
  • Azure OpenAI
  • Azure AI Search
  • Azure Storage Account
  • Azure App Service & Azure Functions
  • Azure Monitor Application Insights

• Azure CLI

  • Note: Ensure the az bicep extension is installed. You can install it by running:
    📋 Copy

    
    az bicep install
    

• Docker

• Git

For Windows users only

If you’re on Windows, install:

• WSL with Ubuntu distro
• Azure CLI installed inside Ubuntu
• Docker installed inside Ubuntu
• Git installed inside Ubuntu

From this point forward, all steps and commands in this workshop will assume you are working on a Unix-based operating system. If you are using Windows, please open an Ubuntu terminal and ensure your environment is ready to execute the commands provided in the upcoming sections.

Login into your Azure Tenant

az login --tenant "your-tenant-id-here"

Download workshop repository from GitHub

Clone the repo and cd into project’s root directory.

git clone https://github.com/Azure-Samples/azure-open-ai-rag-oyd-text-images
cd azure-open-ai-rag-oyd-text-images

Build docker image

This repository includes a Dockerfile that builds a Docker image containing all the necessary tools and dependencies required to successfully complete this workshop. Using this Docker image ensures a consistent and hassle-free environment for following the steps.

To build the Docker image for this workshop, run the following command in the terminal.

bash ./helper.sh docker-build

Run docker container

Now that the Docker image is built, you can run a container from this image. The container is configured to use a Docker volume to share your Azure authentication token between your local environment and the container. This setup enables you to execute commands inside the container and create Azure resources within your Azure subscription seamlessly.

bash ./helper.sh docker-run

Exec into the docker container

Finally, access the Docker container interactively. From this point forward, all commands and steps for the workshop should be executed inside the Docker container.

bash ./helper.sh docker-exec

Validate you’re running inside the docker container. The command pwd should return /home/ubuntu/azure-open-ai-rag-oyd-text-images.

pwd

Set environment variables

To streamline the workshop, we’ll use a local file named helper.sh to gather and load environment variables that will be utilized throughout the session. Load the default environment variables to get started.

Note: If you close your terminal (i.e., exit the Docker container) and open a new one, you’ll need to re-run the command to reload the environment variables.

source helper.sh

Validate environment variables are loaded successfully. The command echo “${region}” should return region=“eastus”.

echo "${region}"

Create Azure resource group

Create an Azure resource group to host all the resources required for this workshop.

az group create --name "${resource_group_name}" --location "${region}"

« Workshop Overview | Document Data Management: Overview »