ironic 20.1.0 release

meta:version: 20.1.0
meta:diff-start: -
meta:series: yoga
meta:release-type: release
meta:pypi: no
meta:first: no
meta:release:Author: Hervé Beraud <hberaud@redhat.com>
meta:release:Commit: Iury Gregory Melo Ferreira <iurygregory@gmail.com>
meta:release:Change-Id: Ib215605d10e51bbd5a084a9afad3588253bfb050
meta:release:Code-Review+2: Elod Illes <elod.illes@est.tech>
meta:release:Code-Review+2: Hervé Beraud <herveberaud.pro@gmail.com>
meta:release:Workflow+1: Hervé Beraud <herveberaud.pro@gmail.com>

Change-Id: I899e78da376c06d9f9d5bad95cdb0b494a3ca494

This is a pre-release commit for the Yoga release following our docs [1]

* No API additions during this cycle (no need to update
  doc/source/contributor/webapi-version-history.rst)
* Add prelude releasenote
* Fix highlight in one releasenote

[1] https://docs.openstack.org/ironic/latest/contributor/releasing.html

Change-Id: If26019c5abc0643051f4b11186d7eb819f9c407b

This is an advanced feature, so keep it with other advanced features,
but do link from the deploy interface listing.

Change-Id: If8a3cd4c8eca670be89d5cc1ce4a8bb788e546da

ipxe_enabled option is already removed by
34d34b3a

Change-Id: Ib96978aab60c60057dd9bc77e83ced0c95231917

Create a new Sphinx extension called 'web_api_docstring' to process
docstrings from the API classes, in order to generate API
documentation.

Story: 2009785
Task: 44291
Change-Id: Ia6b2b3741e2b1cbd29531c21795df4f0f0dc70ca

documentation

Change https://review.opendev.org/c/openstack/ironic-python-agent/+/818712
improved efficiency of storage cleaning in hybrid NVMe + HDD
environments by adding `erase_devices_express` clean step. This is a
follow up change adding the documentation for this feature.

Story: 2009264
Task: 43498
Change-Id: I33ba925460cc31cc69e58f3e3ff31a0731aee1dc

Use pycdlib to extract the content of the deploy iso to get efiboot
and grub config.

Story: 2009704
Task: 44033

Change-Id: I62cdf2a09bc4233056799b64b7fdb87ad21b5bbd

Bandit's B509 (SNMPv3 no authentication/privacy) check is
triggered by our line wrapping, as the check looks at the
number of arguments, and triggers if it only parses 3 arguments.

In Ironic's case, we pass five arguments. Presumably, this is due
to the line wrapping. Ultimately this bandit check is very new
having only been added with in the last few months.

Change-Id: Idaee72a53a1f33bcab940c6ebe1e7c113a1cb1ce

The anaconda deploy interface was saving internal information in
the node's instance_info, in the user-facing 'stage2' and
'ks_template' fields. This broke rebuilds using a different image
with different stage2 or template specified in the image properties.
This has been fixed by saving the information in the node's
driver_internal_info instead.

Addresses comments/nits from
https://review.opendev.org/c/openstack/ironic/+/827924.

Change-Id: Id9428518d21290fb38a0f7471a2cb69a6cb3ffb2

The anaconda deploy interface wasn't handling configdrive
correctly. This fixes:

- the code was incorrectly treating the config drive as a dict,
  whereas it could also be in iso6600 format,
  gzipped and base64-encoded. It is handled properly now.

- kickstart commands that deal with the config drive were added
  to the end of the kickstart file. Which means that they are
  executed after an ironic API request is sent to ironic to
  indicate that the node has been provisioned and is ready
  to be rebooted. Which means that there is a possible race
  condition wrt these commands being completed before the node
  is powered off. This has been fixed by putting the API request
  at the end of the kickstart file. Also, a sync was added to
  ensure that all modifications are written to disk.

- extra newlines ('\n') were incorrectly added to the user data content.
  This broke the content-type decoding and cloud-init was unable to
  proces them. The extra newlines have been removed.

Change-Id: If00342a1bfa3e87b2094061b0e2b0b69de3a8a4f

Change-Id: I4366c56efe62cf71ea720555fc1436b5afa82272

The proliantutils version needed is updated to 2.13.0
When running tests with older versions we get the error:
AttributeError: None does not have the attribute 'IloClient'

Change-Id: I6ab0672679c9d929c1e7c43a5966e6ad1e5353c0
Co-Authored-By: Thomas Goirand <thomas@goirand.fr>

This commit fixes incorrect code in commit
c3805b2b

There are 2 problems:
1) typo in FAT filesystem label
2) failure of running mcopy

1) typo in FAT filesystem label

   Above mentioned commit misspells VFAT label as ``ir-vfd-de``
   but it should have been ``ir-vfd-dev``

2) failure of running mcopy

   Till this commit, create_vfat_image function fails because it
   executes ``mcopy -s <tmp_dir>/*`` but it doesn't expand
   ``<tmp_dir>/*`` to list of file paths under ``<tmp_dir>``.

   This commit modifies create_vfat_image function to explicitly
   pass all file paths to mcopy.

Change-Id: I81617fcf1978f19db8d3ce4ca19341ccd51761bf
Story: 2009807
Task: 44366

Change-Id: I225203816b030aac840922d817c9952a75cb7dc2

Change-Id: I611f57f116abc5c392f907cdebc7e795f650d958

The anaconda deploy interface has a few issues that are
addressed here:

- fixes logic in get_instance_image_info() for anaconda. If the
  ironic node's instance_info doesn't have both 'stage2' and
  'ks_template' specified, we weren't using any values from the
  instance_info. This has been fixed to use values from
  instance_info if specified. Otherwise, they are set as follows:
  The 'stage2' value is taken from the image properties.
  We use the value for 'ks_template' if it is specified in the
  image properties. If not (since it is optional), we use the
  config option's '[anaconda]default_ks_template' value.
  setting.
- For anaconda's stage2 directory, we were incorrectly creating a
  directory using the full path of the stage2 file. It now
  correctly creates the right directory.
- The anaconda deploy interface expects the node's instance_info
  to be populated with the 'image_url'; added code to do that in
  PXEAnacondaDeploy's prepare() method.
- When the deploy is finished and the bm node is being rebooted,
  we incorrectly set the node's provision state to 'active'
  instead of doing it via the provisioning state machine mechanism.
- The code that was doing the validation of the kickstart file was
  incorrect and resulted in errors; this has been addressed.
- The '%traceback' section in the packaged 'ks.cfg.template' file
  is deprecated and fails validation, so it has been removed.

Change-Id: I953e948bcfa108d4c8e7b145da2f52b652e52a10