Add README instructions

.env.example

@@ -0,0 +1,6 @@
+OPENAI_API_KEY=sk-xxxxxxxxxxxxxxxx
+HF_TOKEN_PATRICK=hf_xxxxxxxxxxxxxxxxx
+ZOTERO_LIBRARY_ID=1120xxxx
+ZOTERO_API_ACCESS_KEY=Ky5RGxxxxxxxxxxxxxxxxxx
+GRADIO_URL_=http://gradio:7860/
+

.gitignore

@@ -177,3 +177,5 @@ data/
 study_export_*
 study_files.db
 study_files.json
+
+infra/ecs_config_new.toml

Dockerfile.api.prod

@@ -2,8 +2,10 @@
 # BUILDER #
 ###########
 
+ARG AWS_ACCOUNT_ID
+
 # pull official base image
-FROM 224427659724.dkr.ecr.us-east-1.amazonaws.com/gradio-python:3.11.10-slim as builder
+FROM ${AWS_ACCOUNT_ID}.dkr.ecr.us-east-1.amazonaws.com/gradio-python:3.11.10-slim as builder
 
 # set work directory
 WORKDIR /app
@@ -27,8 +29,10 @@ RUN pip wheel --no-cache-dir --no-deps --wheel-dir /app/wheels -r requirements.t
 # FINAL #
 #########
 
+ARG AWS_ACCOUNT_ID
+
 # pull official base image
-FROM 224427659724.dkr.ecr.us-east-1.amazonaws.com/gradio-python:3.11.10-slim
+FROM ${AWS_ACCOUNT_ID}.dkr.ecr.us-east-1.amazonaws.com/gradio-python:3.11.10-slim
 
 # create directory for the app user
 RUN mkdir -p /home/backend-app

README.md

@@ -10,4 +10,177 @@ pinned: false
 license: apache-2.0
 ---
 
-Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+
+
+# ACRES RAG Project
+
+## Project Setup
+
+To test and run the project locally. Clone the project from github and change directoory to `acres`.
+
+```sh
+git clone https://github.com/SunbirdAI/acres.git
+cd acres
+```
+
+Create python virtual environment and activate it.
+
+```sh
+python -m venv env
+source env/bin/activate
+```
+
+Install project dependencies
+
+```sh
+pip install -r requirements.txt
+```
+
+## Run project locally
+To test the project locally follow the steps below.
+
+Copy `.env.example` to `.env` and provide the correct enviroment variable values.
+
+```sh
+cp .env.example .env
+```
+
+Run the application
+
+```sh
+python app.py
+```
+
+OR
+
+```sh
+gradio app.py
+```
+
+Browse the application with the link `http://localhost:7860/`
+
+
+## Run with docker
+To run the application with docker locally, first make sure you have docker installed. See [link](https://docs.docker.com/)
+
+Build the project docker image
+
+```sh
+docker build -f Dockerfile.gradio -t gradio-app .
+```
+
+Create docker network
+
+```sh
+docker network create gradio-fastapi-network
+```
+
+Run the docker container 
+
+```sh
+docker run -it -p 7860:7860 --rm --name gradio --network=gradio-fastapi-network gradio-app
+```
+
+Browse the application with the link `http://localhost:7860/`
+
+
+## Deploy to AWS ECS (Elastic Container Service) with Fargate
+
+Install and configure the AWS CLI and aws credentials. See [link](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-welcome.html)
+
+OR: See the pdf document [here](./aws-cli.pdf)
+
+Now follow the steps below to deploy to AWS ECS
+
+Setup the default region and your aws account id
+
+```sh
+export AWS_DEFAULT_REGION=region # i.e us-east-1, eu-west-1
+export AWS_ACCOUNT_ID=aws_account_id # ie. 2243838xxxxxx
+```
+
+Login into the AWS ECR (Elastic Container Registry) via the commandline
+
+```sh
+aws ecr get-login-password --region $AWS_DEFAULT_REGION | docker login --username AWS --password-stdin "$AWS_ACCOUNT_ID.dkr.ecr.$AWS_DEFAULT_REGION.amazonaws.com
+```
+
+Create a python image and push to ECR. This image will be used as the base image for the application image deployed on AWS ECS.
+
+- Create python repository
+
+```sh
+aws ecr create-repository \
+  --repository-name gradio-python \
+  --image-tag-mutability MUTABLE
+```
+
+```sh
+export ECR_PYTHON_URL="$AWS_ACCOUNT_ID.dkr.ecr.$AWS_DEFAULT_REGION.amazonaws.com/gradio-python"
+echo $ECR_PYTHON_URL
+```
+
+- Pull python image and tag it to the ECR url
+
+```sh
+docker pull python:3.11.10-slim
+docker tag python:3.11.10-slim $ECR_PYTHON_URL:3.11.10-slim
+
+docker push $ECR_PYTHON_URL:3.11.10-slim
+```
+
+- Now create application repostory
+
+```sh
+aws ecr create-repository \
+  --repository-name gradio-app-prod \
+  --image-tag-mutability MUTABLE
+
+export ECR_BACKEND_GRADIO_URL="$AWS_ACCOUNT_ID.dkr.ecr.$AWS_DEFAULT_REGION.amazonaws.com/gradio-app-prod"
+echo $ECR_BACKEND_GRADIO_URL
+```
+
+- Build the docker image for the production and push to ECR
+
+```sh
+docker build --build-arg AWS_ACCOUNT_ID=$AWS_ACCOUNT_ID -f Dockerfile.gradio.prod -t gradio-app-prod .
+docker tag gradio-app-prod:latest "${ECR_BACKEND_GRADIO_URL}:latest"
+docker push "${ECR_BACKEND_GRADIO_URL}:latest"
+```
+
+### Setup and Provision AWS ECS infra using AWS Cloudformation (IaC)
+
+#### Install
+To install the CFN-CLI run the command below
+
+```sh
+pip install cloudformation-cli cloudformation-cli-java-plugin cloudformation-cli-go-plugin cloudformation-cli-python-plugin cloudformation-cli-typescript-plugin
+```
+
+#### CFN-Toml
+
+```sh
+gem install cfn-toml
+```
+
+
+Copy `infra/ecs_config.template` to `infra/ecs_config.toml` and provide the correct `AWS Account ID` for the `ContainerImageGradio`
+
+```sh
+cp infra/ecs_config.template infra/ecs_config.toml
+```
+
+
+#### Deploy
+
+To deploy the ECS infra run the commands below. It provisions the cloudformation stack changeset for review. 
+
+Log into your aws console and search for `cloudformation`. See and review the changeset. If everything is good execute the changeset to finish with the infra deployment.
+
+Then look for the outputs to the link for the deployed application.
+
+```sh
+chmod u+x bin/cfn/*
+./bin/cfn/ecs-deploy
+```

commands.md

@@ -6,7 +6,7 @@ docker run -it -p 7860:7860 --rm --name gradio --network=gradio-fastapi-network
 
 
 export AWS_DEFAULT_REGION=us-east-1
-export AWS_ACCOUNT_ID=224427659724
+export AWS_ACCOUNT_ID=2244276xxxxx
 aws ecr get-login-password --region $AWS_DEFAULT_REGION | docker login --username AWS --password-stdin "$AWS_ACCOUNT_ID.dkr.ecr.$AWS_DEFAULT_REGION.amazonaws.com"
 
 aws ecr create-repository \
@@ -29,8 +29,10 @@ aws ecr create-repository \
 export ECR_BACKEND_GRADIO_URL="$AWS_ACCOUNT_ID.dkr.ecr.$AWS_DEFAULT_REGION.amazonaws.com/gradio-app-prod"
 echo $ECR_BACKEND_GRADIO_URL
 
-
+docker build --build-arg AWS_ACCOUNT_ID=2244276xxxxx -t your-image-name .
 docker build -f Dockerfile.gradio.prod -t gradio-app-prod .
+
+docker build --build-arg AWS_ACCOUNT_ID=$AWS_ACCOUNT_ID -f Dockerfile.gradio.prod -t gradio-app-prod .
 docker tag gradio-app-prod:latest "${ECR_BACKEND_GRADIO_URL}:latest"
 docker push "${ECR_BACKEND_GRADIO_URL}:latest"
 
@@ -49,21 +51,3 @@ docker build -f Dockerfile.api.prod -t fastapi-api-prod .
 docker tag fastapi-api-prod:latest "${ECR_BACKEND_FASTAPI_URL}:latest"
 docker push "${ECR_BACKEND_FASTAPI_URL}:latest"
 
-
-Now how can I configure the two load balancers such that I can just access them without providing the ports
-
-fastapi
-
-
-```
-http://dev-acres-fastapi-alb-1793670355.us-east-1.elb.amazonaws.com:8000/
-```
-
-http://dev-acres-gradio-alb-1860302806.us-east-1.elb.amazonaws.com/
-
-gradio
-
-
-```
-http://dev-acres-gradio-alb-1860302806.us-east-1.elb.amazonaws.com:7860/
-```

infra/ecs_config.template

@@ -0,0 +1,7 @@
+[deploy]
+bucket = 'dev-acres-gradio-bucket'
+region = 'us-east-1'
+stack_name = 'AcresRag'
+
+[parameters]
+ContainerImageGradio = '224427659xxxx.dkr.ecr.us-east-1.amazonaws.com/gradio-app-prod:latest'

infra/ecs_config.toml

@@ -1,9 +0,0 @@
-[deploy]
-bucket = 'dev-acres-gradio-bucket'
-region = 'us-east-1'
-stack_name = 'AcresRag'
-
-[parameters]
-ContainerImageGradio = '224427659724.dkr.ecr.us-east-1.amazonaws.com/gradio-app-prod:latest'
-ContainerImageFastAPI = '224427659724.dkr.ecr.us-east-1.amazonaws.com/fastapi-api-prod:latest'
-CertificateArn = 'arn:aws:acm:us-east-1:224427659724:certificate/37ae35a9-60d1-4ff2-8afc-07f0d6000e75'