v0.4.0 - 03/17/2022

Breaking changes

• Upgrading to v0.4.0 will require a filesystem backup given the scope and size of the current change set.
  • Running qhub upgrade will produce an updated qhub-config.yaml and a json file of users that can then be imported into Keycloak.
• With the addition of Keycloak, QHub will no longer support security.authentication.type = custom.
  • No more users and groups in the qhub-config.yaml.

Feature changes and enhancements

• Authentication is now managed by Keycloak.
• QHub Helm extension mechanism added.
• Allow JupyterHub overrides in the qhub-config.yaml.
• qhub support CLI option to save Kubernetes logs.
• Updates conda-store UI.

What's Changed

• Enabling Vale CI with GitHub Actions by @HarshCasper in #871
• Qhub upgrade by @danlester in #870
• Documentation cleanup by @HarshCasper in #873
• [Docs] Add Traefik wildcard docs by @viniciusdc in #876
• replace deprecated "minikube cache add" with "minikube image load" by @Adam-D-Lewis in #880
• Azure Python needs different env var names to Terraform by @danlester in #882
• Add notes about broken upgrades by @tylerpotts in #877
• Keycloak integration first pass by @danlester in #848
• K8s tests - keycloak adduser by @danlester in #890
• Documentation cleanup by @HarshCasper in #889
• Improvements to templates and readme by @trallard in #893
• Keycloak docs by @danlester in #901
• DOCS: Add a PR Template by @HarshCasper in #900
• Delete existing .gitlab-ci.yml when rendering by @iameskild in #887
• Qhub Extension (Ready for Review) by @Adam-D-Lewis in #886
• Updates to Readme by @trallard in #897
• Mirror docker images to ghcr and quay container registry by @aktech in #912
• Fix CI: skip failure on cleanup by @aktech in #910
• Create and solve envs using mamba by @iameskild in #915
• Pin terraform providers by @Adam-D-Lewis in #914
• qhub-config.yaml as a secret by @danlester in #905
• Setup/Add integration/deployment tests via pytest by @aktech in #922
• Disabl/Remove the stale bot by @viniciusdc in #923
• Integrates Hadolint for Dockerfile linting by @HarshCasper in #917
• Reduce minimum nodes in user and dask node pools to 0 for Azure / GCP by @tarundmsharma in #723
• Allow jupyterhub.overrides in qhub-config.yaml by @danlester in #930
• qhub destroy using targets by @danlester in #948
• Take AWS region from AWS_DEFAULT_REGION into qhub-config.yaml on init… by @danlester in #950
• cookicutter template out of raw by @danlester in #951
• kubernetes-initialization depends_on kubernetes by @danlester in #952
• Add timeout to terraform import command by @tylerpotts in #949
• Timeout in process (for import) by @danlester in #955
• Remove user/groups from YAML by @danlester in #956
• qhub upgrade custom auth plus tests by @danlester in #946
• Add minimal support centos images by @iameskild in #943
• Keycloak Export by @danlester in #947
• qhub cli tool to save kubernetes logs - qhub support by @tarundmsharma in #818
• Add docs for deploying QHub to existing EKS cluster by @iameskild in #944
• Add jupyterhub-idle-culler to jupyterhub image by @danlester in #959
• Robust external container registry by @danlester in #945
• use qhub-jupyterhub-theme 0.3.3 to simplify JupyterHub config by @danlester in #966
• Get kubernetes version for all cloud providers + pytest refactor by @iameskild in #927
• Merge hub.extraEnv env vars by @danlester in #968
• DOCS: Removing errors from documentation by @HarshCasper in #941
• keycloak.realm_display_name by @danlester in #973
• minor updates to keycloak docs by @tylerpotts in #977
• CI changes for QHub by @HarshCasper in #989
• Update upgrade docs and general doc improvements by @iameskild in #990
• Remove scope, oauth_callback_url during upgrade step by @iameskild in #997
• Adding Conda-Store to QHub by @costrouc in #967
• Fix Jupyterlab docker build by @viniciusdc in #1001
• DOCS: Fix broken link in setup doc by @HarshCasper in #1006
• Fix Kubernetes local test deployment by @viniciusdc in #1002
• Initial commit for auth and stages workflow by @costrouc in #1003
• Fix formatting issues with black #1003 by @viniciusdc in #1020
• use pyproject.toml and setup.cfg for packaging by @tonyfast in #986
• Increase timeout/attempts for keycloak check by @viniciusdc in #1023
• Fix issue with traefik issueing certificates with letsencrypt acme by @costrouc in #1017
• Fixing cdsdashboard conda environments being shown by @costrouc in #1025
• Fix input variable support for multiple types by @viniciusdc in #1029
• Fix Black/Flake8 problems by @danlester in #1039
• Add remote state condition for 01-terraform-state provisioning by @viniciusdc in #1042
• Round versions for upgrade and schema by @danlester in #1038
• Code Server is now installed via conda, and the Jupyterlab Extension is https://github.com/betatim/vscode-binder/ by @costrouc in #1044
• Removing cookiecutter from setup.cfg requirements by @costrouc in #1026
• Destroy terraform-state stage when condition match by @viniciusdc in #1051
• Fixup adding support for security.keycloak.realm_display_name key by @costrouc in #1054
• Move external_container_reg to earlier stage by @danlester in #1053
• Adding ability to specify overrides back into keycloak configuration by @costrouc in #1055
• Depricating terraform_modules option since no longer used by @costrouc in #1057
• Adding security.shared_users_group option for default users group by @costrouc in #1056
• Fixup adding back jupyterhub overrides option by @costrouc in #1058
• prevent_deploy flag for safeguarding upgrades by @danlester in #1047
• CI: Add layer caching for Docker images by @HarshCasper in #1061
• Additions to TCP/DNS stage check, fix 1027 by @iameskild in #1063
• FIX: Remove concurrency groups by @HarshCasper in #1064
• Stage 08 extensions and realms/logout by @danlester in #1069
• Auto create/destroy azure resource group by @viniciusdc in #1071
• Add CICD schema and render workflows by @iameskild in #1068
• Ensure that the shared folder symlink only exists if user has shared folders by @costrouc in #1074
• Adds the ability on render to deleted targeted files or directories by @costrouc in #1073
• DOCS: QHub 101 by @HarshCasper in #1011
• remove jovyan user by @tylerpotts in #1089
• More finely scoped github actions and kubernetes_test build docker images by @costrouc in #1088
• Adding clearml overrides by @costrouc in #1059
• Reorganizing render, deploy, destroy to unify stages input_vars, tf_objects, checks, and state_imports by @costrouc in #1091
• Updates/fixes for rendering CICD workflows by @iameskild in #1086
• fix bug in state_01_terraform_state function call by @tylerpotts in #1094
• Use paths instead of paths-ignore so that test only run on changes to given paths by @costrouc in #1097
• [ENH] - Update issue templates by @trallard in #1083
• Generate independet objects for terraform-state resources by @viniciusdc in #1102
• Complete implementation of destroy which goes through each stage by @costrouc in #1103
• Change AWS Kubenetes provider authentication to use data.eks_cluster instead of exec by @costrouc in #1107
• Relax qhub destroy to attempt to continue destroying resources by @costrouc in #1109
• Breaking upgrade docs (0.4) by @danlester in #1087
• Simplify default images by @tylerpotts in #1114
• Change group structure by @danlester in #1112
• Adding status field to each destroy stage to print status by @costrouc in #1116
• Incorrect mapping of values to gcp node group instance types by @costrouc in #1117
• FIX: Remove Conda Store from default images by @HarshCasper in #1119
• Minor fix to setup.cfg by @iameskild in #1122
• [DOC]- Update contribution guidelines by @trallard in #1080
• Adding tests to visit additional endpoints by @costrouc in #1118
• Adding tests for juypterhub-ssh, jhub-client, and vs code by @costrouc in #1123
• Update Keycloak docs by @iameskild in #1093
• Upgrade conda-store v0.3.10 and simplify specification of image by @HarshCasper in #1130
• [ImgBot] Optimize images by @imgbot in #1140
• Adjust Idle culler settings and add internal culling by @viniciusdc in #1133
• [BUG] Removing jovyan home directory and issue with nss confiuration by @costrouc in #1142
• [DOC] Add troubleshooting docs by @iameskild in #1139
• Update user login guides by @viniciusdc in #1144
• [ImgBot] Optimize images by @imgbot in #1146
• Workaround for kubernetes-client version issue by @iameskild in #1148
• Make the commit of the terraform rendering optional (replaces PR 995) by @iameskild in #1149
• Fix typos in user guide docs by @ericdatakelly in #1154
• Minor docs clean up for v0.4.0 release by @iameskild in #1155
• Readthedocs and documentation updates by @tonyfast in #1153
• Add markdown formatter for doc wrapping by @viniciusdc in #1152
• remove deprecated param count from .cirun.yml by @aktech in #1164
• Use qhub-bot for keycloak deployment/check by @iameskild in #1167
• Only list active conda-envs for dask-gateway by @iameskild in #1162

New Contributors

• @imgbot made their first contribution in #1140
• @ericdatakelly made their first contribution in #1154

Full Changelog: v0.3.13...v0.4.0