Skip to content

Commit

Permalink
feat: add release notes
Browse files Browse the repository at this point in the history
  • Loading branch information
jaydesl committed Feb 25, 2022
1 parent 06fcf8c commit 1f6e22f
Show file tree
Hide file tree
Showing 2 changed files with 86 additions and 3 deletions.
23 changes: 21 additions & 2 deletions user_documentation/rst/release_notes.rst
Original file line number Diff line number Diff line change
@@ -1,12 +1,31 @@
Release Notes
*************

| **Changelog since v0.5.x of MiCADO**
| See more detailed notes about upgrading in :ref:`whatsnew`
v0.10.0 (23 February 2022)
==========================

- Support TOSCA v1.3 instance_count and occurrences for node replicas
- Support the Kubernetes subpath feature for multi volume mounting
- Update Docker, containerd, Kubernetes and KubeEdge versions
- Fix an issue with SSH keypair name collisions in OpenStack

Internal MiCADO-Edge Release (4 May 2021)
==================================================

- Add support for Edge nodes with `KubeEdge <https://kubeedge.io>`__
- Add support for OpenID Connect Authentication in OpenStack
- Add support for specifying the floating IP of an instance
- Fix an issue where Playbooks would fail on first `apt-get`
- Add support for drop-in Ansible plays
- Organise Playbook as per Ansible best practices
- Set best practice configuration with ansible.cfg
- Support domain_name property for v3 Password Authentication


v0.9.1-rev1 (28 October 2020)
=======================
=============================

- Fix an issue where Kubernetes playbook tasks would fail (`ansible-collections/community.kubernetes/issues/273 <https://github.com/ansible-collections/community.kubernetes/issues/273>`__)

Expand Down
66 changes: 65 additions & 1 deletion user_documentation/rst/whats_new.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,71 @@
What's New
**********

**This section contains detailed upgrade notes for recent versions**
v0.10.0
=======

Major Enhancements
------------------

This is the public release of the now merged MiCADO-Edge. See those
changes detailed below. There are only a few additional notes for this
release.

Fixes
-----

OpenStack SSH Keypair name collision
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

If multiple applications were being launched by different users
on the same OpenStack cluster, there was a possibility that different SSH
Keypair names generated by MiCADO would have the same name. This has now
been corrected.

Known Issues & Deprecations
---------------------------

Ubuntu 16.04
~~~~~~~~~~~~

Support for Ubuntu 16.04 LTS has been deprecated. We are currently
supporting the long-term support releases of Ubuntu: 18.04 and 20.04


Internal MiCADO-Edge Release
============================

Major Enhancements
------------------

Support for Edge Nodes
~~~~~~~~~~~~~~~~~~~~~~

MiCADO now includes support for adding edge nodes to the cluster via
`KubeEdge <https://kubeedge.io>`__. Both x86 and ARM architectures are
supported and current Debian-based (including Raspbian) distributions of
Linux have been tested. Connecting Edges is done via the Ansible Playbook
used to deploy MiCADO. Once connected, an ADT can reference these edges to
ensure application components are deployed appropriately.

More Authentication Types Supported in OpenStack
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

MiCADO now supports OpenID Connect authentication in OpenStack with Keystone's
`v3.OidcAccessToken`. MiCADO can generate the access token when required, given
a refresh token and client authentication details. These credentials should be
entered in the normal way, in the *credentials-cloud-api.yml* file.

The existing `v3.Password` authentication has been extended with the option
of specifying the User Domain - where necessary.

Support for Specifying Floating IPs in OpenStack
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Users can now specify the desired floating IP for their instance when authoring
an ADT. The floating IP must exist in the specified IP pool, and must not be
already allocated.


v0.9.1
======
Expand Down

0 comments on commit 1f6e22f

Please sign in to comment.