savannahostrowski / jupyter-mercury-aca

📈 A web application used for hosting, sharing and interacting with Jupyter Notebooks via Mercury, hosted on Azure Container Apps.

A web application for sharing interactive Jupyter notebooks using Mercury

This is a skeleton repo/template/blueprint that renders runnable, interactive Jupyter Notebooks in the browser using Mercury via Azure Container Apps.

It includes:

• Application code in the src/ directory (really just a sample Jupyter Notebook, generated by Mercury)
• Infrastructure as Code (in the /infra directory), written in Bicep, that provision Azure resources and specify how to deploy the code on Azure

Prerequisites

• Azure Developer CLI
• Python (3.9+)
• Docker

Quickstart

The fastest way for you to get this application up and running on Azure is to use the azd up command. This single command will create and configure all necessary Azure resources - including access policies and roles for your account and service-to-service communication with Managed Identities.

1. Open a terminal, create a new empty folder, and change into it.
2. Create a new Python virtual environment (optional but highly recommended)
3. Run the following command to initialize the project, provision Azure resources, and deploy the application code.

azd init --template savannahostrowski/jupyter-mercury-aca
azd up

At the end of this step, you'll be able to visit a URL to see the web app + the Jupyter notebooks in src/.

How to modify this template to make it your own!

In the src/ directory, you'll find a sample notebook generated by Mercury. You can remove this file and replace it with your own Jupyter notebook(s). Remember to pip install the Python package dependencies for any notebooks you add to the app and pip freeze > requirements.txt to save the deps (this is important for installing the deps in the container)! Whenever, you're ready, re-run azd deploy to redeploy the code to the resources on Azure!

Don't have an Azure subscription?

In order to use this template, you'll need an Azure subscription. If you don't already have one, you can sign up for a free account here.

Other resources

• More about the Azure Developer CLI - aka.ms/azd
• Find other templates on the Azure Developer CLI template gallery - aka.ms/awesome-azd

jupyter-mercury-aca's Issues

Make sure monitoring is working

Execution history is broken

Intermittently cannot navigate to previous runs (404s) + also toggles don't take effect (also the dropdown to navigate disappears?)

'applicationsInsight' provisioning is missing and causing `azd up` to fail

This error is showing up during the provisioning process:

ERROR: deployment failed: failing invoking action 'provision', error deploying infrastructure: deploying to subscription:

Deployment Error Details:
ResourceNotFound: The Resource 'Microsoft.Insights/components/appi-h4z5s5dlksjbe' under resource group 'rg-qdrant' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix

I'll create a PR to fix it soon.

Remove Bicep reference library to keep things simple

Update architecture diagram

keyvault?
monitoring?

Redeploy code should use `azd deploy` in `Readme.md`

Describe the issue:
Section link
Redeploy the code should use azd deploy.

Suggestion:
Update azd up to azd deploy

@savannahostrowski for notification.

Make sure pipeline config works

Updating/work-with this template for Azd Devcontainer feature.

We are updating this template to support new features in Azd Devcontainer.

For the Azd Devcontainer feature: We will add the following code in devcontainer.json file.

"ghcr.io/azure/azure-dev/azd:latest": {}

@rajeshkamal5050 , @savannahostrowski for notification.

Missing license file

I didn't find one in root, maybe need a link if not there?

VSCode support

local run and debug configurations
devcontainer definition