summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMark Goddard <mark@stackhpc.com>2018-10-10 19:10:13 +0100
committerMark Goddard <mark@stackhpc.com>2018-10-10 19:13:21 +0100
commit9dce0488eae3a5a8a2c38a04b26ea37367dc1b66 (patch)
treed765f80deb9f98f37c87a3050cd79f1680646017
parentebf93b8dc187a9e4f40a5b1c0e0a58e13ab44006 (diff)
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
Notes
Notes (review): Code-Review+2: Nick Jones <nick@stackhpc.com> Workflow+1: Doug Szumski <doug@stackhpc.com> Verified+2: Zuul Submitted-by: Zuul Submitted-at: Fri, 12 Oct 2018 10:28:20 +0000 Reviewed-on: https://review.openstack.org/609511 Project: openstack/kayobe Branch: refs/heads/master
-rw-r--r--doc/source/index.rst12
-rw-r--r--releasenotes/source/index.rst2
-rw-r--r--releasenotes/source/ocata.rst115
-rw-r--r--releasenotes/source/pike.rst (renamed from doc/source/release-notes.rst)121
4 files changed, 120 insertions, 130 deletions
diff --git a/doc/source/index.rst b/doc/source/index.rst
index 871bce3..f5da740 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -44,15 +44,3 @@ Developer Documentation
44 :maxdepth: 2 44 :maxdepth: 2
45 45
46 development/index 46 development/index
47
48Release Notes
49-------------
50
51`Release Notes <https://kayobe-release-notes.readthedocs.io/en/latest/>`__
52
53Release notes for the Kayobe 3.1.0 release and earlier are found here:
54
55.. toctree::
56 :maxdepth: 2
57
58 release-notes
diff --git a/releasenotes/source/index.rst b/releasenotes/source/index.rst
index cd3793c..2710296 100644
--- a/releasenotes/source/index.rst
+++ b/releasenotes/source/index.rst
@@ -6,3 +6,5 @@ Kayobe Release Notes
6 :maxdepth: 1 6 :maxdepth: 1
7 7
8 unreleased 8 unreleased
9 pike
10 ocata
diff --git a/releasenotes/source/ocata.rst b/releasenotes/source/ocata.rst
new file mode 100644
index 0000000..04f8520
--- /dev/null
+++ b/releasenotes/source/ocata.rst
@@ -0,0 +1,115 @@
1==========================================
2Ocata Series (1.x.y - 2.x.y) Release Notes
3==========================================
4
5Kayobe 2.0.0
6============
7
8Kayobe 2.0.0 was released on 15th September 2017.
9
10Features
11--------
12
13* Adds support for configuration of networks for out-of-band management for
14 the overcloud and control plane hosts via the ``oob_oc_net_name`` and
15 ``oob_wl_net_name`` variables respectively.
16* Adds support for configuration of a *seed hypervisor* host. This host runs
17 the *seed VM*. Currently, configuration of host networking, NTP, and libvirt
18 storage pools and networks is supported.
19* Adds a ``base_path`` variable to simplify configuration of paths. This is
20 used to set the default value of ``image_cache_path`` and
21 ``source_checkout_path``. The default value of the base path may be set by
22 the ``$KAYOBE_BASE_PATH`` environment variable.
23* Adds a ``virtualenv_path`` variable to configure the path on which to create
24 virtual environments.
25* Uses the CentOS 7 cloud image for the seed VM by default.
26* Adds a command to deprovision the seed VM, ``kayobe seed vm deprovision``.
27* Adds support for configuration of Juniper switches.
28* Adds support for bonded (LAG) host network interfaces.
29* Adds support for the overlay docker storage driver on the seed and overcloud
30 hosts.
31* Improves the Vagrant development environment, and provides configuration for
32 a single controller with a single network.
33* Adds support for building customised Ironic Python Agent (IPA) deployment
34 images using Diskimage Builder (DIB). These can be built using the commands
35 ``kayobe seed deployment image build`` and
36 ``kayobe overcloud deployment image build``.
37* Adds a command to save overcloud introspection data,
38 ``kayobe overcloud introspection data save``.
39* Separates the external network into external and public networks. The public
40 network carries public API traffic, and is configured via
41 ``public_net_name``.
42* Adds a ``network`` group, with networking and load balancing services moved
43 to it. The group is a subgroup of the ``controllers`` group by default.
44* Decomposes the overcloud inventory into top level, components, and services.
45 This allows a deployer to customise their inventory at various levels, by
46 providing a custom inventory template for one or more sections of the
47 inventory.
48* Adds support for configuration of sysctl parameters on the seed, seed
49 hypervisor and overcloud hosts.
50* Adds an **inspection-store** container for storage of workload hardware
51 inspection data in environments without Swift.
52* Adds configuration of gatewys in provisioning and inspection networks.
53* Adds support for free-form configuration of Glance.
54* Adds support for Ubuntu Ansible control hosts.
55* Adds support for passing through host variables from kayobe to kolla-ansible.
56 By default ``ansible_host``, ``ansible_port``, and
57 ``ansible_ssh_private_key_file``.
58
59Upgrade Notes
60-------------
61
62* It is no longer necessary to set the ``seed_vm_interfaces`` variable, as
63 the seed VM's network interfaces are now determined by the standard
64 ``seed_network_interfaces`` variable.
65* If using a CentOS 7 cloud image for the seed VM, it is no longer necessary to
66 set the ``seed_vm_root_image`` variable.
67* The default value of ``kolla_enable_haproxy`` has been changed to ``True``.
68* If using a custom inventory, a ``network`` group should be added to it. If
69 the Ansible control hosts are providing networking services, then the
70 ``network`` group should be a subgroup of the ``controllers`` group.
71* The ``overcloud_groups`` variable is now determined more intelligently, and
72 it is generally no longer necessary to set it manually.
73* The provisioning network is now used to access the TFTP server during
74 workload hardware inspection.
75* A default gateway may be advertised to compute nodes during workload
76 inspection, allowing access to an ironic inspector API on the internal API
77 network.
78
79Kayobe 1.1.0
80============
81
82Kayobe 1.1.0 was released on 17th July 2017.
83
84Features
85--------
86
87* Support static routes on control plane networks
88* Improve documentation
89* Initial support for in-development Pike release
90* Upgrade kayobe Ansible control host & control plane
91* Support overcloud service destroy command
92* Support fluentd custom output configuration
93
94Kayobe 1.0.0
95============
96
971.0.0 is the first 'official' release of the Kayobe OpenStack deployment tool.
98It was released on 29th June 2017.
99
100Features
101--------
102
103This release includes the following features:
104
105* Heavily automated using Ansible
106* ``kayobe`` Command Line Interface (CLI) for cloud operators
107* Deployment of a seed VM used to manage the OpenStack control plane
108* Configuration of physical network infrastructure
109* Discovery, introspection and provisioning of control plane hardware using
110 OpenStack bifrost
111* Deployment of an OpenStack control plane using OpenStack kolla-ansible
112* Discovery, introspection and provisioning of bare metal compute hosts using
113 OpenStack ironic and ironic inspector
114* Containerised workloads on bare metal using OpenStack magnum
115* Big data on bare metal using OpenStack sahara
diff --git a/doc/source/release-notes.rst b/releasenotes/source/pike.rst
index 1dad786..68b4f89 100644
--- a/doc/source/release-notes.rst
+++ b/releasenotes/source/pike.rst
@@ -1,9 +1,6 @@
1============= 1=================================
2Release Notes 2Pike Series (3.x.y) Release Notes
3============= 3=================================
4
5Release notes are now built using reno, and will be available separately from
6the kayobe documentation for future releases.
7 4
8Kayobe 3.1.0 5Kayobe 3.1.0
9============ 6============
@@ -127,115 +124,3 @@ Upgrade Notes
127------------- 124-------------
128 125
129See the upgrade notes for the pike release of the OpenStack services in use. 126See the upgrade notes for the pike release of the OpenStack services in use.
130
131Kayobe 2.0.0
132============
133
134Kayobe 2.0.0 was released on 15th September 2017.
135
136Features
137--------
138
139* Adds support for configuration of networks for out-of-band management for
140 the overcloud and control plane hosts via the ``oob_oc_net_name`` and
141 ``oob_wl_net_name`` variables respectively.
142* Adds support for configuration of a *seed hypervisor* host. This host runs
143 the *seed VM*. Currently, configuration of host networking, NTP, and libvirt
144 storage pools and networks is supported.
145* Adds a ``base_path`` variable to simplify configuration of paths. This is
146 used to set the default value of ``image_cache_path`` and
147 ``source_checkout_path``. The default value of the base path may be set by
148 the ``$KAYOBE_BASE_PATH`` environment variable.
149* Adds a ``virtualenv_path`` variable to configure the path on which to create
150 virtual environments.
151* Uses the CentOS 7 cloud image for the seed VM by default.
152* Adds a command to deprovision the seed VM, ``kayobe seed vm deprovision``.
153* Adds support for configuration of Juniper switches.
154* Adds support for bonded (LAG) host network interfaces.
155* Adds support for the overlay docker storage driver on the seed and overcloud
156 hosts.
157* Improves the Vagrant development environment, and provides configuration for
158 a single controller with a single network.
159* Adds support for building customised Ironic Python Agent (IPA) deployment
160 images using Diskimage Builder (DIB). These can be built using the commands
161 ``kayobe seed deployment image build`` and
162 ``kayobe overcloud deployment image build``.
163* Adds a command to save overcloud introspection data,
164 ``kayobe overcloud introspection data save``.
165* Separates the external network into external and public networks. The public
166 network carries public API traffic, and is configured via
167 ``public_net_name``.
168* Adds a ``network`` group, with networking and load balancing services moved
169 to it. The group is a subgroup of the ``controllers`` group by default.
170* Decomposes the overcloud inventory into top level, components, and services.
171 This allows a deployer to customise their inventory at various levels, by
172 providing a custom inventory template for one or more sections of the
173 inventory.
174* Adds support for configuration of sysctl parameters on the seed, seed
175 hypervisor and overcloud hosts.
176* Adds an **inspection-store** container for storage of workload hardware
177 inspection data in environments without Swift.
178* Adds configuration of gatewys in provisioning and inspection networks.
179* Adds support for free-form configuration of Glance.
180* Adds support for Ubuntu Ansible control hosts.
181* Adds support for passing through host variables from kayobe to kolla-ansible.
182 By default ``ansible_host``, ``ansible_port``, and
183 ``ansible_ssh_private_key_file``.
184
185Upgrade Notes
186-------------
187
188* It is no longer necessary to set the ``seed_vm_interfaces`` variable, as
189 the seed VM's network interfaces are now determined by the standard
190 ``seed_network_interfaces`` variable.
191* If using a CentOS 7 cloud image for the seed VM, it is no longer necessary to
192 set the ``seed_vm_root_image`` variable.
193* The default value of ``kolla_enable_haproxy`` has been changed to ``True``.
194* If using a custom inventory, a ``network`` group should be added to it. If
195 the Ansible control hosts are providing networking services, then the
196 ``network`` group should be a subgroup of the ``controllers`` group.
197* The ``overcloud_groups`` variable is now determined more intelligently, and
198 it is generally no longer necessary to set it manually.
199* The provisioning network is now used to access the TFTP server during
200 workload hardware inspection.
201* A default gateway may be advertised to compute nodes during workload
202 inspection, allowing access to an ironic inspector API on the internal API
203 network.
204
205Kayobe 1.1.0
206============
207
208Kayobe 1.1.0 was released on 17th July 2017.
209
210Features
211--------
212
213* Support static routes on control plane networks
214* Improve documentation
215* Initial support for in-development Pike release
216* Upgrade kayobe Ansible control host & control plane
217* Support overcloud service destroy command
218* Support fluentd custom output configuration
219
220Kayobe 1.0.0
221============
222
2231.0.0 is the first 'official' release of the Kayobe OpenStack deployment tool.
224It was released on 29th June 2017.
225
226Features
227--------
228
229This release includes the following features:
230
231* Heavily automated using Ansible
232* ``kayobe`` Command Line Interface (CLI) for cloud operators
233* Deployment of a seed VM used to manage the OpenStack control plane
234* Configuration of physical network infrastructure
235* Discovery, introspection and provisioning of control plane hardware using
236 OpenStack bifrost
237* Deployment of an OpenStack control plane using OpenStack kolla-ansible
238* Discovery, introspection and provisioning of bare metal compute hosts using
239 OpenStack ironic and ironic inspector
240* Containerised workloads on bare metal using OpenStack magnum
241* Big data on bare metal using OpenStack sahara