Skip to content

Latest commit

 

History

History
321 lines (190 loc) · 19 KB

release-notes.md

File metadata and controls

321 lines (190 loc) · 19 KB

Release Notes

Release Notes for API Portal releases in bottom-up order (latest first).

The Release Notes state changes from release to release, possibly also giving upgrade instructions.

1.0.0

Official Release of the API Portal.

Docker Tag: tba

Design documents.

0.12.4 (beta)

Date: January 13th 2018 (2018-01-13)

Docker Tag: 0.12.4(-alpine)

Content

Regression bugfix release. Sorry for the inconvenience.

0.12.3 (beta)

Date: January 12th 2018 (2018-01-12)

Docker Tag: 0.12.3(-alpine)

Content

Bugfixes, and a couple of features, contributed by @santokhsingh and @maksimlikharev. Thanks! (Sorry it took so long to merge your PRs).

Contributors

  • @santokhsingh
  • @maksimlikharev
  • @donmartin76

0.12.2 (beta)

Date: November 27th, 2017 (2017-11-27)

Docker Tag: 0.12.2(-alpine)

Content

Bugfixes.

Contributors

  • @donmartin76
  • @santokhsingh

0.12.1 (beta)

Date: September 25th, 2017 (2017-09-25)

Docker Tag: 0.12.1

Content

This release is dedicated to the Kubernetes Helm Chart adaptions. The kickstarter now by default creates an environment k8s which is adapted for use with the new Helm Chart, which can be found in the wicked.haufe.io/wicked repository. The Helm chart is now the default and recommended way to run wicked on Kubernetes; it has a lot of things already built in, like liveness and readiness probes, plus handling Kong updates correctly. Please give it a shot on a non-production environment and feedback, it would be much appreciated.

Additionally, the micro site wicked.haufe.io was updated to reflect these changes/additions.

Contributors

  • @donmartin76

0.12.0 (beta)

Date: September 17th, 2017 (2017-09-17)

Docker Tag: 0.12.0

Content

It has been a while since the last wicked update, and this release gets you a couple of things which have been asked for since a while, most notably the following issues have been resolved, which are in part internal, in part with external impact:

This time, upgrading is not 100% as easy as usual, therefore we are providing some upgrade notes below. Please read carefully for best upgrade experience.

Upgrade notes

Under the hood we have now moved to using Kong 0.11.0, and that upgrade has to be done a little more carefully than you are perhaps used to with wicked before. Follow these recommendations for a glitch-free upgrade:

  • If you are still using postgres:9.4 as a Postgres image, consider upgrading to postgres:9.6; please note that the database formats are not compatible, so that we advise you to discard the Postgres data completely when upgrading. The only downside of this is that currently active access tokens are also discarded, but other than that there are no downsides.
  • When starting the wicked.kong container the first time with the wicked 0.12.0, please
    • Shut down all previous Kong instances, or even better, use a completely new environment
    • Start just one single Kong instance at first, and wait until it has settled (created database schemas etc.); when everything is working again, you may now scale up to the desired amount of Kong instances again (when using Kubernetes, the readiness probe can be used to decide this)
  • If you are using the deployment via docker-compose.yml file as proposed by the Kickstarter, the env variable EXCLUDE_PORTS has to be extended with the port 8444; otherwise HAproxy will pick up that this (new) port is available on the Kong container, and will start to route traffic to it (you will end up with error messages from openResty if this is the case).

If you find anything else which does not work correctly, please do not hesitate to notify the project via GitHub Issues. Thanks.

Please upgrade your test/dev instances first to make sure your upgrade process works correctly.

Contributors

Code for this release was contributed by the following developers, THANKS FOR CONTRIBUTING!

  • @achwie
  • @santokhsingh
  • @maksimlikharev
  • @donmartin76

0.11.7 (beta)

Date: July 18th, 2017 (2017-07-18)

Docker Tag: 0.11.7

The main topic for this release is the bug fix for a login problem some installations of wicked have experienced in the last couple of weeks. This turned out to be due to an upstream change in a dependency of a dependency, and that was rather unexpected. We have addressed the topic for fixing, and meanwhile reverted to an older version. Further some minor things in the Kickstarter have been fixed, and a lot of work has gone into writing a Helm Chart for wicked. This is still in an experimental phase and perhaps not yet production ready, but we will continue to focus on that. Contributions are more than welcome.

0.11.6 (beta)

Date: May 24th, 2017 (2017-05-24)

Docker Tag: 0.11.6

Lots of minor and medium changes, including a very appreciated Pull Request from pifleo (thanks again!), dealing with customization options of the portal UI. Additionally, we now build (experimental) Alpine based images (based on node:6-alpine) in addition to the usual Debian based node:6 images we have had so far. The demo portal already runs on Alpine, and it seems smooth. If you want to give it a spin, go ahead, append -alpine to the image tags to pull the Alpine images. Please note that wicked.kong does not have an Alpine image, it's quite small as is anyway.

Another notable change is that the Kong Adapter now can revoke access tokens, which can be useful for logout functionality. Last, but not least, wicked now allows for application IDs of up to 50 characters (instead of 20 before).

0.11.5 (beta)

Date: March 31st, 2017 (2017-03-31)

Docker Tag: 0.11.5

Minor bugfix release mainly concerning the Kickstarter. The template for the docker-compose.yml created by the Kickstarter container an error (double environment sections) which prevented HAproxy (in the default configuration) to pick up the portal end point. Except for the YAML being syntactically wrong, this always just rendered a 503 return code for the portal end point.

0.11.4 (beta)

Date: March 20th, 2017 (2017-03-20)

Docker Tag: 0.11.4

Another minor release with two relevant changes: Firstly make sure that all calls to wicked's portal-api timeout quickly; this posed a a problem when e.g. running in Kubernetes, and the portal-api container was updated. Most depending containers check for the state of the portal API every ten seconds, and if the container is down, the call to the API will time out. The standard timeout is 120 seconds on Debian, which meant that e.g. the portal itself could hang for around two minutes before recovering. This should happen a lot faster now.

Another measure to increase deployment safety is that the portal API now checks whether the PORTAL_CONFIG_KEY is correctly configured. To make use of this new feature, open your static configuration once with the updated (0.11.4+) kickstarter; this will introduce a new property in the globals.json containing a check for the valid configuration key.

0.11.3 (beta)

Date: February 15th, 2017 (2017-02-15)

Docker Tag: 0.11.3

Minor release with two parts, running wicked as non-root inside Docker, and surfacing the Kong version and cluster information inside the system health page. Other minor things in the kickstarter, like enabling Ctrl-C for stopping it (by leveraging dumb-init again).

Did you see our Kubernetes Documentation?

When updating, please first update the wicked.kong containers, then continue with the rest of the containers.

0.11.2 (beta)

Date: January 9th, 2017 (2017-01-09)

Docker Tag: 0.11.2

Minor release containing some bugfixes and further a minor feature which enables redirection after login in case a user tries to open a page which renders a 403 and is not logged in.

0.11.1 (beta)

Date: December 19th 2016 (2016-12-19)

Docker Tag: 0.11.1

Very minor update just to get an annoying behaviour of the portal-api container out: The portal-api did not react to SIGTERM, and thus had to be "killed" by docker stop after a certain grace period. This was due to the fact that portal-api has a shell script as CMD, which gets PID 1, but does not forward the SIGTERM to the actual node process. This is now fixed by using dumb-init in the entrypoint, which propagates signals to child processes.

Oh, coming soon: Guidance on running wicked on Kubernetes. Stay tuned on deploying to kubernetes.

0.11.0 (beta)

Date: December 9th 2016 (2016-12-09)

Docker Tag: 0.11.0

Some substantial improvements to running in production. Many small details which enable deployments to other runtime environments than a pure docker host, such as Kubernetes. All components of wicked now check their configuration status and quit (trigger restart, depending on your orchestration) whenever a configuration change is detected. This means that the different components can be treated more like individual microservices. The wicked core components (portal, kong-adapter, mailer, chatbot) will still require a version which is equal to the version the portal API (portal-api) is running. Anyone using a newer node SDK version for wicked is benefiting from this feature, as it's implemented in the node SDK which is used by all the core components (and also by wicked.auth-passport and wicked.auth-saml)

The documentation has been updated to reflect the changes. A very notable changes is the possibility to now retrieve the configuration automatically from a git repository instead on having to clone it in and building a data-only container to mount into the portal API container. This is still possible, but the recommended way is injecting the static configuration via the git clone method.

Detailed list of changes:

Features and Improvements:

Bugfixes:

0.10.1 (beta)

Date: November 27th 2016 (2016-11-27)

Mostly minor bug fixes and one major addition to the OAuth2 support; the Kong Adapter now also makes it easier to implement the Authorization Code Flow. Still missing is support for Scopes and persisting Scope grants, which will possibly be done over the next couple of weeks. Let's see.

Detailed list of changes:

Docker Tag: 0.10.1

0.10.0 (beta)

Date: November 7th 2016 (2016-11-07)

Docker Tag: 0.10.0

Quite some features under the hood for this release. You will still be able to simply upgrade from any configuration version to version 0.10.0 without any changes to your configuration. It is recommended to start the new Kickstarter once with your previous configuration to see which changes are done automatically.

Detailed list of changes:

0.9.3 (beta)

Date: October 14th (2016-10-14)

Docker Tag: 0.9.2

  • Integration tests in docker can now be run locally in a much simpler way
  • Fixed issue #18 (sending mails fails if user has been deleted in the meantime)

0.9.2 (beta)

Date: September 14th (2016-09-14)

Docker Tag: 0.9.2

  • Developer Experience: Make setup of development environment a lot easier (Haufe-Lexware#5)
  • Enhancement: Allow (recursive) environment variables in PORTAL_API_DYNAMIC_CONFIG and PORTAL_API_STATIC_CONFIG.
  • Work on documentation

0.9.1 (beta)

Date: August 12th 2016 (2016-08-12)

Docker Tag 0.9.1

  • Internal refactoring of git repositories (one repository per service now)
  • Work on documentation
  • Extended Kickstarter to be able to write docker-compose.yml and Dockerfile for the static config
  • Experimental SSL helper page in Kickstarter
  • No new features in Portal

0.9.0 (beta)

Date: August 3rd 2016 (2016-08-03)

Docker Tag 0.9.0