diff --git a/doc/source/admin/upgrade-guide.rst b/doc/source/admin/upgrade-guide.rst index 9c5d1d0954..e959f29739 100644 --- a/doc/source/admin/upgrade-guide.rst +++ b/doc/source/admin/upgrade-guide.rst @@ -321,127 +321,7 @@ release. migrations. If this not done, you will not be able to upgrade to Queens -- it will not be possible to execute Queens' database schema updates. -Upgrading from Ocata to Pike -============================ - -#. Use the ``ironic-dbsync online_data_migrations`` command from the 9.1.1 (or - newer) release. The one from older (9.0.0 - 9.1.0) releases could cause a - a port's physical_network information to be deleted from the database. - -#. It is required to set the ``resource_class`` field for nodes registered - with the Bare Metal service *before* using the Pike version of the Compute - service. See :ref:`enrollment` for details. - -#. It is recommended to move from old-style classic drivers to the new - hardware types after the upgrade to Pike. We expect the classic drivers to - be deprecated in the Queens release and removed in the Rocky release. - See :doc:`upgrade-to-hardware-types` for the details on the migration. - -Other upgrade instructions are in the `Pike release notes -`_. - .. toctree:: - :maxdepth: 1 + :hidden: upgrade-to-hardware-types.rst - - -Upgrading from Newton to Ocata -============================== - -There are no specific upgrade instructions other than the -`Ocata release notes `_. - - -Upgrading from Mitaka to Newton -=============================== - -There are no specific upgrade instructions other than the -`Newton release notes `_. - - -Upgrading from Liberty to Mitaka -================================ - -There are no specific upgrade instructions other than the -`Mitaka release notes `_. - - -Upgrading from Kilo to Liberty -============================== - -In-band Inspection ------------------- - -If you used in-band inspection with **ironic-discoverd**, it is highly -recommended that you switch to using **ironic-inspector**, which is a newer -(and compatible on API level) version of the same service. You have to install -**python-ironic-inspector-client** during the upgrade. This package contains a -client module for the in-band inspection service, which was previously part of -the **ironic-discoverd** package. Ironic Liberty supports the -**ironic-discoverd** service, but does not support its in-tree client module. -Please refer to -:ironic-inspector-doc:`ironic-inspector version support matrix ` -for details on which ironic versions are compatible with which -**ironic-inspector**/**ironic-discoverd** versions. - -The discoverd to inspector upgrade procedure is as follows: - -* Install **ironic-inspector** on the machine where you have - **ironic-discoverd** (usually the same as conductor). - -* Update the **ironic-inspector** configuration file to stop using deprecated - configuration options, as marked by the comments in the - :ironic-inspector-doc:`example.conf `. - It is recommended you move the configuration file to - ``/etc/ironic-inspector/inspector.conf``. - -* Shutdown **ironic-discoverd**, and start **ironic-inspector**. - -* During upgrade of each conductor instance: - - #. Shutdown the conductor. - #. Uninstall **ironic-discoverd**, - install **python-ironic-inspector-client**. - #. Update the conductor. - #. Update ``ironic.conf`` to use ``[inspector]`` section - instead of ``[discoverd]`` (option names are the same). - #. Start the conductor. - - -Upgrading from Juno to Kilo -=========================== - -When upgrading a cloud from Juno to Kilo, users must ensure the nova -service is upgraded prior to upgrading the ironic service. Additionally, -users need to set a special config flag in nova prior to upgrading to ensure -the newer version of nova is not attempting to take advantage of new ironic -features until the ironic service has been upgraded. The steps for upgrading -your nova and ironic services are as follows: - -- Edit nova.conf and ensure force_config_drive=False is set in the [DEFAULT] - group. Restart nova-compute if necessary. -- Install new nova code, run database migrations. -- Install new python-ironicclient code. -- Restart nova services. -- Install new ironic code, run database migrations, restart ironic services. -- Edit nova.conf and set force_config_drive to your liking, restarting - nova-compute if necessary. - -Note that during the period between nova's upgrade and ironic's upgrades, -instances can still be provisioned to nodes. However, any attempt by users to -specify a config drive for an instance will cause an error until ironic's -upgrade has completed. - -Cleaning --------- -A new feature starting from Kilo cycle is support for the automated cleaning -of nodes between workloads to ensure the node is ready for another workload. -This can include erasing the hard drives, updating firmware, and other steps. -For more information, see :ref:`automated_cleaning`. - -If ironic is configured with automated cleaning enabled (defaults to True) and -neutron is set as the DHCP provider (also the default), you will need to set -the `cleaning_network_uuid` option in the ironic configuration file before -starting the ironic service. See :ref:`configure-cleaning` -for information on how to set up the cleaning network for ironic. diff --git a/doc/source/index.rst b/doc/source/index.rst index 601d6b16c0..33307b2d56 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -32,13 +32,6 @@ Installation Guide install/index install/standalone - -Upgrade Guide -============= - -.. toctree:: - :maxdepth: 2 - admin/upgrade-guide User Guide