Contains description of QHub releases.
Enhancements for this release include:
- Integrating Argo Workflow
- Integrating kbatch
- Adding
cost-estimateCLI subcommand (Infracost) - Add
panel-serveas a CDS dashboard option - Add option to use RetroLab instead of default JupyterLab
- Update the login/Keycloak docs page by @gabalafou in nebari-dev#1289
- Add configuration option so myst parser generates anchors for heading… by @costrouc in nebari-dev#1299
- Image scanning by @HarshCasper in nebari-dev#1291
- Fix display version behavior by @viniciusdc in nebari-dev#1275
- [Docs] Add docs about custom Identity providers for Authentication by @viniciusdc in nebari-dev#1273
- Add prefect token var to CI when needed by @viniciusdc in nebari-dev#1279
- ci: prevent image scans on main image builds by @HarshCasper in nebari-dev#1300
- Integrate
kbatchby @iameskild in nebari-dev#1258 - add
retrolabto the base jupyter image by @tonyfast in nebari-dev#1222 - Update pre-commit, remove vale by @iameskild in nebari-dev#1282
- Argo Workflows by @Adam-D-Lewis in nebari-dev#1252
- Update minio, postgresql chart repo location by @iameskild in nebari-dev#1308
- Fix broken AWS, set minimum desired size to 1, enable 0 scaling by @tylerpotts in nebari-dev#1304
- v0.4.2 release notes by @iameskild in nebari-dev#1323
- install dask lab ext from main by @iameskild in nebari-dev#1321
- Overrides default value for dask-labextension by @viniciusdc in nebari-dev#1327
- CI: Add Infracost to GHA CI for infra cost tracking by @HarshCasper in nebari-dev#1316
- Add check for highest supported k8s version by @aktech in nebari-dev#1336
- Increase the default instance sizes by @peytondmurray in nebari-dev#1338
- Add panel-serve as a CDS dashboard option by @iameskild in nebari-dev#1070
- Generate QHub Costs via
infracostby @HarshCasper in nebari-dev#1340 - Add release-checklist issue template by @iameskild in nebari-dev#1314
- Fix missing import:
rich: broken qhub init with cloud by @aktech in nebari-dev#1353 - Bump qhub-dask version to 0.4.3 by @peytondmurray in nebari-dev#1341
- Remove the need for AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY to be set with Digital Ocean deployment by @costrouc in nebari-dev#1344
- Revert "Remove the need for AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY to be set with Digital Ocean deployment" by @viniciusdc in nebari-dev#1355
- Upgrade kbatch version by @iameskild in nebari-dev#1335
- Drop support for python 3.7 in dask environment by @peytondmurray in nebari-dev#1354
- Add useful terminal utils to jlab image by @dharhas in nebari-dev#1361
- Tweak bashrc by @dharhas in nebari-dev#1363
- Fix bug where vscode extensions are not installing by @viniciusdc in nebari-dev#1360
- @gabalafou made their first contribution in nebari-dev#1289
- @peytondmurray made their first contribution in nebari-dev#1338
- @dharhas made their first contribution in nebari-dev#1361
Full Changelog: https://github.com/Quansight/qhub/compare/v0.4.1...v0.4.3
On June 2, 2022, GitHub user @peytondmurray reported issue 1306, stating that he was unable to deploy QHub using either the latest release v0.4.1 or installing qhub from main. As verified by @peytondmurray and others, during your first qhub deploy, the deployment halts and complains about two invalid Helm charts missing from the bitnami index.yaml.
Bitnami's decision to update how long they keep old Helm charts in their index for has essentially broken all post v0.4.0 versions of QHub.
This is a severe bug that will affect any new user who tries to install and deploy QHub with any version less than v0.4.2 and greater than or equal to v0.4.0.
Given the impact and severity of this bug, the team has decided to quickly cut a hotfix.
On May 27, 2022, GitHub user @tylerpotts reported issue 1302, stating that he was unable to deploy QHub using the latest release v0.4.1 (or installing qhub from main). As described in the original issue, the deployment failed complaining about the deprecated v1beta Kubernetes API. This led to the discovery that we were using an outdated cluster_autoscaler helm chart.
The solution is to update from v1beta to v1 Kubernetes API for the appropriate resources and update the reference to the cluster_autoscaler helm chart.
Given the impact and severity of this bug, the team has decided to quickly cut a hotfix.
This release is a hotfix for the issue summarized in the following:
- Update minio, postgresql chart repo location by @iameskild in PR 1308
- Fix broken AWS, set minimum desired size to 1, enable 0 scaling by @tylerpotts in PR 1304
Enhancements for this release include:
- Add support for pinning the IP address of the load balancer via terraform overrides
- Upgrade to Conda-Store to
v0.3.15 - Add ability to limit JupyterHub profiles based on users/groups
This release addresses several bugs with a slight emphasis on stablizing the core services while also improving the end user experience.
- [BUG] Adding back feature of limiting profiles for users and groups by @costrouc in PR 1169
- DOCS: Add release notes for v0.4.0 release by @HarshCasper in PR 1170
- Move ipython config within jupyterlab to docker image with more robust jupyterlab ssh tests by @costrouc in PR 1143
- Removing custom dask_gateway from qhub and idle_timeout for dask clusters to 30 min by @costrouc in PR 1151
- Overrides.json now managed by qhub configmaps instead of inside docker image by @costrouc in PR 1173
- Adding examples to QHub jupyterlab by @costrouc in PR 1176
- Bump conda-store version to 0.3.12 by @costrouc in PR 1179
- Fixing concurrency not being specified in configuration by @costrouc in PR 1180
- Adding ipykernel as default to environment along with ensure conda-store restarted on config change by @costrouc in PR 1181
- keycloak dev docs by @danlester in PR 1184
- Keycloakdev2 by @danlester in PR 1185
- Setting minio storage to by default be same as filesystem size for Conda-Store environments by @costrouc in PR 1188
- Bump Conda-Store version in Qhub to 0.3.13 by @costrouc in PR 1189
- Upgrade mrparkers to 3.7.0 by @danlester in PR 1183
- Mdformat tables by @danlester in PR 1186
- [ImgBot] Optimize images by @imgbot in PR 1187
- Bump conda-store version to 0.3.14 by @costrouc in PR 1192
- Allow terraform init to upgrade providers within version specification by @costrouc in PR 1194
- Adding missing init files by @costrouc in PR 1196
- Release 0.3.15 for Conda-Store by @costrouc in PR 1205
- Profilegroups by @danlester in PR 1203
- Render
.gitignore, black py files by @iameskild in PR 1206 - Update qhub-dask pinned version by @iameskild in PR 1224
- Fix env doc links and add corresponding tests by @aktech in PR 1216
- Update conda-store-environment variable
typeby @iameskild in PR 1213 - Update release notes - justification for changes in
v0.4.0by @iameskild in PR 1178 - Support for pinning the IP address of the load balancer via terraform overrides by @aktech in PR 1235
- Bump moment from 2.29.1 to 2.29.2 in /tests_e2e by @dependabot in PR 1241
- Update cdsdashboards to 0.6.1, Voila to 0.3.5 by @danlester in PR 1240
- Bump minimist from 1.2.5 to 1.2.6 in /tests_e2e by @dependabot in PR 1208
- output check fix by @Adam-D-Lewis in PR 1244
- Update panel version to fix jinja2 recent issue by @viniciusdc in PR 1248
- Add support for terraform overrides in cloud and VPC deployment for Azure by @aktech in PR 1253
- Add test-release workflow by @iameskild in PR 1245
- Bump async from 3.2.0 to 3.2.3 in /tests_e2e by @dependabot in PR 1260
- [WIP] Add support for VPC deployment for GCP via terraform overrides by @aktech in PR 1259
- Update login instructions for training by @iameskild in PR 1261
- Add docs for general node upgrade by @iameskild in PR 1246
- [ImgBot] Optimize images by @imgbot in PR 1264
- Fix project name and domain at None by @pierrotsmnrd in PR 856
- Adding name convention validator for QHub project name by @viniciusdc in PR 761
- Minor doc updates by @iameskild in PR 1268
- Enable display of Qhub version by @viniciusdc in PR 1256
- Fix missing region from AWS provider by @viniciusdc in PR 1271
- Re-enable GPU profiles for GCP/AWS by @viniciusdc in PR 1219
- Release notes for
v0.4.1by @iameskild in PR 1272
- @dependabot made their first contribution in PR 1241
This post-release addresses the a few minor bugs and updates the release notes. There are no breaking changes or API changes.
- Render
.gitignore, black py files - PR 1206 - Update qhub-dask pinned version - PR 1224
- Update conda-store-environment variable
type- PR 1213 - Update release notes - justification for changes in
v0.4.0- PR 1178 - Merge spawner and profile env vars to ensure dashboard sharing vars are provided to dashboard servers - PR 1237
WARNING
If you're looking for a stable version of QHub, please consider
v0.3.14. Thev0.4.0has many breaking changes and has rough edges that will be resolved in upcoming point releases.
We are happy to announce the release of v0.4.0! This release lays the groundwork for many exciting new features and improvements in the future, stay tuned.
Version v0.4.0 introduced many design changes along with a handful of user-facing changes that require some justification. Unfortunately as a result of these changes, QHub
instances that are upgraded from previous version to v0.4.0 will irrevocably break.
Until we have a fully functioning backup mechanism, anyone looking to upgrade is highly encouraged to backup their data, see the upgrade docs and more specifically, the backup docs.
These design changes were considered important enough that the development team felt they were warranted. Below we try to highlight a few of the largest changes and provide justification for them.
- Replace Terraforms resource targeting with staged Terraform deployments.
- Justification: using Terraform resource targeting was never an ideal way of handing off outputs from stage to the next and Terraform explicitly warns its users that it's only intended to be used "for exceptional situations such as recovering from errors or mistakes".
- Fully remove
cookiecutteras a templating mechanism.- Justification: Although
cookiecutterhas its benefits, we were becoming overly reliant on it as a means of rendering various scripts needed for the deployment. Reading through Terraform scripts with scatteredcookiecutterstatements was increasing troublesome and a bit intimidating. Our IDEs are also much happier about this change.
- Justification: Although
- Removing users and groups from the
qhub-config.yamland replacing user management with Keycloak.- Justification: Up until now, any change to QHub deployment needed to be made in the
qhub-config.yamlwhich had the benefit of centralizing any configuration. However it also potentially limited the kinds of user management tasks while also causing theqhub-config.yamlto balloon in size. Another benefit of removing users and groups from theqhub-config.yamlthat deserves highlighting is that user management no longer requires a full redeployment.
- Justification: Up until now, any change to QHub deployment needed to be made in the
Although breaking changes are never fun, we hope the reasons outlined above are encouraging signs that we are working on building a better, more stable, more flexible product. If you experience any issues or have any questions about these changes, feel free to open an issue on our Github repo.
Explicit user facing changes:
- Upgrading to
v0.4.0will require a filesystem backup given the scope and size of the current change set.- Running
qhub upgradewill produce an updatedqhub-config.yamland a JSON file of users that can then be imported into Keycloak.
- Running
- With the addition of Keycloak, QHub will no longer support
security.authentication.type = custom.- No more users and groups in the
qhub-config.yaml.
- No more users and groups in the
- Authentication is now managed by Keycloak.
- QHub Helm extension mechanism added.
- Allow JupyterHub overrides in the
qhub-config.yaml. qhub supportCLI option to save Kubernetes logs.- Updates
conda-storeUI.
- Enabling Vale CI with GitHub Actions by @HarshCasper in nebari-dev#871
- Qhub upgrade by @danlester in nebari-dev#870
- Documentation cleanup by @HarshCasper in nebari-dev#873
- [Docs] Add Traefik wildcard docs by @viniciusdc in nebari-dev#876
- replace deprecated "minikube cache add" with "minikube image load" by @Adam-D-Lewis in nebari-dev#880
- Azure Python needs different env var names to Terraform by @danlester in nebari-dev#882
- Add notes about broken upgrades by @tylerpotts in nebari-dev#877
- Keycloak integration first pass by @danlester in nebari-dev#848
- K8s tests - keycloak adduser by @danlester in nebari-dev#890
- Documentation cleanup by @HarshCasper in nebari-dev#889
- Improvements to templates and readme by @trallard in nebari-dev#893
- Keycloak docs by @danlester in nebari-dev#901
- DOCS: Add a PR Template by @HarshCasper in nebari-dev#900
- Delete existing
.gitlab-ci.ymlwhen rendering by @iameskild in nebari-dev#887 - Qhub Extension (Ready for Review) by @Adam-D-Lewis in nebari-dev#886
- Updates to Readme by @trallard in nebari-dev#897
- Mirror docker images to ghcr and quay container registry by @aktech in nebari-dev#912
- Fix CI: skip failure on cleanup by @aktech in nebari-dev#910
- Create and solve envs using mamba by @iameskild in nebari-dev#915
- Pin terraform providers by @Adam-D-Lewis in nebari-dev#914
- qhub-config.yaml as a secret by @danlester in nebari-dev#905
- Setup/Add integration/deployment tests via pytest by @aktech in nebari-dev#922
- Disable/Remove the stale bot by @viniciusdc in nebari-dev#923
- Integrates Hadolint for Dockerfile linting by @HarshCasper in nebari-dev#917
- Reduce minimum nodes in user and dask node pools to 0 for Azure / GCP by @tarundmsharma in nebari-dev#723
- Allow jupyterhub.overrides in qhub-config.yaml by @danlester in nebari-dev#930
- qhub destroy using targets by @danlester in nebari-dev#948
- Take AWS region from AWS_DEFAULT_REGION into qhub-config.yaml on init… by @danlester in nebari-dev#950
- cookicutter template out of raw by @danlester in nebari-dev#951
- kubernetes-initialization depends_on kubernetes by @danlester in nebari-dev#952
- Add timeout to terraform import command by @tylerpotts in nebari-dev#949
- Timeout in process (for import) by @danlester in nebari-dev#955
- Remove user/groups from YAML by @danlester in nebari-dev#956
- qhub upgrade custom auth plus tests by @danlester in nebari-dev#946
- Add minimal support
centosimages by @iameskild in nebari-dev#943 - Keycloak Export by @danlester in nebari-dev#947
- qhub cli tool to save kubernetes logs -
qhub supportby @tarundmsharma in nebari-dev#818 - Add docs for deploying QHub to existing EKS cluster by @iameskild in nebari-dev#944
- Add jupyterhub-idle-culler to jupyterhub image by @danlester in nebari-dev#959
- Robust external container registry by @danlester in nebari-dev#945
- use qhub-jupyterhub-theme 0.3.3 to simplify JupyterHub config by @danlester in nebari-dev#966
- Get kubernetes version for all cloud providers + pytest refactor by @iameskild in nebari-dev#927
- Merge hub.extraEnv env vars by @danlester in nebari-dev#968
- DOCS: Removing errors from documentation by @HarshCasper in nebari-dev#941
- keycloak.realm_display_name by @danlester in nebari-dev#973
- minor updates to keycloak docs by @tylerpotts in nebari-dev#977
- CI changes for QHub by @HarshCasper in nebari-dev#989
- Update
upgradedocs and general doc improvements by @iameskild in nebari-dev#990 - Remove
scope,oauth_callback_urlduring upgrade step by @iameskild in nebari-dev#997 - Adding Conda-Store to QHub by @costrouc in nebari-dev#967
- Fix Jupyterlab docker build by @viniciusdc in nebari-dev#1001
- DOCS: Fix broken link in setup doc by @HarshCasper in nebari-dev#1006
- Fix Kubernetes local test deployment by @viniciusdc in nebari-dev#1002
- Initial commit for auth and stages workflow by @costrouc in nebari-dev#1003
- Fix formatting issues with black #1003 by @viniciusdc in nebari-dev#1020
- use pyproject.toml and setup.cfg for packaging by @tonyfast in nebari-dev#986
- Increase timeout/attempts for keycloak check by @viniciusdc in nebari-dev#1023
- Fix issue with traefik issuing certificates with let's encrypt acme by @costrouc in nebari-dev#1017
- Fixing cds dashboard conda environments being shown by @costrouc in nebari-dev#1025
- Fix input variable support for multiple types by @viniciusdc in nebari-dev#1029
- Fix Black/Flake8 problems by @danlester in nebari-dev#1039
- Add remote state condition for 01-terraform-state provisioning by @viniciusdc in nebari-dev#1042
- Round versions for upgrade and schema by @danlester in nebari-dev#1038
- Code Server is now installed via conda, and the Jupyterlab Extension is https://github.com/betatim/vscode-binder/ by @costrouc in nebari-dev#1044
- Removing cookiecutter from setup.cfg requirements by @costrouc in nebari-dev#1026
- Destroy terraform-state stage when condition match by @viniciusdc in nebari-dev#1051
- Fix up adding support for security.keycloak.realm_display_name key by @costrouc in nebari-dev#1054
- Move external_container_reg to earlier stage by @danlester in nebari-dev#1053
- Adding ability to specify overrides back into keycloak configuration by @costrouc in nebari-dev#1055
- Deprecating terraform_modules option since no longer used by @costrouc in nebari-dev#1057
- Adding security.shared_users_group option for default users group by @costrouc in nebari-dev#1056
- Fix up adding back jupyterhub overrides option by @costrouc in nebari-dev#1058
- prevent_deploy flag for safeguarding upgrades by @danlester in nebari-dev#1047
- CI: Add layer caching for Docker images by @HarshCasper in nebari-dev#1061
- Additions to TCP/DNS stage check, fix 1027 by @iameskild in nebari-dev#1063
- FIX: Remove concurrency groups by @HarshCasper in nebari-dev#1064
- Stage 08 extensions and realms/logout by @danlester in nebari-dev#1069
- Auto create/destroy azure resource group by @viniciusdc in nebari-dev#1071
- Add CICD schema and render workflows by @iameskild in nebari-dev#1068
- Ensure that the shared folder symlink only exists if user has shared folders by @costrouc in nebari-dev#1074
- Adds the ability on render to deleted targeted files or directories by @costrouc in nebari-dev#1073
- DOCS: QHub 101 by @HarshCasper in nebari-dev#1011
- remove jovyan user by @tylerpotts in nebari-dev#1089
- More finely scoped github actions and kubernetes_test build docker images by @costrouc in nebari-dev#1088
- Adding clearml overrides by @costrouc in nebari-dev#1059
- Reorganizing render, deploy, destroy to unify stages input_vars, tf_objects, checks, and state_imports by @costrouc in nebari-dev#1091
- Updates/fixes for rendering CICD workflows by @iameskild in nebari-dev#1086
- fix bug in state_01_terraform_state function call by @tylerpotts in nebari-dev#1094
- Use paths instead of paths-ignore so that test only run on changes to given paths by @costrouc in nebari-dev#1097
- [ENH] - Update issue templates by @trallard in nebari-dev#1083
- Generate independent objects for terraform-state resources by @viniciusdc in nebari-dev#1102
- Complete implementation of destroy which goes through each stage by @costrouc in nebari-dev#1103
- Change AWS Kubernetes provider authentication to use data.eks_cluster instead of exec by @costrouc in nebari-dev#1107
- Relax qhub destroy to attempt to continue destroying resources by @costrouc in nebari-dev#1109
- Breaking upgrade docs (0.4) by @danlester in nebari-dev#1087
- Simplify default images by @tylerpotts in nebari-dev#1114
- Change group structure by @danlester in nebari-dev#1112
- Adding status field to each destroy stage to print status by @costrouc in nebari-dev#1116
- Incorrect mapping of values to gcp node group instance types by @costrouc in nebari-dev#1117
- FIX: Remove Conda Store from default images by @HarshCasper in nebari-dev#1119
- Minor fix to
setup.cfgby @iameskild in nebari-dev#1122 - [DOC]- Update contribution guidelines by @trallard in nebari-dev#1080
- Adding tests to visit additional endpoints by @costrouc in nebari-dev#1118
- Adding tests for juypterhub-ssh, jhub-client, and vs code by @costrouc in nebari-dev#1123
- Update Keycloak docs by @iameskild in nebari-dev#1093
- Upgrade conda-store v0.3.10 and simplify specification of image by @HarshCasper in nebari-dev#1130
- [ImgBot] Optimize images by @imgbot in nebari-dev#1140
- Adjust Idle culler settings and add internal culling by @viniciusdc in nebari-dev#1133
- [BUG] Removing jovyan home directory and issue with nss configuration by @costrouc in nebari-dev#1142
- [DOC] Add
troubleshootingdocs by @iameskild in nebari-dev#1139 - Update user login guides by @viniciusdc in nebari-dev#1144
- [ImgBot] Optimize images by @imgbot in nebari-dev#1146
- Workaround for kubernetes-client version issue by @iameskild in nebari-dev#1148
- Make the commit of the terraform rendering optional (replaces PR 995) by @iameskild in nebari-dev#1149
- Fix typos in user guide docs by @ericdatakelly in nebari-dev#1154
- Minor docs clean up for v0.4.0 release by @iameskild in nebari-dev#1155
- Read-the-docs and documentation updates by @tonyfast in nebari-dev#1153
- Add markdown formatter for doc wrapping by @viniciusdc in nebari-dev#1152
- remove deprecated param
countfrom.cirun.ymlby @aktech in nebari-dev#1164 - Use qhub-bot for keycloak deployment/check by @iameskild in nebari-dev#1167
- Only list active conda-envs for dask-gateway by @iameskild in nebari-dev#1162
- @imgbot made their first contribution in nebari-dev#1140
- @ericdatakelly made their first contribution in nebari-dev#1154
Full Changelog: https://github.com/Quansight/qhub/compare/v0.3.13...v0.4.0
- No known breaking changes
- Allow users to specify external Container Registry (#741)
- Integrate Prometheus and Grafana into QHub (#733)
- Add Traefik Dashboard (#797)
- Make ForwardAuth optional for ClearML (#830)
- Include override configuration for Prefect Agent (#813)
- Improve authentication type checking (#834)
- Switch to pydata Sphinx theme (#805)
- Add force-destroy command (only for AWS at the moment) (#694)
- Include namespace in conda-store PVC (#716)
- Secure ClearML behind ForwardAuth (#721)
- Fix connectivity issues with AWS EKS via Terraform (#734)
- Fix conda-store pod eviction and volume conflicts (#740)
- Update
remove_existing_rendersto only delete QHub related files/directories (#800) - Reduce number of AWS subnets down to 4 to increase the number of available nodes by a factor of 4 (#839)
- better validation messages on github auto provisioning
- removing default values from pydantic schema which caused invalid yaml files to unexpectedly pass validation
- make kubespawner_override.environment overridable (prior changes were overwritten)
- reverting
qhub_userdefault name tojovyan
- terraform formatting in cookiecutter for enabling GPUs on GCP
- creating releases for QHub simplified
- added an image for overriding the dask-gateway being used
- dask-gateway exposed by default now properly
- typo in cookiecutter for enabling GPUs on GCP
- setting
/bin/bashas the default terminal
jhsingle-native-proxyadded to the base jupyterlab image
- simplified bash jupyterlab image to no longer have dashboard packages panel, etc.
- added emacs and vim as default editors in image
- added jupyterlab-git and jupyterlab-sidecar since they now support 3.0
- improvements with
qhub destroycleanly deleting resources - allow user to select conda environments for dashboards
- added command line argument
--skip-terraform-state-provisionto allow for skipping terraform state provisioning inqhub deploystep - no longer render
qhub initqhub-config.yamlfile in alphabetical order - allow user to select instance sizes for dashboards
- fixed gitlab-ci before_script and after_script
- fixed jovyan -> qhub_user home directory path issue with dashboards
- added a
--skip-remote-state-provisionflag to allowqhub deploywithin CI to skip the remote state creation - added saner defaults for instance sizes and jupyterlab/dask profiles
qhub initno longer rendersqhub-config.yamlin alphabetical orderspawn_default_optionsto False to force dashboard owner to pick profile- adding
before_scriptandafter_scriptkey toci_cdto allow customization of CI process
- remaining issues with ci_cd branch not being fully changed
- Moved to ruamel as yaml parser to throw errors on duplicate keys
- fixed a url link error in cds dashboards
- Azure fixes to enable multiple deployments under one account
- Terraform formatting issue in acme_server deployment
- Terraform errors are caught by qhub and return error code
- prevent gitlab-ci from freezing on gitlab deployment
- not all branches were configured via the
branchoption inci_cd
- added gitlab support for CI
ci_cdfield is now optional- AWS provider now respects the region set
- More robust errors messages in cli around project name and namespace
git initdefault branch is nowmain- branch for CI/CD is now configurable
- typo in
authenticator_classfor custom authentication
- Support for self-signed certificate/secret keys via kubernetes secrets
- jupyterhub-ssh (
sshandsftpintegration) accessible on port8022and8023respectively - VSCode(code-server) now provided in default image and integrated with jupyterlab
- Dask Gateway now accessible outside of cluster
- Moving fully towards traefik as a load balancer with tight integration with dask-gateway
- Adding ability to specify node selector label for general, user, and worker
- Ability to specify
kube_contextfor local deployments otherwise will use default - Strict schema validation for
qhub-config.yaml - Terraform binary is auto-installed and version managed by qhub
- Deploy stage will auto render by default removing the need for render command for end users
- Support for namespaces with qhub deployments on kubernetes clusters
- Full JupyterHub theming including colors now.
- JupyterHub docker image now independent from zero-to-jupyterhub.
- JupyterLab 3 now default user Docker image.
- Implemented the option to locally deploy QHub allowing for local testing.
- Removed the requirement for DNS, authorization is now password-based (no more OAuth requirements).
- Added option for password-based authentication
- CI now tests local deployment on each commit/PR.
- QHub Terraform modules are now pinned to specific git branch via
terraform_modules.repositoryandterraform_modules.ref. - Adds support for Azure cloud provider.
- Terraform version is now pinned to specific version
domainattributed inqhub-config.yamlis now the url for the cluster
- Version
<version>is in formatX.Y.Z - Create release branch
release-<version>based offmain - Ensure full functionality of QHub this involves at a minimum ensuring
- GCP, AWS, DO, and local deployment
- "Let's Encrypt" successfully provisioned
- Dask Gateway functions properly on each
- JupyterLab functions properly on each
- Increment the version number in
qhub/VERSIONin formatX.Y.Z - Ensure that the version number in
qhub/VERSIONis used in pinning QHub in the github actionsqhub/template/{{ cookiecutter.repo_directory }}/.github/workflows/qhub-ops.yamlin formatX.Y.Z - Create a git tag pointing to the release branch once fully tested and version numbers are incremented
v<version>
- Added conda prerequisites for GUI packages.
- Added
qhub destroyfunctionality that tears down the QHub deployment. - Changed the default repository branch from
mastertomain. - Added error message when Terraform parsing fails.
- Added templates for GitHub issues.
qhub deploy -c qhub-config.yamlno longer prompts unsupported argument forload_config_file.- Minor changes on the Step-by-Step walkthrough on the docs.
- Revamp of README.md to make it concise and highlight QHub HPC.
- Removed the registry for DigitalOcean.
Brian Larsen, Rajat Goyal, Prasun Anand, and Rich Signell and Josef Kellndorfer for the insightful discussions.