From a692673b900bd0b7004d9fb10e50e6471b8361da Mon Sep 17 00:00:00 2001 From: Julia Kreger Date: Tue, 29 Aug 2023 07:53:11 -0700 Subject: [PATCH] Deprecate legacy deployment elements Legacy elements deploy-tgtadm, deploy-targetcli, and deploy-baremetal have not seen use in ages. Another element seems to date back to this, deploy-kexec, but appears to see no actual use as the underlying methods leveraged by these elements were long moved away from. iSCSI based deployment being the last, and even then it required the ironic-python-agent. Change-Id: Ib5b3a7690c35d6859e2e0fdac2326dcd16c051d3 --- diskimage_builder/elements/deploy-baremetal/README.rst | 5 +++++ diskimage_builder/elements/deploy-targetcli/README.rst | 8 +++++++- diskimage_builder/elements/deploy-tgtadm/README.rst | 8 +++++++- ...cation-of-legacy-deploy-elements-1665af6e87103c5f.yaml | 8 ++++++++ 4 files changed, 27 insertions(+), 2 deletions(-) create mode 100644 releasenotes/notes/deprecation-of-legacy-deploy-elements-1665af6e87103c5f.yaml diff --git a/diskimage_builder/elements/deploy-baremetal/README.rst b/diskimage_builder/elements/deploy-baremetal/README.rst index 3e175840c..2f0d6edc5 100644 --- a/diskimage_builder/elements/deploy-baremetal/README.rst +++ b/diskimage_builder/elements/deploy-baremetal/README.rst @@ -3,3 +3,8 @@ deploy-baremetal ================ A ramdisk that will expose the machine primary disk over iSCSI and reboot once baremetal-deploy-helper signals it is finished. + +.. Warning:: + + Ironic has not supported this style of deployment element since it's + early days. Please consult `ironic-python-agent-builder `_. diff --git a/diskimage_builder/elements/deploy-targetcli/README.rst b/diskimage_builder/elements/deploy-targetcli/README.rst index 00a522c8c..868284d58 100644 --- a/diskimage_builder/elements/deploy-targetcli/README.rst +++ b/diskimage_builder/elements/deploy-targetcli/README.rst @@ -1,7 +1,13 @@ deploy-targetcli ================ -Use targetcli for the deploy ramdisk +Use targetcli for the deploy ramdisk for iSCSI deployments. + +.. Warning:: + Ironic has removed the iSCSI deployment interface, it was last available + in Wallaby, and even then had to be launched by the ironic-python-agent. + This element is from the early days of baremetal deployment and is + deprecated. Provides the necessary scripts and dependencies to use targetcli for exporting the iscsi target in the deploy ramdisk. diff --git a/diskimage_builder/elements/deploy-tgtadm/README.rst b/diskimage_builder/elements/deploy-tgtadm/README.rst index 466be8fd7..78f2b830f 100644 --- a/diskimage_builder/elements/deploy-tgtadm/README.rst +++ b/diskimage_builder/elements/deploy-tgtadm/README.rst @@ -1,7 +1,13 @@ deploy-tgtadm ============= -Use tgtadm and tgtd for the deploy ramdisk +Use tgtadm and tgtd for the deploy ramdisk for iSCSI deployments. + +.. Warning:: + Ironic has removed the iSCSI deployment interface, it was last available + in Wallaby, and even then had to be launched by the ironic-python-agent. + This element is from the early days of baremetal deployment and is + deprecated. Provides the necessary scripts and dependencies to use tgtadm and tgtd for exporting the iscsi target in the deploy ramdisk. diff --git a/releasenotes/notes/deprecation-of-legacy-deploy-elements-1665af6e87103c5f.yaml b/releasenotes/notes/deprecation-of-legacy-deploy-elements-1665af6e87103c5f.yaml new file mode 100644 index 000000000..fff977e99 --- /dev/null +++ b/releasenotes/notes/deprecation-of-legacy-deploy-elements-1665af6e87103c5f.yaml @@ -0,0 +1,8 @@ +--- +deprecations: + - | + The ``deploy-baremetal``, ``deploy-kexec``, ``deploy-tgtadm``, + and ``deploy-targetcli`` elements are deprecated and will be removed in a + future release of diskimage-builder. The origins of the elemenets largely + dates back to the early efforts to support baremetal deployment, and the + methods have been long ago moved away from.