\r\n\r\n# V1\r\n# launch the app\r\nuvicorn main:app --reload\r\n\r\n# in a browser you can check type URL\r\nhttp:\/\/127.0.0.1:8000\r\nhttp:\/\/localhost:8000\r\n# I have declared in my hosts file cypress.mydomain.priv pointed to 127.0.0.1\r\nhttp:\/\/cypress.mydomain.priv:8000\r\n\r\n# ctrl+c to stop the server\r\n\r\n# V2\r\n# launch the app\r\nuvicorn main:app --host 0.0.0.0 --port 80 --reload\r\n\r\n# in a browser you can check type URL\r\nhttp:\/\/127.0.0.1\r\nhttp:\/\/localhost\r\n# I have declared in my hosts file cypress.mydomain.priv pointed to 127.0.0.1\r\nhttp:\/\/cypress.mydomain.priv\r\n\r\n\r\n# See more at https:\/\/fastapi.tiangolo.com\/deployment\/manually\/\r\n<\/pre>\n4.3. Using Docker<\/H3><\/p>\n
Before the deployment in itself on Azure, it is better to run locally this new API you just build with the help of Docker.<\/p>\n
\r\n\r\n# get into the dir\r\ncd \/Users\/brunoflaven\/Documents\/03_git\/ia_usages\/ia_deploy_api_ml_architecture\/simple-app-fastapi-azure\r\n\r\n# START with increment the tags e.g test1, test2, test3... etc\r\n\r\n# build the Docker image named \"bf-fastapi-demo:test2\"\r\ndocker build --tag bf-fastapi-demo:test2 .\r\n# The application Docker has to be up and running\r\n\r\n# run a container named \"test2-bf-fastapi-container\". It is an instance of an image named \"bf-fastapi-demo:test1\"\r\ndocker run -d --name test2-bf-fastapi-container -p 80:80 bf-fastapi-demo:test2\r\n\r\n# The Dockerfile tells FastAPI to use a port of 80, so the run command publishes the container's port 80 as port 80 on the local computer. I visit localhost:80 to confirm that my API is up and running. 🏃🏽♀️\r\n\r\n# check the app locally\r\nhttp:\/\/localhost:80\r\n\r\n# list the images\r\ndocker ps\r\n\r\n# stop the container test2-bf-fastapi-container\r\ndocker stop test2-bf-fastapi-container\r\n\r\n# remove the container test2-bf-fastapi-container\r\ndocker rm -f test2-bf-fastapi-container\r\n\r\n\r\n# remove the image with bf-fastapi-demo:test2\r\ndocker rmi --force bf-fastapi-demo:test2\r\n\r\n\r\n# END If you change the code, you can restart from START above and redo the commands.\r\n\r\n# NUKE DOCKER IMAGES AND CONTAINERS\r\n# remove all containers\r\ndocker rm -f $(docker ps -aq)\r\n\r\n\r\n\r\n# remove everything\r\ndocker system prune\r\n\r\n<\/pre>\n4.4. Deploying to Azure<\/H3><\/p>\n
Then it is time to play in the big leagues and deploy on Azure your application. One According to me, Deployment has to be treated as non-event for a POC or a real application. It has to occur as much as possible as its is the best way to learn form your errors.<\/p>\n
Here is a list of REQUIRED VALUES that you are going to manipulate. Behind these values you have element that interact with the azure platform. I found handy to make a list to figure out before stating the deployment process all the values required.<\/p>\n
\r\n# Example of model project\r\n# See https:\/\/blog.pamelafox.org\/2023\/03\/deploying-containerized-fastapi-app-to.html\r\n\r\ndocker-image-name = fastapi-demo\r\nregistry-name = pamelascontainerregistry\r\nregistry-server-login-server = pamelascontainerregistry.azurecr.io\r\nresource-group = fastapi-aca-rg\r\ncontainer-registry = application-name = pamelascontainerregistry\r\ncontainer-env = fastapi-aca-env\r\n\r\n# Example for a personal project\r\ndocker-image-name = fastapi-try-demo\r\nregistry-name = maltryappkdo001\r\nlogin-server = maltryappkdo001.azurecr.io\r\nresource-group = fastapi-try-rg\r\ncontainer-registry = application-name = maltryappkdo001\r\ncontainer-env = fastapi-try-env\r\n<\/pre>\n4.1 Push image to registry<\/b><\/H4><\/p>\n
This step is required before publishing any app on Azure. When this step is completed, you do not have to redo this step, you are just updating an existing app, you can jump directly to the point 3.4<\/p>\n
\r\n\r\n# Go to the dir\r\ncd \/Users\/brunoflaven\/Documents\/01_work\/blog_articles\/ia_deploy_api_ml_architecture\/simple-app-fastapi-azure\/\r\n\r\n\r\n# Deploying Option #2: Step-by-step az commands\r\n# STEP_1. check the install\r\naz --version\r\n\r\n# STEP_2. Requirement, you must be logged\r\naz login\r\n\r\n# By default, this command logs in with a user account. CLI will try to launch a web browser to log in interactively. If a web browser is not available, CLI will fall back to device code login. To login with a service principal, specify --service-principal.\r\n\r\n# STEP_3. Create a resource group\r\n# Careful you can reuse an existing one but in this example I created from scratch\r\n# COMMAND MODEL :: az group create --location eastus --name fastapi-aca-rg\r\n\r\n# COMMAND GOOD\r\naz group create --location eastus --name fastapi-try-rg\r\n\r\n# if you need to delete\r\naz group delete --name fastapi-try-rg\r\n\r\n\r\n# STEP_4. Create a container registry wannatrycontainerregistry for the resource group \"fastapi-try-rg\"\r\n\r\n# COMMAND MODEL :: az acr create --resource-group fastapi-aca-rg \\ --name pamelascontainerregistry --sku Basic\r\n\r\n# COMMAND GOOD\r\naz acr create --resource-group fastapi-try-rg --name wannatrycontainerregistry --sku Basic\r\n\r\n\r\n# STEP_5. Log into the registry so that later commands can push images to it:\r\n# COMMAND MODEL :: az acr login --name pamelascontainerregistry\r\n\r\n# COMMAND GOOD\r\naz acr login --name wannatrycontainerregistry\r\n\r\n\r\n\r\n# STEP_6. uploads the code to cloud and builds it there:\r\n# COMMAND MODEL :: az acr build --platform linux\/amd64 -t pamelascontainerregistry.azurecr.io\/fastapi-try:latest -r pamelascontainerregistry .\r\n\r\n# must be in a directory with a Dockerfile\r\n# cd \/Users\/brunoflaven\/Documents\/03_git\/ia_usages\/ia_deploy_api_ml_architecture\/simple-app-fastapi-azure\r\n\r\n# COMMAND GOOD\r\naz acr build --platform linux\/amd64 -t wannatrycontainerregistry.azurecr.io\/fastapi-try:latest -r wannatrycontainerregistry .\r\n\r\n\r\n<\/pre>\n4.2 Deploy to Azure Container App<\/b><\/H4><\/p>\n\r\n\r\n# You must be in the directory of your app \r\n# cd \/Users\/brunoflaven\/Documents\/03_git\/ia_usages\/ia_deploy_api_ml_architecture\/simple-app-fastapi-azure\r\n\r\n\r\n# STEP_1: (OPTIONNAL) Upgrade the extension and register the necessary providers:\r\naz extension add --name containerapp --upgrade\r\naz provider register --namespace Microsoft.App\r\naz provider register -n Microsoft.OperationalInsights --wait\r\n\r\n# STEP_2: Create an environment for the container app:\r\n# COMMAND MODEL :: az containerapp env create --name fastapi-aca-env \\\r\n --resource-group fastapi-aca-rg --location eastus\r\n\r\n# COMMAND GOOD\r\naz containerapp env create --name fastapi-try-env --resource-group fastapi-try-rg --location eastus\r\n\r\n\r\n\r\n# This will output the URL aka defaultDomain e.g : \r\n# orangesmoke-cceb35b3.eastus.azurecontainerapps.io\r\n# purpleground-2c63d040.eastus.azurecontainerapps.io\r\n\r\n\r\n# STEP_3: You must enable the admin:\r\n# Run 'az acr update -n pamelascontainerregistry --admin-enabled true' to enable admin first.\r\n\r\n# COMMAND GOOD\r\naz acr update -n wannatrycontainerregistry --admin-enabled true\r\n\r\n# STEP_4: Generate credentials to use for the next step:\r\n# COMMAND MODEL :: az acr credential show --name pamelascontainerregistry\r\n\r\n# output where you get the password\r\n\r\n# COMMAND GOOD\r\naz acr credential show --name wannatrycontainerregistry\r\n\r\n# OUPUT where you can find the password.\r\n{\r\n \"passwords\": [\r\n {\r\n \"name\": \"password\",\r\n \"value\": \"FAKE+Ubb8iqWTtnDVDZg1ylHcCtHTTogZDt6iULcbKC+XXXXXXXXX\"\r\n },\r\n {\r\n \"name\": \"password2\",\r\n \"value\": \"FAKE+lwCMl71GlToW8YyeAsGaskVE4X8oLE2S8HipB+XXXXXXXXX\"\r\n }\r\n ],\r\n \"username\": \"wannatrycontainerregistry\"\r\n}\r\n\r\n\r\n# STEP_5: Create the container app, passing in the username and password from the credentials:\r\n\r\n# COMMAND MODEL \r\naz containerapp create --name fmm-fastapi-app \\\r\n --resource-group fmm-fastapi-rg \\\r\n --image pamelascontainerregistry.azurecr.io\/fastapi-aca:latest \\\r\n --environment fastapi-aca-env \\\r\n --registry-server pamelascontainerregistry.azurecr.io \\\r\n --registry-username pamelascontainerregistry \\\r\n --registry-password PASSWORD_HERE \\\r\n --ingress external \\\r\n --target-port 80\r\n\r\n# COMMAND GOOD\r\n# Do not forget to replace the password with one show earlier\r\n\r\naz containerapp create --name try-fastapi-app \\\r\n --resource-group try-fastapi-rg \\\r\n --image wannatrycontainerregistry.azurecr.io\/try-fastapi:latest \\\r\n --environment try-fastapi-env \\\r\n --registry-server wannatrycontainerregistry.azurecr.io \\\r\n --registry-username wannatrycontainerregistry \\\r\n --registry-password PASSWORD_HERE \\\r\n --ingress external \\\r\n --target-port 80\r\n\r\n\r\n\r\n# Output you have your f... latestRevisionFqdn where it is the url where the app live ! Bingo\r\n\r\n<\/pre>\n4.3 If you need to clean up everything on Azure<\/b><\/H4><\/p>\n
CAUTION: I like to undo thing or I should even say nuke things. This command is the perfect one, you “kill” all your azure environment from group to app deployed. With great power comes great responsibility.<\/p>\n
\r\n\r\n# CAUTION: with this command, you will remove and clean up everything\r\naz group delete --name try-fastapi-rg\r\n\r\n<\/pre>\n4.4 If you need to update an existing application on Azure<\/b><\/H4>
\nHere the most useful 2 commands as you may change some stuff in your application, every time you want to deploy just perform these 2 commands. You must be in the root application directory and ensure that the application is running locally with Docker.<\/p>\n\r\n# You must be in the directory of your app \r\n# cd \/Users\/brunoflaven\/Documents\/03_git\/ia_usages\/ia_deploy_api_ml_architecture\/simple-app-fastapi-azure\/\r\n\r\n# Do not forget to login if needed. Requirement, you must be logged\r\n# az login\r\n\r\n\r\n# Make any code updates just re-build the image (step_1) and tell the container app to update (step_2):\r\n# COMMAND MODEL :: STEP_1 \r\naz acr build --platform linux\/amd64 \\\r\n -t pamelascontainerregistry.azurecr.io\/fastapi-aca:latest \\\r\n -r pamelascontainerregistry .\r\n\r\n# COMMAND MODEL :: STEP_2\r\naz containerapp update --name fastapi-aca-app \\\r\n --resource-group fastapi-aca-rg \\\r\n --image pamelascontainerregistry.azurecr.io\/fastapi-aca:latest\r\n\r\n\r\n# COMMAND_GOOD_1\r\naz acr build --platform linux\/amd64 \\\r\n -t wannatrycontainerregistry.azurecr.io\/try-fastapi:latest \\\r\n -r wannatrycontainerregistry .\r\n\r\n# COMMAND_GOOD_2\r\naz containerapp update --name try-fastapi-app \\\r\n --resource-group try-fastapi-rg \\\r\n --image wannatrycontainerregistry.azurecr.io\/try-fastapi:latest \r\n\r\n# show the log\r\naz webapp log tail --name wannatrycontainerregistry --resource-group try-fastapi-rg\r\n\r\n# show the group\r\naz group show --name try-fastapi-rg\r\n\r\n\r\n<\/pre>\n4.5 The magic command “all-in-one”<\/b><\/H4>
\nA unique command that “Create or update a container app as well as any associated resources (ACR, resource group, container apps environment, GitHub Actions, etc.).”<\/p>\n\r\n# COMMAND UNIQUE MODEL \r\naz containerapp up \\\r\n -g fastapi-aca-rg \\\r\n -n fastapi-aca-app \\\r\n --registry-server pamelascontainerregistry.azurecr.io \\\r\n --ingress external \\\r\n --target-port 80 \\\r\n --source .\r\n\r\n# CAUTION the registry-server must exist\r\n\r\n# COMMAND_GOOD UNIQUE\r\naz containerapp up \\\r\n -g try-fastapi-rg \\\r\n -n try-fastapi-app \\\r\n --registry-server wannatrycontainerregistry.azurecr.io \\\r\n --ingress external \\\r\n --target-port 80 \\\r\n --source .\r\n<\/pre>\n5. Other infos<\/h2>\n
I just note down few elements on solutions to the obstacles encountered or essential commands. FOMO syndrom?<\/p>\n
5.1 Fixed issue on path on Poetry<\/H3><\/p>\n
I had to solve an issue on path for Poetry, here is what works for me. I always forget the command to edit the bash profile on a Mac.<\/b><\/p>\n\r\n# how-to to get started you need Poetry's bin directory (\/Users\/brunoflaven\/.local\/bin) in your `PATH` as an environment variable.\r\nAdd `export PATH=\"\/Users\/brunoflaven\/.local\/bin:$PATH\"` to your shell configuration file. Alternatively, you can call Poetry explicitly with `\/Users\/brunoflaven\/.local\/bin\/poetry`.\r\n\r\n# check the path\r\necho $PATH\r\n\r\n# Added path to ~\/.zshrc\r\n# edit \r\nsudo vi ~\/.zshrc\r\n\r\n# Save and Update ~\/.zshrc\r\nsource ~\/.zshrc\r\n\r\n# Check PATH\r\necho $PATH\r\n\r\n# You can test that everything is set up by executing:\r\npoetry --version\r\n\r\n<\/pre>\n5.1 Some Docker commands<\/H3>
\nAlways, keep in mind some docker commands that can be useful.<\/b><\/p>\n\r\n\r\n# Enter the following command for details on the containers currently running:\r\ndocker ps\r\n\r\n# Remove all containers\r\ndocker rm -f $(docker ps -aq)\r\n\r\n# Remove docker images\r\ndocker system prune\r\n\r\n# List the containers\r\ndocker ps\r\ndocker container ls\r\ndocker ps \u2013a\r\n\r\n# Stop container #container-id\r\ndocker stop e53c84c9f9d2\r\n\r\n# Below it requires a docker-compose.yml\r\n\r\n# to stop the stack\r\ndocker-compose stop \r\n\r\n# to start the stack\r\ndocker-compose start \r\n<\/pre>\nVideos to tackle this post<\/h2>\n
You can find my WALKTHROUGHS for these 5 videos walkthrough_ia_deploy_api_ml_architecture.diff (Video #1, Video #2, Video #3, Video #4, Video #5)<\/p>\n
Video #1 seamless #fastapi #api #development: From Local Setup with #anaconda to #azure #deployment<\/b><\/p>\n
A quick and basic API building FastAPI to test it locally with anaconda.<\/p>\n