From 9dce0488eae3a5a8a2c38a04b26ea37367dc1b66 Mon Sep 17 00:00:00 2001 From: Mark Goddard Date: Wed, 10 Oct 2018 19:10:13 +0100 Subject: [PATCH] Merge pre-reno release notes with reno notes Prior to the Queens release, release notes were added to the kayobe sphinx documentation. During the Queens release cycle they were changed to be generated via the reno tool. This change moves the pre-Queens release notes to the reno source, ensuring that all release notes are available in one place. Change-Id: I9606cbe50aacc498a645bff163e3d2dafac198e3 --- doc/source/index.rst | 12 -- releasenotes/source/index.rst | 2 + releasenotes/source/ocata.rst | 115 +++++++++++++++++ .../source/pike.rst | 121 +----------------- 4 files changed, 120 insertions(+), 130 deletions(-) create mode 100644 releasenotes/source/ocata.rst rename doc/source/release-notes.rst => releasenotes/source/pike.rst (54%) diff --git a/doc/source/index.rst b/doc/source/index.rst index 871bce341..f5da74010 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -44,15 +44,3 @@ Developer Documentation :maxdepth: 2 development/index - -Release Notes -------------- - -`Release Notes `__ - -Release notes for the Kayobe 3.1.0 release and earlier are found here: - -.. toctree:: - :maxdepth: 2 - - release-notes diff --git a/releasenotes/source/index.rst b/releasenotes/source/index.rst index cd3793c5c..271029662 100644 --- a/releasenotes/source/index.rst +++ b/releasenotes/source/index.rst @@ -6,3 +6,5 @@ Kayobe Release Notes :maxdepth: 1 unreleased + pike + ocata diff --git a/releasenotes/source/ocata.rst b/releasenotes/source/ocata.rst new file mode 100644 index 000000000..04f8520ed --- /dev/null +++ b/releasenotes/source/ocata.rst @@ -0,0 +1,115 @@ +========================================== +Ocata Series (1.x.y - 2.x.y) Release Notes +========================================== + +Kayobe 2.0.0 +============ + +Kayobe 2.0.0 was released on 15th September 2017. + +Features +-------- + +* Adds support for configuration of networks for out-of-band management for + the overcloud and control plane hosts via the ``oob_oc_net_name`` and + ``oob_wl_net_name`` variables respectively. +* Adds support for configuration of a *seed hypervisor* host. This host runs + the *seed VM*. Currently, configuration of host networking, NTP, and libvirt + storage pools and networks is supported. +* Adds a ``base_path`` variable to simplify configuration of paths. This is + used to set the default value of ``image_cache_path`` and + ``source_checkout_path``. The default value of the base path may be set by + the ``$KAYOBE_BASE_PATH`` environment variable. +* Adds a ``virtualenv_path`` variable to configure the path on which to create + virtual environments. +* Uses the CentOS 7 cloud image for the seed VM by default. +* Adds a command to deprovision the seed VM, ``kayobe seed vm deprovision``. +* Adds support for configuration of Juniper switches. +* Adds support for bonded (LAG) host network interfaces. +* Adds support for the overlay docker storage driver on the seed and overcloud + hosts. +* Improves the Vagrant development environment, and provides configuration for + a single controller with a single network. +* Adds support for building customised Ironic Python Agent (IPA) deployment + images using Diskimage Builder (DIB). These can be built using the commands + ``kayobe seed deployment image build`` and + ``kayobe overcloud deployment image build``. +* Adds a command to save overcloud introspection data, + ``kayobe overcloud introspection data save``. +* Separates the external network into external and public networks. The public + network carries public API traffic, and is configured via + ``public_net_name``. +* Adds a ``network`` group, with networking and load balancing services moved + to it. The group is a subgroup of the ``controllers`` group by default. +* Decomposes the overcloud inventory into top level, components, and services. + This allows a deployer to customise their inventory at various levels, by + providing a custom inventory template for one or more sections of the + inventory. +* Adds support for configuration of sysctl parameters on the seed, seed + hypervisor and overcloud hosts. +* Adds an **inspection-store** container for storage of workload hardware + inspection data in environments without Swift. +* Adds configuration of gatewys in provisioning and inspection networks. +* Adds support for free-form configuration of Glance. +* Adds support for Ubuntu Ansible control hosts. +* Adds support for passing through host variables from kayobe to kolla-ansible. + By default ``ansible_host``, ``ansible_port``, and + ``ansible_ssh_private_key_file``. + +Upgrade Notes +------------- + +* It is no longer necessary to set the ``seed_vm_interfaces`` variable, as + the seed VM's network interfaces are now determined by the standard + ``seed_network_interfaces`` variable. +* If using a CentOS 7 cloud image for the seed VM, it is no longer necessary to + set the ``seed_vm_root_image`` variable. +* The default value of ``kolla_enable_haproxy`` has been changed to ``True``. +* If using a custom inventory, a ``network`` group should be added to it. If + the Ansible control hosts are providing networking services, then the + ``network`` group should be a subgroup of the ``controllers`` group. +* The ``overcloud_groups`` variable is now determined more intelligently, and + it is generally no longer necessary to set it manually. +* The provisioning network is now used to access the TFTP server during + workload hardware inspection. +* A default gateway may be advertised to compute nodes during workload + inspection, allowing access to an ironic inspector API on the internal API + network. + +Kayobe 1.1.0 +============ + +Kayobe 1.1.0 was released on 17th July 2017. + +Features +-------- + +* Support static routes on control plane networks +* Improve documentation +* Initial support for in-development Pike release +* Upgrade kayobe Ansible control host & control plane +* Support overcloud service destroy command +* Support fluentd custom output configuration + +Kayobe 1.0.0 +============ + +1.0.0 is the first 'official' release of the Kayobe OpenStack deployment tool. +It was released on 29th June 2017. + +Features +-------- + +This release includes the following features: + +* Heavily automated using Ansible +* ``kayobe`` Command Line Interface (CLI) for cloud operators +* Deployment of a seed VM used to manage the OpenStack control plane +* Configuration of physical network infrastructure +* Discovery, introspection and provisioning of control plane hardware using + OpenStack bifrost +* Deployment of an OpenStack control plane using OpenStack kolla-ansible +* Discovery, introspection and provisioning of bare metal compute hosts using + OpenStack ironic and ironic inspector +* Containerised workloads on bare metal using OpenStack magnum +* Big data on bare metal using OpenStack sahara diff --git a/doc/source/release-notes.rst b/releasenotes/source/pike.rst similarity index 54% rename from doc/source/release-notes.rst rename to releasenotes/source/pike.rst index 1dad78602..68b4f89bf 100644 --- a/doc/source/release-notes.rst +++ b/releasenotes/source/pike.rst @@ -1,9 +1,6 @@ -============= -Release Notes -============= - -Release notes are now built using reno, and will be available separately from -the kayobe documentation for future releases. +================================= +Pike Series (3.x.y) Release Notes +================================= Kayobe 3.1.0 ============ @@ -127,115 +124,3 @@ Upgrade Notes ------------- See the upgrade notes for the pike release of the OpenStack services in use. - -Kayobe 2.0.0 -============ - -Kayobe 2.0.0 was released on 15th September 2017. - -Features --------- - -* Adds support for configuration of networks for out-of-band management for - the overcloud and control plane hosts via the ``oob_oc_net_name`` and - ``oob_wl_net_name`` variables respectively. -* Adds support for configuration of a *seed hypervisor* host. This host runs - the *seed VM*. Currently, configuration of host networking, NTP, and libvirt - storage pools and networks is supported. -* Adds a ``base_path`` variable to simplify configuration of paths. This is - used to set the default value of ``image_cache_path`` and - ``source_checkout_path``. The default value of the base path may be set by - the ``$KAYOBE_BASE_PATH`` environment variable. -* Adds a ``virtualenv_path`` variable to configure the path on which to create - virtual environments. -* Uses the CentOS 7 cloud image for the seed VM by default. -* Adds a command to deprovision the seed VM, ``kayobe seed vm deprovision``. -* Adds support for configuration of Juniper switches. -* Adds support for bonded (LAG) host network interfaces. -* Adds support for the overlay docker storage driver on the seed and overcloud - hosts. -* Improves the Vagrant development environment, and provides configuration for - a single controller with a single network. -* Adds support for building customised Ironic Python Agent (IPA) deployment - images using Diskimage Builder (DIB). These can be built using the commands - ``kayobe seed deployment image build`` and - ``kayobe overcloud deployment image build``. -* Adds a command to save overcloud introspection data, - ``kayobe overcloud introspection data save``. -* Separates the external network into external and public networks. The public - network carries public API traffic, and is configured via - ``public_net_name``. -* Adds a ``network`` group, with networking and load balancing services moved - to it. The group is a subgroup of the ``controllers`` group by default. -* Decomposes the overcloud inventory into top level, components, and services. - This allows a deployer to customise their inventory at various levels, by - providing a custom inventory template for one or more sections of the - inventory. -* Adds support for configuration of sysctl parameters on the seed, seed - hypervisor and overcloud hosts. -* Adds an **inspection-store** container for storage of workload hardware - inspection data in environments without Swift. -* Adds configuration of gatewys in provisioning and inspection networks. -* Adds support for free-form configuration of Glance. -* Adds support for Ubuntu Ansible control hosts. -* Adds support for passing through host variables from kayobe to kolla-ansible. - By default ``ansible_host``, ``ansible_port``, and - ``ansible_ssh_private_key_file``. - -Upgrade Notes -------------- - -* It is no longer necessary to set the ``seed_vm_interfaces`` variable, as - the seed VM's network interfaces are now determined by the standard - ``seed_network_interfaces`` variable. -* If using a CentOS 7 cloud image for the seed VM, it is no longer necessary to - set the ``seed_vm_root_image`` variable. -* The default value of ``kolla_enable_haproxy`` has been changed to ``True``. -* If using a custom inventory, a ``network`` group should be added to it. If - the Ansible control hosts are providing networking services, then the - ``network`` group should be a subgroup of the ``controllers`` group. -* The ``overcloud_groups`` variable is now determined more intelligently, and - it is generally no longer necessary to set it manually. -* The provisioning network is now used to access the TFTP server during - workload hardware inspection. -* A default gateway may be advertised to compute nodes during workload - inspection, allowing access to an ironic inspector API on the internal API - network. - -Kayobe 1.1.0 -============ - -Kayobe 1.1.0 was released on 17th July 2017. - -Features --------- - -* Support static routes on control plane networks -* Improve documentation -* Initial support for in-development Pike release -* Upgrade kayobe Ansible control host & control plane -* Support overcloud service destroy command -* Support fluentd custom output configuration - -Kayobe 1.0.0 -============ - -1.0.0 is the first 'official' release of the Kayobe OpenStack deployment tool. -It was released on 29th June 2017. - -Features --------- - -This release includes the following features: - -* Heavily automated using Ansible -* ``kayobe`` Command Line Interface (CLI) for cloud operators -* Deployment of a seed VM used to manage the OpenStack control plane -* Configuration of physical network infrastructure -* Discovery, introspection and provisioning of control plane hardware using - OpenStack bifrost -* Deployment of an OpenStack control plane using OpenStack kolla-ansible -* Discovery, introspection and provisioning of bare metal compute hosts using - OpenStack ironic and ironic inspector -* Containerised workloads on bare metal using OpenStack magnum -* Big data on bare metal using OpenStack sahara