From 6f88267c61ed03176f942310d94dcb7c7f5288b0 Mon Sep 17 00:00:00 2001 From: Carol Willing Date: Sun, 25 Jun 2017 16:07:56 -0700 Subject: [PATCH 1/3] Edit changelog and format similar to JupyterHub --- CHANGELOG.md | 118 ++++++++++++++++++++++++++++++++++----------------- 1 file changed, 78 insertions(+), 40 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 9961899d..e602c7c3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,79 +2,85 @@ Releases are now named after famous [Cricket](https://en.wikipedia.org/wiki/Cricket) players. -## v0.4 "Akram": Stability, HTTPS & breaking changes +## [Unreleased] 0.5 + +## [0.4] - ["Akram"] - Stability, HTTPS & breaking changes Released 2017-06-23 +### Installation and upgrades -We recommend that you delete prior versions of the package and install the +We **recommend** that you delete prior versions of the package and install the latest version. If you are very familiar with Kubernetes, you can upgrade from an older version, but we still suggest deleting and recreating your installation. +### Breaking changes -### Breaking changes ### +* The **name of a user pod** and a **dynamically created home directory [PVC (PersistentVolumeClaim)](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#persistentvolumeclaims)** no longer include + the `userid` in them by default. If you are using dynamic PVCs for `home` + directories (which is the default), you will need to *manually rename* these + directories before upgrading. + Otherwise, new PVCs will be created, and users might freak out when viewing the newly created directory and think that their home directory appears empty. -* Names of user pods and dynamically created home directory PVCs no longer include - the userid in them by default. If you are using dynamic PVCs for home directories - (which is the default), you will need to manually rename them before upgrading. - Otherwise, new PVCs will be created, and users might freak out about their home - directories appearing empty. - - See [this pull request](https://github.com/jupyterhub/kubespawner/pull/56) on - what needs to change! + See [PR #56](https://github.com/jupyterhub/kubespawner/pull/56) on + what needs to change. -* A [StorageClass](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#storageclasses) +* A **[StorageClass](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#storageclasses)** is no longer created by default. This shouldn't affect most new installs, since as of Kubernetes 1.6 most cloud provider installations have a default. If you are using an older version of kubernetes, easiest thing to do is upgrade to a newer version. If not, you can create a StorageClass manually and everything should continue to work. - -* token.proxy is removed. Use proxy.secretToken instead. + +* `token.proxy` is removed. Use **`proxy.secretToken`** instead. If your `config.yaml` contains something that looks like the following: - + ```yaml token: proxy: ``` - + you should change that to: - + ```yaml proxy: secretToken: ``` +### Added -### Features ### - -* Added GitHub Authentication support, thanks to [Jason Kuruzovich](https://github.com/jkuruzovich). -* Added [Ingress](https://kubernetes.io/docs/concepts/services-networking/ingress/) support! +* Added **GitHub Authentication support**, thanks to [Jason Kuruzovich](https://github.com/jkuruzovich). +* Added **[Ingress](https://kubernetes.io/docs/concepts/services-networking/ingress/) support**! If your cluster already has Ingress support (with automatic Let's Encrypt support, perhaps), you can easily use that now. -* We now add a label to user pods / PVCs with their usernames. -* Support using a static PVC for user homes or for the hub db. This makes this release usable +* We now add a **label** to user pods / PVCs with their usernames. +* Support using a **static PVC** for user `home` directories or for the hub database. This makes this release usable with clusters where you only have one NFS share that must be used for the whole hub. -* PostgreSQL is now a supported hub database backend provider. -* You can set annotations & labels on the proxy-public service now. - -### Other Changes ### - -* We now use the official [CHP](http://github.com/jupyterhub/configurable-http-proxy) - as the proxy, rather than the unofficial [nchp](https://github.com/yuvipanda/jupyterhub-nginx-chp). - This should be a no-op for the most part. JupyterHub errors might display a - nicer error page. -* The version of KubeSpawner uses the official kubernetes - [python client](https://github.com/kubernetes-incubator/client-python/) rather than - [pycurl](http://pycurl.io/). This helps with scalability a little. +* **PostgreSQL** is now a supported hub database backend provider. +* You can set annotations & labels on the **proxy-public service** now. + +### Changed + +* We now use the official [configurable http proxy](http://github.com/jupyterhub/configurable-http-proxy) + (CHP) as the proxy, rather than the unofficial + [nchp](https://github.com/yuvipanda/jupyterhub-nginx-chp). This should be a + no-op (or require no changes) for the most part. JupyterHub errors might + display a nicer error page. +* The version of KubeSpawner uses the official Kubernetes + [python client](https://github.com/kubernetes-incubator/client-python/) rather + than [pycurl](http://pycurl.io/). This helps with scalability a little. + +### Removed + * The deprecated `createNamespace` parameter no longer works, alongside the deprecated `name` parameter. You probably weren't using these anyway - they were kept only for backwards compatibility with very early versions. -### Contributors ### +### Contributors -This release made possible by the awesome work of the following contributors (in alphabetical order): +This release made possible by the awesome work of the following contributors +(in alphabetical order): * [Analect](https://github.com/analect) * [Carol Willing](https://github.com/willingc) @@ -84,13 +90,45 @@ This release made possible by the awesome work of the following contributors (in <3 -### Support ### +## 0.3 + +### [0.3.1] - 2017-05-19 + +KubeSpawner updates. + +### [0.3] - 2017-05-15 + +Deployer UX fixes. + +## [0.2] - 2017-05-01 + +Minor cleanups and features. + +## [0.1] - 2017-04-10 + +Initial Public Release + +## Support If you need support, reach out to us on [gitter](https://gitter.im/jupyterhub/jupyterhub) or open an [issue](https://github.com/jupyterhub/helm-chart/issues). -### About this cricketer ### +## About the Cricketers + +### Akram [Wasim Akram](https://en.wikipedia.org/wiki/Wasim_Akram) (وسیم اکرم) is considered by many to be -the greatest pace bowler of all time & a founder of the fine art of [reverse swing bowling](https://en.wikipedia.org/wiki/Swing_bowling#Reverse_swing). +the greatest pace bowler of all time and a founder of the fine art of +[reverse swing bowling](https://en.wikipedia.org/wiki/Swing_bowling#Reverse_swing). + + + +[Unreleased]: https://github.com/jupyterhub/helm-chart/compare/v0.4...HEAD +[0.4]: https://github.com/jupyterhub/helm-chart/compare/v0.3.1...v0.4.0 +[0.3.1]: https://github.com/jupyterhub/helm-chart/compare/v0.3...v0.3.1 +[0.3]: https://github.com/jupyterhub/helm-chart/compare/v0.2...v0.3 +[0.2]: https://github.com/jupyterhub/helm-chart/compare/v0.1...v0.2 +[1.0]: https://github.com/jupyterhub/helm-chart/releases/tag/v0.1 + +["Akram"]: #akram From b9deb4563172e907622e670a4072e9038d7f6a3a Mon Sep 17 00:00:00 2001 From: Carol Willing Date: Sun, 25 Jun 2017 16:23:00 -0700 Subject: [PATCH 2/3] Minor edits --- CHANGELOG.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index e602c7c3..c13b5bdd 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,12 +1,14 @@ # Changelog -Releases are now named after famous [Cricket](https://en.wikipedia.org/wiki/Cricket) players. +## [Unreleased] + +## Releases -## [Unreleased] 0.5 +Releases are now named after famous [Cricket](https://en.wikipedia.org/wiki/Cricket) players. -## [0.4] - ["Akram"] - Stability, HTTPS & breaking changes +## [0.4] - [Akram](#akram) - 2017-06-23 -Released 2017-06-23 +Stability, HTTPS & breaking changes. ### Installation and upgrades @@ -28,10 +30,10 @@ installation. * A **[StorageClass](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#storageclasses)** is no longer created by default. This shouldn't affect most new installs, - since as of Kubernetes 1.6 most cloud provider installations have a default. - If you are using an older version of kubernetes, easiest thing to do is upgrade - to a newer version. If not, you can create a StorageClass manually and everything - should continue to work. + since most cloud provider installations have a default (as of Kubernetes 1.6). + If you are using an older version of Kubernetes, the easiest thing to do is to + upgrade to a newer version. If not, you can create a StorageClass manually + and everything should continue to work. * `token.proxy` is removed. Use **`proxy.secretToken`** instead. If your `config.yaml` contains something that looks like the following: @@ -129,6 +131,4 @@ the greatest pace bowler of all time and a founder of the fine art of [0.3.1]: https://github.com/jupyterhub/helm-chart/compare/v0.3...v0.3.1 [0.3]: https://github.com/jupyterhub/helm-chart/compare/v0.2...v0.3 [0.2]: https://github.com/jupyterhub/helm-chart/compare/v0.1...v0.2 -[1.0]: https://github.com/jupyterhub/helm-chart/releases/tag/v0.1 - -["Akram"]: #akram +[0.1]: https://github.com/jupyterhub/helm-chart/releases/tag/v0.1 From 1865a8cffb734196effde4995078d974ead86abb Mon Sep 17 00:00:00 2001 From: Carol Willing Date: Mon, 26 Jun 2017 00:54:03 -0700 Subject: [PATCH 3/3] Changes from @yuvipanda review --- CHANGELOG.md | 23 ++++++++++------------- 1 file changed, 10 insertions(+), 13 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index c13b5bdd..174b4aa3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -92,23 +92,29 @@ This release made possible by the awesome work of the following contributors <3 +### Akram + +[Wasim Akram](https://en.wikipedia.org/wiki/Wasim_Akram) (وسیم اکرم) is considered by many to be +the greatest pace bowler of all time and a founder of the fine art of +[reverse swing bowling](https://en.wikipedia.org/wiki/Swing_bowling#Reverse_swing). + ## 0.3 ### [0.3.1] - 2017-05-19 -KubeSpawner updates. +KubeSpawner updates. [Release note](https://github.com/jupyterhub/helm-chart/releases/tag/v0.3.1) ### [0.3] - 2017-05-15 -Deployer UX fixes. +Deployer UX fixes. [Release note](https://github.com/jupyterhub/helm-chart/releases/tag/v0.3) ## [0.2] - 2017-05-01 -Minor cleanups and features. +Minor cleanups and features. [Release note](https://github.com/jupyterhub/helm-chart/releases/tag/v0.2) ## [0.1] - 2017-04-10 -Initial Public Release +Initial Public Release. [Release note](https://github.com/jupyterhub/helm-chart/releases/tag/v0.1) ## Support @@ -116,15 +122,6 @@ If you need support, reach out to us on [gitter](https://gitter.im/jupyterhub/jupyterhub) or open an [issue](https://github.com/jupyterhub/helm-chart/issues). -## About the Cricketers - -### Akram - -[Wasim Akram](https://en.wikipedia.org/wiki/Wasim_Akram) (وسیم اکرم) is considered by many to be -the greatest pace bowler of all time and a founder of the fine art of -[reverse swing bowling](https://en.wikipedia.org/wiki/Swing_bowling#Reverse_swing). - - [Unreleased]: https://github.com/jupyterhub/helm-chart/compare/v0.4...HEAD [0.4]: https://github.com/jupyterhub/helm-chart/compare/v0.3.1...v0.4.0