data-api-builder icon indicating copy to clipboard operation
data-api-builder copied to clipboard

Provide recommended hosting options based on workload

Open Aniruddh25 opened this issue 1 year ago • 3 comments

For given workload/customer requirements -> provide suggestions/link to docs for how to get up and running. e.g. Container apps, azure app service, On-premises IIS

Aniruddh25 avatar Feb 22 '24 05:02 Aniruddh25

This is a great idea. I think we should start with articles on how-to deploy to different services (ACA/ACI/SWA/AppService/On-prem) and then create this article with guidance on which to pick and links to how-to guides.

Work on the how-to guides is ongoing and this can be started as soon as those are finalized.

seesharprun avatar May 15 '24 14:05 seesharprun

Tracking the pre-req #2053

seesharprun avatar May 15 '24 14:05 seesharprun

Now that the pre-reqs are resolved. Work can start on this task.

I recommend that we create a sequential "deployment guide."

  1. Deployment overview article
  2. Prep article (get your connection credentials, set up Entra ID, get anything else you need)
  3. Choose the best article (choose Azure or self-hosted, choose appropriate Azure service)
  4. Deployment article (one of the recently published deployment articles)
  5. Monitoring article (how to review logs post-deployment)

The deployment guide will both appear in our current TOC, but it will also have it's own URI and TOC so you can link to it directly (ex: https://learn.microsoft.com/azure/data-api-builder/deploy)

seesharprun avatar May 15 '24 21:05 seesharprun

This deployment guide has been merged in to the documentation repo and it will be live soon.

This should be enough to resolve this request.

Down the road, I recommend we add this content:

  • Self-hosted guidance to the "choose a hosting option" page
  • A how-to guide to deploy to a self-hosted solution (NGINX or IIS)
  • A how-to guide to deploy to Azure Kubernetes Service

seesharprun avatar Jun 10 '24 15:06 seesharprun