Update README and stop posting full changelogs

Git already does quite a good job of keeping a changelog, only
create high-level release notes from now on.

(cherry picked from commit 7a7c62511c)
Also created release notes for 1.0.

Change-Id: I2ef30a4786d83d5a35788e6f2ad3532ef1aa3da0
This commit is contained in:
Dmitry Tantsur 2014-12-12 16:16:42 +01:00
parent f6b28e8244
commit feaf7f5a33
1 changed files with 59 additions and 62 deletions

View File

@ -92,7 +92,7 @@ As for PXE boot environment, you need:
* TFTP server running and accessible. * TFTP server running and accessible.
* Build and put into your TFTP directory kernel and ramdisk from the * Build and put into your TFTP directory kernel and ramdisk from the
diskimage-builder_ `discovery-ironic element`_. diskimage-builder_ `ironic-discoverd-ramdisk element`_.
You can also use `kernel`_ and `ramdisk`_ prepared for Instack. You can also use `kernel`_ and `ramdisk`_ prepared for Instack.
* You need PXE boot server (e.g. *dnsmasq*) running on **the same** machine as * You need PXE boot server (e.g. *dnsmasq*) running on **the same** machine as
*ironic-discoverd*. Don't do any firewall configuration: *ironic-discoverd* *ironic-discoverd*. Don't do any firewall configuration: *ironic-discoverd*
@ -104,8 +104,7 @@ As for PXE boot environment, you need:
label discover label discover
kernel discovery.kernel kernel discovery.kernel
append initrd=discovery.ramdisk append initrd=discovery.ramdisk discoverd_callback_url=http://{IP}:5050/v1/continue
ironic_callback_url=http://{IP}:5050/v1/continue
ipappend 3 ipappend 3
@ -115,10 +114,10 @@ As for PXE boot environment, you need:
Use `ironic-discoverd element`_ as an example for this configuration. Use `ironic-discoverd element`_ as an example for this configuration.
.. _diskimage-builder: https://github.com/openstack/diskimage-builder .. _diskimage-builder: https://github.com/openstack/diskimage-builder
.. _discovery-ironic element: https://github.com/agroup/instack-undercloud/tree/master/elements/discovery-ironic .. _ironic-discoverd-ramdisk element: https://github.com/openstack/diskimage-builder/tree/master/elements/ironic-discoverd-ramdisk
.. _ironic-discoverd element: https://github.com/agroup/instack-undercloud/tree/master/elements/ironic-discoverd .. _ironic-discoverd element: https://github.com/agroup/instack-undercloud/tree/master/elements/ironic-discoverd
.. _kernel: http://file.rdu.redhat.com/%7Ejslagle/tripleo-images-juno-source/discovery-ramdisk.kernel .. _kernel: https://repos.fedorapeople.org/repos/openstack-m/tripleo-images-rdo-juno/discovery-ramdisk.kernel
.. _ramdisk: http://file.rdu.redhat.com/%7Ejslagle/tripleo-images-juno-source/discovery-ramdisk.initramfs .. _ramdisk: https://repos.fedorapeople.org/repos/openstack-m/tripleo-images-rdo-juno/discovery-ramdisk.initramfs
Running Running
~~~~~~~ ~~~~~~~
@ -142,11 +141,14 @@ You can also use it from CLI::
python -m ironic_discoverd.client --auth-token TOKEN UUID1 UUID2 python -m ironic_discoverd.client --auth-token TOKEN UUID1 UUID2
.. note::
This CLI interface is not stable and may be changes without prior notice.
API API
--- ---
By default *ironic-discoverd* listens on ``0.0.0.0:5050``, this can be changed By default *ironic-discoverd* listens on ``0.0.0.0:5050``, this can be changed
in configuration. Protocol is JSON over HTTP; in configuration. Protocol is JSON over HTTP.
HTTP API consist of 2 endpoints: HTTP API consist of 2 endpoints:
@ -195,85 +197,80 @@ HTTP API consist of 2 endpoints:
.. _bug #1391866: https://bugs.launchpad.net/ironic-discoverd/+bug/1391866 .. _bug #1391866: https://bugs.launchpad.net/ironic-discoverd/+bug/1391866
Change Log Release Notes
---------- -------------
v1.0.0 1.0 Series
~~~~~~ ~~~~~~~~~~
1.0 is the first feature-complete release series. It's also the first series
to follow standard OpenStack processes from the beginning.
See `1.0.0 release tracking page`_ for details.
**API**
* Support updating IPMI credentials from within ramdisk.
* ``/v1/continue`` is now sync: * ``/v1/continue`` is now sync:
* Errors are properly returned to the caller * Errors are properly returned to the caller
* This call now returns value as a JSON dict * This call now returns value as a JSON dict
* Discovery now times out by default. * Support updating IPMI credentials from within ramdisk.
Set ``ipmi_setup_credentials`` in *Node* extra to ``true`` to use. Requires
manual power on after calling to ``/v1/discover``.
See `setup-ipmi-credentials blueprint`_ for details.
* Add support for plugins that hook into data processing pipeline, see * Add support for plugins that hook into data processing pipeline, see
`plugin-architecture blueprint`_ for details. `plugin-architecture blueprint`_ for details.
**Configuration**
* Cache nodes under discovery in a local SQLite database. Set ``database`` * Cache nodes under discovery in a local SQLite database. Set ``database``
configuration option to persist this database. Improves performance by configuration option to persist this database. Improves performance by
making less calls to Ironic API. making less calls to Ironic API.
* Discovery now times out by default, set ``timeout`` option to alter.
**Misc**
* Create ``CONTRIBUTING.rst``. * Create ``CONTRIBUTING.rst``.
.. _1.0.0 release tracking page: https://bugs.launchpad.net/ironic-discoverd/+milestone/1.0.0
.. _setup-ipmi-credentials blueprint: https://blueprints.launchpad.net/ironic-discoverd/+spec/setup-ipmi-credentials
.. _plugin-architecture blueprint: https://blueprints.launchpad.net/ironic-discoverd/+spec/plugin-architecture .. _plugin-architecture blueprint: https://blueprints.launchpad.net/ironic-discoverd/+spec/plugin-architecture
v0.2.5 0.2 Series
~~~~~~ ~~~~~~~~~~
* Be even more paranoid in cleaning the iptables. 0.2 is a long-term support series designed to work with OpenStack Juno
* Backport ``CONTRIBUTING.rst`` from master. release. The major changes are:
v0.2.4 **API**
~~~~~~
* Urgent fix: add requirements.txt and tox.ini to the manifest. * Authentication via Keystone for ``/v1/discover``.
* Expect ``interfaces`` instead of ``macs`` in post-back from the ramdisk
v0.2.3 **[version 0.2.1]**.
~~~~~~ * If ``interfaces`` is present, only add ports for NIC's with IP address set
**[version 0.2.1]**.
* Moved to StackForge and LaunchPad. * ``/v1/discover`` now does some sync sanity checks **[version 0.2.2]**.
v0.2.2
~~~~~~
* ``/v1/discover`` now does some sync sanity checks.
* On each start-up make several attempts to check that Ironic is available.
* Now we try a bit harder to recover firewall state on every step.
* ``discovery_timestamp`` is added to node extra on starting discovery * ``discovery_timestamp`` is added to node extra on starting discovery
(part of future fix for `bug #1391871`_). **[version 0.2.2]**.
* Actually able to start under Python 3.3 (still very experimental). * Nodes will be always put into maintenance mode before discovery
* Updated unit tests and this documentation. **[version 0.2.1]**.
.. _bug #1391871: https://bugs.launchpad.net/ironic-discoverd/+bug/1391871 **Configuration**
v0.2.1
~~~~~~
* Expect ``interfaces`` instead of ``macs`` in post-back from the ramdisk.
* If ``interfaces`` is present, only add ports for NIC's with IP address set.
* Now MAC's are white-listed for all drivers, not only SSH; option
``ssh_driver_regex`` was dropped.
* Nodes will be always put into maintenance mode before discovery.
v0.2.0
~~~~~~
* Authentication via Keystone.
* Simple client in ``ironic_discoverd.client``.
* Switch to setuptools entry points.
* Switch to tox.
* Periodic firewall update is now configurable. * Periodic firewall update is now configurable.
* SSH driver regex is now configurable. * On each start-up make several attempts to check that Ironic is available
* Supported on Python 3.3. **[version 0.2.2]**.
* Enhanced documentation.
v0.1.1 **Misc**
~~~~~~
* Added simple man page. * Simple client in ``ironic_discoverd.client``.
* Make interface configurable. * Switch to Gerrit **[version 0.2.3]**, setuptools entry points and tox.
* Preliminary supported for Python 3.3 (real support depends on Eventlet).
v0.1.0 0.1 Series
~~~~~~ ~~~~~~~~~~
* First stable release. First stable release series. Not supported any more.