From d11811794df36587aa41d85811235af2442eac01 Mon Sep 17 00:00:00 2001 From: Julia Kreger Date: Fri, 26 Sep 2025 10:37:10 -0700 Subject: [PATCH] docs: some more outdated reference fixes Our docs still talked about tinyipa and some other outdated details and my AI agent spotted them, so this commit fixes them. Some of this was also just outdated references, bad links. Change-Id: I270255854caa917d141573638ab3ba7c5fc4f473 Signed-off-by: Julia Kreger --- doc/source/contributor/rolling-upgrades.rst | 2 +- doc/source/index.rst | 4 ++-- doc/source/install/deploy-ramdisk.rst | 17 ++++------------- doc/source/references/index.rst | 4 ++-- doc/source/user/deploy.rst | 17 ++--------------- 5 files changed, 11 insertions(+), 33 deletions(-) diff --git a/doc/source/contributor/rolling-upgrades.rst b/doc/source/contributor/rolling-upgrades.rst index a41f2ce3b5..edff12185c 100644 --- a/doc/source/contributor/rolling-upgrades.rst +++ b/doc/source/contributor/rolling-upgrades.rst @@ -134,7 +134,7 @@ all the ironic services. The default value of empty indicates that ironic-api and ironic-conductor will use the latest versions of API, RPC and IronicObjects. Its possible values -are releases, named (e.g. ``ocata``) or sem-versioned (e.g. ``7.0``). +are releases, named (e.g. ``2025.1``) or sem-versioned (e.g. ``29.0``). Internally, in `common/release_mappings.py `_, diff --git a/doc/source/index.rst b/doc/source/index.rst index ba1296e7fe..ce2129dc6d 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -26,8 +26,8 @@ be managed as though they were virtual machines. This documentation is continually updated and may not represent the state of the project at any specific prior release. To access documentation for a previous release of ironic, append the OpenStack release name to the URL; for -example, the ``ocata`` release is available at -https://docs.openstack.org/ironic/ocata/. +example, the ``2025.1`` release is available at +https://docs.openstack.org/ironic/2025.1/. Found a bug in one of our projects? Please see :doc:`/contributor/bugs`. diff --git a/doc/source/install/deploy-ramdisk.rst b/doc/source/install/deploy-ramdisk.rst index 07ff6a5e0f..c2d17370c7 100644 --- a/doc/source/install/deploy-ramdisk.rst +++ b/doc/source/install/deploy-ramdisk.rst @@ -6,28 +6,20 @@ Building or downloading a deploy ramdisk image Ironic depends on having an image with the :ironic-python-agent-doc:`ironic-python-agent (IPA) <>` service running on it for controlling and deploying bare metal nodes. +This image is not written *to* the storage of any given node, but +provides the runtime tooling and communication for the inspection, +cleaning, and ultimately deployment of a bare metal node managed by Ironic. -Two kinds of images are published on every commit from every branch of +Ironic publishes images on every commit from every branch of :ironic-python-agent-doc:`ironic-python-agent (IPA) <>` * DIB_ images are suitable for production usage and can be downloaded from https://tarballs.openstack.org/ironic-python-agent/dib/files/. - * For Train and older use CentOS 7 images. - * For Ussuri and up to Yoga use CentOS 8 images. - * For Zed and newer use CentOS 9 images. - - .. warning:: CentOS 7 images are no longer updated and must not be - used. - .. warning:: The published images will not work for dhcp-less deployments since the simple-init_ element is not present. Check the DIB_ documentation to see how to build the image. -* TinyIPA_ images are suitable for CI and testing environments and can be - downloaded from - https://tarballs.openstack.org/ironic-python-agent/tinyipa/files/. - Building from source -------------------- @@ -35,6 +27,5 @@ Check the ironic-python-agent-builder_ project for information on how to build ironic-python-agent ramdisks. .. _DIB: https://docs.openstack.org/ironic-python-agent-builder/latest/admin/dib.html -.. _TinyIPA: https://docs.openstack.org/ironic-python-agent-builder/latest/admin/tinyipa.html .. _ironic-python-agent-builder: https://docs.openstack.org/ironic-python-agent-builder/latest/ .. _simple-init: https://docs.openstack.org/diskimage-builder/latest/elements/simple-init/README.html diff --git a/doc/source/references/index.rst b/doc/source/references/index.rst index 76dd2954a9..d2ed5051cc 100644 --- a/doc/source/references/index.rst +++ b/doc/source/references/index.rst @@ -18,6 +18,6 @@ API Reference CLI References -------------- -- `Ironic CLI `_ +- `Ironic CLI `_ - :doc:`ironic-dbsync ` -- `ironic-status `_ +- `ironic-status `_ diff --git a/doc/source/user/deploy.rst b/doc/source/user/deploy.rst index 0d8bb661b4..79383933ad 100644 --- a/doc/source/user/deploy.rst +++ b/doc/source/user/deploy.rst @@ -104,8 +104,7 @@ You need to specify image information in the node's ``instance_info`` If your operating system is running in FIPS 140-2 mode, MD5 will not be available, and you **must** use SHA256 or another modern algorithm. - Starting with the Stein release of ironic-python-agent can also be a URL - to a checksums file, e.g. one generated with: + The checksum can also be a URL to a checksums file, e.g. one generated with: .. code-block:: console @@ -137,18 +136,6 @@ With a SHA256 hash: --instance-info image_type=partition \ --instance-info root_gb=10 -If you use network boot (or Ironic before Yoga), two more fields must be set: - -.. code-block:: shell - - baremetal node set $NODE_UUID \ - --instance-info image_source=http://image.server/my-image.qcow2 \ - --instance-info image_checksum=1f9c0e1bad977a954ba40928c1e11f33 \ - --instance-info image_type=partition \ - --instance-info kernel=http://image.server/my-image.kernel \ - --instance-info ramdisk=http://image.server/my-image.initramfs \ - --instance-info root_gb=10 - With a whole disk image and a checksum URL: .. code-block:: shell @@ -315,7 +302,7 @@ command, for example: Building a config drive on the conductor side ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Starting with the Stein release and ``ironicclient`` 2.7.0, you can request +In modern versions of ``python-ironicclient``, you can request building a configdrive on the server side by providing a JSON with keys ``meta_data``, ``user_data`` and ``network_data`` (all optional), e.g.: