Implement proper Jupyter kernel defaulting and configuration

simonkurtz-MSFT · simonkurtz-MSFT · commit e18e280acbc2 · 2025-06-11T08:17:39.000-04:00
- Replaced ineffective jupyter.kernels.filter with notebook.defaultKernel setting
- Added notebook.kernelProviderAssociations to ensure APIM kernel is preferred
- Updated all 14 existing notebooks with correct kernelspec metadata
- Created update-notebook-kernels.py script for automated kernel metadata updates
- Added apim-samples.code-workspace for consistent workspace configuration
- Enhanced verification script with detailed kernel checking and validation
- Improved post-start-setup.sh kernel registration with better error handling

This ensures zero-configuration Jupyter experience where:
- Only the APIM Samples Python 3.12 kernel is visible and auto-selected
- All notebooks default to the correct venv kernel automatically
- No manual kernel selection required in Codespaces or local development
diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json
@@ -65,6 +65,15 @@
         "jupyter.askForKernelRestart": false,
         "jupyter.interactiveWindow.textEditor.executeSelection": true,
         "jupyter.notebookFileRoot": "${workspaceFolder}",
+        "notebook.defaultKernel": "apim-samples",
+        "jupyter.kernels.trusted": [
+          "/workspaces/Apim-Samples/.venv/bin/python"
+        ],
+        "notebook.kernelProviderAssociations": {
+          "**/*.ipynb": [
+            "apim-samples"
+          ]
+        },
         "files.associations": {
           "*.bicep": "bicep"
         }
diff --git a/.devcontainer/post-start-setup.sh b/.devcontainer/post-start-setup.sh
@@ -106,7 +106,7 @@ if jupyter kernelspec list | grep -q "apim-samples" 2>/dev/null; then
     echo "      APIM Samples Kernel: ✅"
 else
     echo "      APIM Samples Kernel: ❌ (registering...)"
-    python -m ipykernel install --user --name=apim-samples --display-name="APIM Samples Python 3.12" 2>/dev/null || echo "      ⚠️  Failed to register kernel"
+    python -m ipykernel install --user --name=apim-samples --display-name="APIM Samples Python 3.12" 2>/dev/null && echo "      ✅ Kernel registered successfully" || echo "      ⚠️  Failed to register kernel"
 fi
 
 # Test core imports
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -22,16 +22,15 @@
     "jupyter.askForKernelRestart": false,
     "jupyter.interactiveWindow.textEditor.executeSelection": true,
     "jupyter.notebookFileRoot": "${workspaceFolder}",
-    "jupyter.kernels.filter": [
-        "/usr/bin/python3",
-        "/bin/python3",
-        "/usr/local/bin/python3",
-        "/opt/python/*/bin/python*",
-        "*/site-packages/*"
-    ],
+    "notebook.defaultKernel": "apim-samples",
     "jupyter.kernels.trusted": [
         "/workspaces/Apim-Samples/.venv/bin/python"
     ],
+    "notebook.kernelProviderAssociations": {
+        "**/*.ipynb": [
+            "apim-samples"
+        ]
+    },
     "terminal.integrated.env.windows": {
         "PATH": "${env:PATH}"
     },
diff --git a/apim-samples.code-workspace b/apim-samples.code-workspace
@@ -0,0 +1,31 @@
+{
+    // Workspace configuration for APIM Samples
+    "folders": [
+        {
+            "path": "."
+        }
+    ],
+    "settings": {
+        // Default kernel for all notebooks in this workspace
+        "notebook.defaultKernel": "apim-samples",
+        
+        // Kernel associations to ensure our kernel is preferred
+        "notebook.kernelProviderAssociations": {
+            "**/*.ipynb": [
+                "apim-samples"
+            ]
+        },
+        
+        // Trust our venv kernel
+        "jupyter.kernels.trusted": [
+            "/workspaces/Apim-Samples/.venv/bin/python"
+        ],
+        
+        // Python configuration for the workspace
+        "python.defaultInterpreterPath": "/workspaces/Apim-Samples/.venv/bin/python",
+        "python.pythonPath": "/workspaces/Apim-Samples/.venv/bin/python",
+        "python.terminal.activateEnvironment": true,
+        "python.terminal.activateEnvInCurrentTerminal": true,
+        "python.envFile": "${workspaceFolder}/.env"
+    }
+}
diff --git a/infrastructure/afd-apim/clean-up.ipynb b/infrastructure/afd-apim/clean-up.ipynb
@@ -27,9 +27,9 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": ".venv",
+   "display_name": "APIM Samples Python 3.12",
    "language": "python",
-   "name": "python3"
+   "name": "apim-samples"
   },
   "language_info": {
    "codemirror_mode": {
@@ -46,4 +46,4 @@
  },
  "nbformat": 4,
  "nbformat_minor": 2
-}
+}
diff --git a/infrastructure/afd-apim/create.ipynb b/infrastructure/afd-apim/create.ipynb
@@ -268,9 +268,9 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": ".venv",
+   "display_name": "APIM Samples Python 3.12",
    "language": "python",
-   "name": "python3"
+   "name": "apim-samples"
   },
   "language_info": {
    "codemirror_mode": {
@@ -287,4 +287,4 @@
  },
  "nbformat": 4,
  "nbformat_minor": 2
-}
+}
diff --git a/infrastructure/apim-aca/clean-up.ipynb b/infrastructure/apim-aca/clean-up.ipynb
@@ -27,9 +27,9 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": ".venv",
+   "display_name": "APIM Samples Python 3.12",
    "language": "python",
-   "name": "python3"
+   "name": "apim-samples"
   },
   "language_info": {
    "codemirror_mode": {
@@ -46,4 +46,4 @@
  },
  "nbformat": 4,
  "nbformat_minor": 2
-}
+}
diff --git a/infrastructure/apim-aca/create.ipynb b/infrastructure/apim-aca/create.ipynb
@@ -139,9 +139,9 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": ".venv",
+   "display_name": "APIM Samples Python 3.12",
    "language": "python",
-   "name": "python3"
+   "name": "apim-samples"
   },
   "language_info": {
    "codemirror_mode": {
@@ -158,4 +158,4 @@
  },
  "nbformat": 4,
  "nbformat_minor": 2
-}
+}
diff --git a/infrastructure/simple-apim/clean-up.ipynb b/infrastructure/simple-apim/clean-up.ipynb
@@ -27,9 +27,9 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": ".venv",
+   "display_name": "APIM Samples Python 3.12",
    "language": "python",
-   "name": "python3"
+   "name": "apim-samples"
   },
   "language_info": {
    "codemirror_mode": {
@@ -46,4 +46,4 @@
  },
  "nbformat": 4,
  "nbformat_minor": 2
-}
+}
diff --git a/infrastructure/simple-apim/create.ipynb b/infrastructure/simple-apim/create.ipynb
@@ -119,9 +119,9 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": ".venv",
+   "display_name": "APIM Samples Python 3.12",
    "language": "python",
-   "name": "python3"
+   "name": "apim-samples"
   },
   "language_info": {
    "codemirror_mode": {
@@ -138,4 +138,4 @@
  },
  "nbformat": 4,
  "nbformat_minor": 2
-}
+}
diff --git a/samples/_TEMPLATE/create.ipynb b/samples/_TEMPLATE/create.ipynb
@@ -132,9 +132,9 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": ".venv",
+   "display_name": "APIM Samples Python 3.12",
    "language": "python",
-   "name": "python3"
+   "name": "apim-samples"
   },
   "language_info": {
    "codemirror_mode": {
@@ -151,4 +151,4 @@
  },
  "nbformat": 4,
  "nbformat_minor": 2
-}
+}
diff --git a/samples/authX-pro/create.ipynb b/samples/authX-pro/create.ipynb
@@ -204,9 +204,9 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": ".venv",
+   "display_name": "APIM Samples Python 3.12",
    "language": "python",
-   "name": "python3"
+   "name": "apim-samples"
   },
   "language_info": {
    "codemirror_mode": {
@@ -223,4 +223,4 @@
  },
  "nbformat": 4,
  "nbformat_minor": 2
-}
+}
diff --git a/samples/authX/create.ipynb b/samples/authX/create.ipynb
@@ -174,9 +174,9 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": ".venv",
+   "display_name": "APIM Samples Python 3.12",
    "language": "python",
-   "name": "python3"
+   "name": "apim-samples"
   },
   "language_info": {
    "codemirror_mode": {
@@ -193,4 +193,4 @@
  },
  "nbformat": 4,
  "nbformat_minor": 2
-}
+}
diff --git a/samples/general/create.ipynb b/samples/general/create.ipynb
@@ -130,9 +130,9 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": ".venv",
+   "display_name": "APIM Samples Python 3.12",
    "language": "python",
-   "name": "python3"
+   "name": "apim-samples"
   },
   "language_info": {
    "codemirror_mode": {
@@ -149,4 +149,4 @@
  },
  "nbformat": 4,
  "nbformat_minor": 2
-}
+}
diff --git a/samples/load-balancing/create.ipynb b/samples/load-balancing/create.ipynb
@@ -226,9 +226,9 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": ".venv",
+   "display_name": "APIM Samples Python 3.12",
    "language": "python",
-   "name": "python3"
+   "name": "apim-samples"
   },
   "language_info": {
    "codemirror_mode": {
@@ -245,4 +245,4 @@
  },
  "nbformat": 4,
  "nbformat_minor": 2
-}
+}
diff --git a/samples/secure-blob-access/create.ipynb b/samples/secure-blob-access/create.ipynb
@@ -287,9 +287,9 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": ".venv",
+   "display_name": "APIM Samples Python 3.12",
    "language": "python",
-   "name": "python3"
+   "name": "apim-samples"
   },
   "language_info": {
    "codemirror_mode": {
@@ -306,4 +306,4 @@
  },
  "nbformat": 4,
  "nbformat_minor": 5
-}
+}
diff --git a/shared/jupyter/verify-az-account.ipynb b/shared/jupyter/verify-az-account.ipynb
@@ -49,9 +49,9 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": ".venv",
+   "display_name": "APIM Samples Python 3.12",
    "language": "python",
-   "name": "python3"
+   "name": "apim-samples"
   },
   "language_info": {
    "codemirror_mode": {
@@ -68,4 +68,4 @@
  },
  "nbformat": 4,
  "nbformat_minor": 5
-}
+}
diff --git a/test-environment.ipynb b/test-environment.ipynb
@@ -150,9 +150,23 @@
  ],
  "metadata": {
   "language_info": {
-   "name": "python"
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.12.10"
+  },
+  "kernelspec": {
+   "display_name": "APIM Samples Python 3.12",
+   "language": "python",
+   "name": "apim-samples"
   }
  },
  "nbformat": 4,
  "nbformat_minor": 5
-}
+}
diff --git a/update-notebook-kernels.py b/update-notebook-kernels.py
diff --git a/verify-devcontainer.py b/verify-devcontainer.py
