Merge branch 'develop' into typing-hookspecs

.github/ISSUE_TEMPLATE/release-checklist.md

@@ -55,12 +55,16 @@ Release captain responsible - <@gh_username>
 
 ## Cut the official release
 
+_If there were changes to the following packages, handle their releases before cutting a new release for Nebari_
+- [ ] [Cut PyPI release for `nebari-workflow-controller`](https://github.com/nebari-dev/nebari-workflow-controller)
+- [ ] [Cut PyPI release for `argo-jupyter-scheduler`](https://github.com/nebari-dev/argo-jupyter-scheduler)
+
 _These steps must be actioned in the order they appear in this checklist._
 
 - [ ] [Tag, build and push docker images](https://github.com/nebari-dev/nebari-docker-images/releases/new)
 - [ ] [Update and cut release for `nebari-dask` meta package on Conda-Forge.](https://github.com/conda-forge/nebari-dask-feedstock)
 - [ ] [Cut PyPI release via GHA release workflow.](https://github.com/nebari-dev/nebari/releases/new)
   - Avoid appending `v` to tag.
     - Copy release notes from `RELEASE.md`.
-- [ ] Merge release branch into `main`
 - [ ] [Merge automated release PR for `nebari` on Conda-Forge.](https://github.com/conda-forge/nebari-feedstock)
+- [ ] Merge release branch into `main`

.github/ISSUE_TEMPLATE/testing-checklist.md

@@ -18,14 +18,14 @@ However, the following core services still need to be manually validated (until
 
 At minimum, the following services will need to be tested:
 
-- [ ] [Log into keycloak as root user](https://nebari-docs.netlify.app/how-tos/configuring-keycloak#change-keycloak-root-password)
-  - [ ] [Add a user](https://nebari-docs.netlify.app/how-tos/configuring-keycloak#adding-a-nebari-user)
-- [ ] [Log into conda-store and create](https://nebari-docs.netlify.app/tutorials/creating-new-environments)
+- [ ] [Log into keycloak as root user](https://www.nebari.dev/docs/how-tos/configuring-keycloak/#change-keycloak-root-password)
+  - [ ] [Add a user](https://www.nebari.dev/docs/how-tos/configuring-keycloak/#adding-a-nebari-user)
+- [ ] [Log into conda-store and create](https://www.nebari.dev/docs/tutorials/creating-new-environments)
   - [ ] a conda environment in a shared namespace and,
   - [ ] a conda environment in your personal namespace
-- [ ] [Launch dask-gateway cluster, test auto-scaler and](https://nebari-docs.netlify.app/tutorials/using_dask)
-  - [ ] [Validate that the dask-labextention is working](https://nebari-docs.netlify.app/tutorials/using_dask#step-5---viewing-the-dashboard-inside-of-jupyterlab)
-- [ ] [Create a basic CDS Dashboard](https://nebari-docs.netlify.app/tutorials/creating-cds-dashboard)
-- [ ] [Open VS-Code extension](https://nebari-docs.netlify.app/tutorials/using-vscode)
-  - [ ] [Add the Python extension](https://nebari-docs.netlify.app/tutorials/using-vscode#adding-extensions)
-  - [ ] [Create a `.py` file and run it](https://nebari-docs.netlify.app/tutorials/using-vscode#running-python-code)
+- [ ] [Launch dask-gateway cluster, test auto-scaler and](https://www.nebari.dev/docs/tutorials/using_dask)
+  - [ ] [Validate that the dask-labextention is working](https://www.nebari.dev/docs/tutorials/using_dask/#step-4---understand-dasks-diagnostic-tools)
+- [ ] [Confirm that a notebook can be submitted via Jupyter-Scheduler](https://nebari.dev/docs/tutorials/jupyter-scheduler)
+- [ ] [Open VS-Code extension](https://www.nebari.dev/docs/how-tos/using-vscode)
+  - [ ] [Add the Python extension](https://www.nebari.dev/docs/how-tos/using-vscode#adding-extensions)
+  - [ ] [Create a `.py` file and run it](https://www.nebari.dev/docs/how-tos/using-vscode#running-python-code)

.github/workflows/typing.yaml

@@ -0,0 +1,46 @@
+name: "Typing Check"
+
+on:
+  pull_request:
+    paths:
+      - ".github/workflows/typing.yaml"
+      - "src/**"
+      - "pyproject.toml"
+  push:
+    branches:
+      - main
+      - develop
+      - release/\d{4}.\d{1,2}.\d{1,2}
+    paths:
+      - ".github/workflows/typing.yaml"
+      - "src/**"
+      - "pyproject.toml"
+
+jobs:
+  typing-check:
+    runs-on: ubuntu-latest
+    concurrency:
+      group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+      cancel-in-progress: true
+    steps:
+      - name: "Checkout Repository"
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Setup Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.11"
+          cache: "pip"
+
+      - name: Install Nebari and type stubs
+        run: |
+          python --version
+          pip install -e .[dev]
+          pip install types-Pygments types-requests types-six
+
+      - name: Run MyPy
+        continue-on-error: true
+        run: |
+          mypy

README.md

@@ -34,10 +34,12 @@
 - [License](#license)
 
 > **⚠️ Warning ⚠️**
-> The project has recently been renamed from QHub to Nebari. If your deployment is still managed by `qhub`, performing an in place upgrade will **IRREVOCABLY BREAK** your deployment.
-> This will cause you to lose any data stored on the platform, including but not limited to, NFS (file system) data,
-> `conda-store` environments, Keycloak users and groups, etc.
-> Make sure to [back up your data before attempting an upgrade](https://www.nebari.dev/docs/how-tos/manual-backup).
+> The `2023.10.1` release includes the initial implementation of a [Pluggy-based](https://pluggy.readthedocs.io/en/stable/) extension mechanism, for more details refer [here](https://www.nebari.dev/docs/community/plugins).
+> This version also fully deprecates CDS Dashboards as it is no longer compatible with the newer versions of JupyterHub.
+> For more details on all of changes included in this release, please refer to our [release notes](./RELEASE.md).
+> After you've installed version `2023.10.1`, you can update your `nebari-config.yaml` by running `nebari upgrade -c nebari-config.yaml`, please
+> follow the upgrades instructions output by this command.
+> And please make sure to [back up your data before attempting an upgrade](https://www.nebari.dev/docs/how-tos/manual-backup).
 
 Automated data science platform. From [JupyterHub](https://jupyter.org/hub "Multi-user version of the Notebook") to Cloud environments with
 [Dask Gateway](https://docs.dask.org/ "Parallel computing in Python").
@@ -168,10 +170,7 @@ To guarantee a welcoming and friendly community, we require all community member
 
 ## Ongoing Support
 
-The `v0.4.0` release introduced many changes that will irrevocably break your deployment if you attempt an in-place upgrade; for details, see our
-[RELEASE](RELEASE.md#release-v040---march-17-2022) notes. To focus on the future direction of the project, we have decided as a team that we will provide **limited** support for older versions. Any new user is encouraged to use `v0.4.0` or greater.
-
-If you're using an older version of Nebari and would like professional support, please get in touch with the Nebari development team.
+If you're using Nebari and would like professional support, please get in touch with the Nebari development team.
 
 ## License
 

RELEASE.md

@@ -11,6 +11,115 @@ This file is copied to nebari-dev/nebari-docs using a GitHub Action. -->
 
 ## Upcoming Release
 
+
+## Release 2023.10.1 - October 20, 2023
+
+This release includes a major refactor which introduces a Pluggy-based extension mechanism which allow developers to build new stages. This is the initial implementation
+of the extension mechanism and we expect the interface to be refined overtime. If you're interested in developing your own stage plugin, please refer to [our documentation](https://www.nebari.dev/docs/how-tos/nebari-extension-system#developing-an-extension). When you're ready to upgrade, please download this version from either PyPI or Conda-Forge and run the `nebari upgrade -c nebari-config.yaml`
+command and follow the instructions
+
+> WARNING: CDS Dashboards was removed in this release and upgrading to this version will result in CDS Dashboards being uninstalled. A replacement dashboarding solution is currently in the works
+> and will be integrated soon.
+
+> WARNING: Given the scope of changes in this release, we highly recommend backing up your system before upgrading. Please refer to our [Manual Backup](https://www.nebari.dev/docs/how-tos/manual-backup) documentation for more details.
+
+### Feature changes and enhancements
+
+* Extension Mechanism Implementation in [PR 1833](https://github.com/nebari-dev/nebari/pull/1833)
+  * This also includes much stricter schema validation.
+* JupyterHub upgraded to 3.1 in [PR 1856](https://github.com/nebari-dev/nebari/pull/1856)'
+
+### Breaking Changes
+
+* While we have tried our best to avoid breaking changes when introducing the extension mechanism, the scope of the changes is too large for us to confidently say there won't be breaking changes.
+
+> WARNING: CDS Dashboards was removed in this release and upgrading to this version will result in CDS Dashboards being uninstalled. A replacement dashboarding solution is currently in the work and will be integrated soon.
+
+> WARNING: We will be removing and ending support for ClearML, Prefect and kbatch in the next release. The kbatch has been functionally replaced by Argo-Jupyter-Scheduler. We have seen little interest in ClearML and Prefect in recent years, and removing makes sense at this point. However if you wish to continue using them with Nebari we encourage you to [write your own Nebari extension](https://www.nebari.dev/docs/how-tos/nebari-extension-system#developing-an-extension).
+
+### What's Changed
+* Spinup spot instance for CI with cirun by @aktech in https://github.com/nebari-dev/nebari/pull/1882
+* Fix argo-viewer service account reference by @iameskild in https://github.com/nebari-dev/nebari/pull/1881
+* Framework for Nebari deployment via pytest for extensive testing by @aktech in https://github.com/nebari-dev/nebari/pull/1867
+* [pre-commit.ci] pre-commit autoupdate by @pre-commit-ci in https://github.com/nebari-dev/nebari/pull/1878
+* Test GCP/AWS Deployment with Pytest by @aktech in https://github.com/nebari-dev/nebari/pull/1871
+* Bump DigitalOcean provider to latest by @aktech in https://github.com/nebari-dev/nebari/pull/1891
+* Ensure path is Path object by @iameskild in https://github.com/nebari-dev/nebari/pull/1888
+* enabling viewing hidden files in jupyterlab file explorer by @kalpanachinnappan in https://github.com/nebari-dev/nebari/pull/1893
+* Extension Mechanism Implementation by @costrouc in https://github.com/nebari-dev/nebari/pull/1833
+* Fix import path in deployment tests & misc by @aktech in https://github.com/nebari-dev/nebari/pull/1908
+* pytest:ensure failure on warnings by @costrouc in https://github.com/nebari-dev/nebari/pull/1907
+* workaround for mixed string/posixpath error by @sblair-metrostar in https://github.com/nebari-dev/nebari/pull/1915
+* ENH: Remove aws cli, use boto3 by @fangchenli in https://github.com/nebari-dev/nebari/pull/1920
+* paginator for boto3 ec2 instance types by @sblair-metrostar in https://github.com/nebari-dev/nebari/pull/1923
+* Update README.md -- fix typo. by @teoliphant in https://github.com/nebari-dev/nebari/pull/1925
+* Add more unit tests, add cleanup step for Digital Ocean integration test by @iameskild in https://github.com/nebari-dev/nebari/pull/1910
+* Add cleanup step for AWS integration test, ensure diable_prompt is passed through by @iameskild in https://github.com/nebari-dev/nebari/pull/1921
+* K8s 1.25 + More Improvements by @Adam-D-Lewis in https://github.com/nebari-dev/nebari/pull/1856
+* adding lifecycle ignore to eks node group by @sblair-metrostar in https://github.com/nebari-dev/nebari/pull/1905
+* nebari init unit tests by @sblair-metrostar in https://github.com/nebari-dev/nebari/pull/1931
+* Bug fix - JH singleuser environment getting overwritten by @kenafoster in https://github.com/nebari-dev/nebari/pull/1933
+* Allow users to specify the Azure RG to deploy into by @iameskild in https://github.com/nebari-dev/nebari/pull/1927
+* nebari validate unit tests by @sblair-metrostar in https://github.com/nebari-dev/nebari/pull/1938
+* adding openid connect provider to enable irsa feature by @sblair-metrostar in https://github.com/nebari-dev/nebari/pull/1903
+* nebari upgrade CLI tests by @sblair-metrostar in https://github.com/nebari-dev/nebari/pull/1963
+* CI: Add test coverage by @fangchenli in https://github.com/nebari-dev/nebari/pull/1959
+* nebari cli environment variable handling, support, keycloak, dev tests by @sblair-metrostar in https://github.com/nebari-dev/nebari/pull/1968
+* CI: remove empty notebook to fix pre-commit json check by @fangchenli in https://github.com/nebari-dev/nebari/pull/1976
+* TYP: fix typing error in plugins by @fangchenli in https://github.com/nebari-dev/nebari/pull/1973
+* TYP: fix return class type in hookimpl by @fangchenli in https://github.com/nebari-dev/nebari/pull/1975
+* Allow users to specify Azure tags by @iameskild in https://github.com/nebari-dev/nebari/pull/1967
+* [pre-commit.ci] pre-commit autoupdate by @pre-commit-ci in https://github.com/nebari-dev/nebari/pull/1979
+* Do not try and add argo envs when disabled by @iameskild in https://github.com/nebari-dev/nebari/pull/1926
+* Handle region with care, updates to test suite by @iameskild in https://github.com/nebari-dev/nebari/pull/1930
+* remove custom auth from config schema by @sblair-metrostar in https://github.com/nebari-dev/nebari/pull/1994
+* CLI: handle removed dns options in deploy command by @fangchenli in https://github.com/nebari-dev/nebari/pull/1992
+* Add API docs by @kcpevey in https://github.com/nebari-dev/nebari/pull/1634
+* Upgrade images for jupyterhub-ssh, kbatch by @iameskild in https://github.com/nebari-dev/nebari/pull/1997
+* Add permissions to generate_cli_docs workflow by @iameskild in https://github.com/nebari-dev/nebari/pull/2005
+* standardize regex and messaging for names by @kenafoster in https://github.com/nebari-dev/nebari/pull/2003
+* ENH: specify required fields when retrieving available gcp projects by @fangchenli in https://github.com/nebari-dev/nebari/pull/2008
+* Modify JupyterHub networkPolicy to match existing policy by @iameskild in https://github.com/nebari-dev/nebari/pull/1991
+* Update package dependencies by @iameskild in https://github.com/nebari-dev/nebari/pull/1986
+* CI: Add AWS integration test workflow, clean up   by @iameskild in https://github.com/nebari-dev/nebari/pull/1977
+* BUG: fix unboundlocalerror in integration test by @fangchenli in https://github.com/nebari-dev/nebari/pull/1999
+* Auth0/Github auth-provider config validation fix by @sblair-metrostar in https://github.com/nebari-dev/nebari/pull/2009
+* terraform upgrade to 1.5.7 by @sblair-metrostar in https://github.com/nebari-dev/nebari/pull/1998
+* cli init repo auto provision fix by @sblair-metrostar in https://github.com/nebari-dev/nebari/pull/2012
+* Add gcp_cleanup, minor changes by @iameskild in https://github.com/nebari-dev/nebari/pull/2010
+* Fix #2024 by @dcmcand in https://github.com/nebari-dev/nebari/pull/2025
+* Upgrade conda-store to 2023.9.2 by @iameskild in https://github.com/nebari-dev/nebari/pull/2028
+* Add upgrade steps, instructions for 2023.9.1 by @iameskild in https://github.com/nebari-dev/nebari/pull/2029
+* CI: add gcp integration test by @fangchenli in https://github.com/nebari-dev/nebari/pull/2049
+* CLN: remove flake8 from dependencies by @fangchenli in https://github.com/nebari-dev/nebari/pull/2044
+* [pre-commit.ci] pre-commit autoupdate by @pre-commit-ci in https://github.com/nebari-dev/nebari/pull/2047
+* fix typo in guided init for Digital Ocean by @dcmcand in https://github.com/nebari-dev/nebari/pull/2059
+* CI: add do integration by @fangchenli in https://github.com/nebari-dev/nebari/pull/2060
+* TYP: make all subfolders under kubernetes_services/template non-module by @fangchenli in https://github.com/nebari-dev/nebari/pull/2043
+* TYP: fix most typing errors in provider by @fangchenli in https://github.com/nebari-dev/nebari/pull/2038
+* Fix link to documentation on Nebari Deployment home page by @aktech in https://github.com/nebari-dev/nebari/pull/2063
+* TST: enable timeout config in playwright notebook test by @fangchenli in https://github.com/nebari-dev/nebari/pull/1996
+* DEPS: sync supported python version by @fangchenli in https://github.com/nebari-dev/nebari/pull/2065
+* Test support for Python 3.12 by @aktech in https://github.com/nebari-dev/nebari/pull/2046
+* BUG: fix validation error related to `provider` #2054 by @fangchenli in https://github.com/nebari-dev/nebari/pull/2056
+* CI: improve unit test workflow in CI, revert #2046 by @fangchenli in https://github.com/nebari-dev/nebari/pull/2071
+* TST: enable exact_match config in playwright notebook test by @fangchenli in https://github.com/nebari-dev/nebari/pull/2027
+* CI: move conda build test to separate job by @fangchenli in https://github.com/nebari-dev/nebari/pull/2073
+* Revert conda-store to v0.4.14, #2028 by @iameskild in https://github.com/nebari-dev/nebari/pull/2074
+* ENH/CI: add mypy config, and CI workflow by @fangchenli in https://github.com/nebari-dev/nebari/pull/2066
+* Update upgrade for 2023.10.1 by @kenfoster in https://github.com/nebari-dev/nebari/pull/2080
+* Update RELEASE notes, minor fixes by @iameskild in https://github.com/nebari-dev/nebari/pull/2039
+
+### New Contributors
+* @kalpanachinnappan made their first contribution in https://github.com/nebari-dev/nebari/pull/1893
+* @fangchenli made their first contribution in https://github.com/nebari-dev/nebari/pull/1920
+* @teoliphant made their first contribution in https://github.com/nebari-dev/nebari/pull/1925
+* @kenafoster made their first contribution in https://github.com/nebari-dev/nebari/pull/1933
+* @dcmcand made their first contribution in https://github.com/nebari-dev/nebari/pull/2025
+
+**Full Changelog**: https://github.com/nebari-dev/nebari/compare/2023.7.2...2023.10.1
+
+
 ## Release 2023.7.2 - August 3, 2023
 
 This is a hot-fix release that resolves an issue whereby users in the `analyst` group are unable to launch their JupyterLab server because the name of the viewer-specific `ARGO_TOKEN` was mislabeled; see [PR 1881](https://github.com/nebari-dev/nebari/pull/1881) for more details.

pyproject.toml

@@ -78,6 +78,7 @@ dependencies = [
 [project.optional-dependencies]
 dev = [
     "black==22.3.0",
+    "mypy==1.6.1",
     "dask-gateway",
     "diagrams",
     "python-dotenv",
@@ -106,6 +107,34 @@ Source = "https://github.com/nebari-dev/nebari"
 [project.scripts]
 nebari = "nebari.__main__:main"
 
+[tool.mypy]
+warn_return_any = true
+warn_unused_configs = true
+files = [
+    "src/_nebari",
+    "src/nebari",
+]
+exclude = [
+    "src/_nebari/stages/kubernetes_services/template" # skip traitlets configuration files
+]
+
+[[tool.mypy.overrides]]
+module = [
+    "auth0.authentication",
+    "auth0.management",
+    "CloudFlare",
+    "kubernetes",
+    "kubernetes.client",
+    "kubernetes.config",
+    "kubernetes.client.rest",
+    "kubernetes.client.exceptions",
+    "keycloak",
+    "keycloak.exceptions",
+    "boto3",
+    "botocore.exceptions",
+]
+ignore_missing_imports = true
+
 [tool.ruff]
 select = [
     "E",

src/_nebari/constants.py

@@ -1,4 +1,4 @@
-CURRENT_RELEASE = "2023.7.2"
+CURRENT_RELEASE = "2023.10.1"
 
 # NOTE: Terraform cannot be upgraded further due to Hashicorp licensing changes
 # implemented in August 2023.
@@ -13,9 +13,9 @@
 
 DEFAULT_NEBARI_DASK_VERSION = CURRENT_RELEASE
 DEFAULT_NEBARI_IMAGE_TAG = CURRENT_RELEASE
-DEFAULT_NEBARI_WORKFLOW_CONTROLLER_IMAGE_TAG = CURRENT_RELEASE
+DEFAULT_NEBARI_WORKFLOW_CONTROLLER_IMAGE_TAG = "2023.7.2"
 
-DEFAULT_CONDA_STORE_IMAGE_TAG = "2023.9.2"
+DEFAULT_CONDA_STORE_IMAGE_TAG = "v0.4.14"
 
 LATEST_SUPPORTED_PYTHON_VERSION = "3.10"
 

src/_nebari/deploy.py

@@ -72,7 +72,7 @@ def deploy_configuration(
             print(f"Kubecloak master realm username={username} password={password}")
 
         print(
-            "Additional administration docs can be found at https://docs.nebari.dev/en/stable/source/admin_guide/"
+            "Additional administration docs can be found at https://www.nebari.dev/docs/how-tos/configuring-keycloak"
         )
 
     return stage_outputs

src/_nebari/stages/kubernetes_services/__init__.py

@@ -111,7 +111,6 @@ class DaskWorkerProfile(schema.Base):
     worker_memory_limit: str
     worker_memory: str
     worker_threads: int = 1
-    image: str = f"quay.io/nebari/nebari-dask-worker:{set_docker_image_tag()}"
 
     class Config:
         extra = "allow"