[docs] docs (and devstack plugin) should not reference ari/aki

Bug #2074090 reported by Julia Kreger
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Ironic
Fix Released
High
Afonne-CID

Bug Description

The documentation makes use of "ari" and "aki to delineate kernel/ramdisk artifacts for doing deployment booting of machines.

That is incorrect and we shouldn't be using it. Instead the files should be uploaded to glance as "raw"

$ grep -ir " ari " doc/source
doc/source/admin/anaconda-deploy-interface.rst: openstack image create --file ./initrd.img --container-format ari \
doc/source/admin/anaconda-deploy-interface.rst: --disk-format ari --shared anaconda-ramdisk-<version>
doc/source/admin/anaconda-deploy-interface.rst: openstack image create --file ./squashfs.img --container-format ari \
doc/source/admin/anaconda-deploy-interface.rst: --disk-format ari --shared anaconda-stage-<version>
doc/source/install/configure-glance-images.rst: --disk-format ari --container-format ari --file my-image.initrd
doc/source/install/configure-glance-images.rst: --disk-format ari --container-format ari \

doc/source/admin/anaconda-deploy-interface.rst: openstack image create --file ./vmlinuz --container-format aki \
doc/source/admin/anaconda-deploy-interface.rst: --disk-format aki --shared anaconda-kernel-<version>
doc/source/install/configure-glance-images.rst: --disk-format aki --container-format aki --file my-image.vmlinuz
doc/source/install/configure-glance-images.rst: --disk-format aki --container-format aki \

This is likely rooted in the devstack plugin which actually does the wrong thing:

$ grep ari ironic

                --public --disk-format=ari \
                --container-format=ari \
$ grep aki ironic
                --public --disk-format=aki \
                --container-format=aki \

The format should be "raw" and a cursory review of the code suggests this won't be a problem to change in the plugin. When fixing the docs we should also drop in a release note to highlight that this was a documentation issue which is not anticipated to cause any issues, but operators may at some point in the future need to explicitly set "raw"

Changed in ironic:
importance: Undecided → High
status: New → Triaged
Revision history for this message
Jay Faulkner (jason-oldos) wrote :

Note: Nova is deprecating AKI/ARI. We should really get this stuff out.

Afonne-CID (cidelight)
Changed in ironic:
assignee: nobody → Afonne-CID (cidelight)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to ironic (master)

Fix proposed to branch: master
Review: https://review.opendev.org/c/openstack/ironic/+/927202

Changed in ironic:
status: Triaged → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to ironic (master)

Reviewed: https://review.opendev.org/c/openstack/ironic/+/927202
Committed: https://opendev.org/openstack/ironic/commit/aaec00275ae607aabda47aac191d01155b338a18
Submitter: "Zuul (22348)"
Branch: master

commit aaec00275ae607aabda47aac191d01155b338a18
Author: cid <email address hidden>
Date: Mon Aug 26 19:58:11 2024 +0100

    Replace reference to ari/aki

    Replace 'ari' and 'aki' with correct values for kernel/ramdisk
    artifacts.

    Closes-Bug: #2074090
    Change-Id: I5b5bcf7e081fc0865ec43ccf6a988280ec7c9273

Changed in ironic:
status: In Progress → Fix Released
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix included in openstack/ironic 26.1.0

This issue was fixed in the openstack/ironic 26.1.0 release.

To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.