From dbda52f3daf980c345b3d1cd602eec318d164232 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vin=C3=ADcius=20Ferr=C3=A3o?= <2031761+viniciusferrao@users.noreply.github.com> Date: Mon, 24 Aug 2026 22:54:48 -0300 Subject: [PATCH] docs(genesis): complete repository handoff --- .../admin-guides/references/man8/mknb.8.rst | 37 +++++++++---------- .../guides/install-guides/common_sections.rst | 22 +++++------ xCAT-client/pods/man8/mknb.8.pod | 8 +++- 3 files changed, 35 insertions(+), 32 deletions(-) diff --git a/docs/source/guides/admin-guides/references/man8/mknb.8.rst b/docs/source/guides/admin-guides/references/man8/mknb.8.rst index 2ae25bfca..49ac158da 100644 --- a/docs/source/guides/admin-guides/references/man8/mknb.8.rst +++ b/docs/source/guides/admin-guides/references/man8/mknb.8.rst @@ -19,7 +19,9 @@ SYNOPSIS ******** -\ **mknb**\ \ *arch*\ +\ **mknb**\ \ *arch*\ + +\ **mknb**\ \ *arch*\ \ **-**\ **-remove-openembedded**\ *********** @@ -32,26 +34,15 @@ It creates a network boot root image (used for node discovery, BMC programming, for the same architecture that the management node is. So you normally do not need to run the \ **mknb**\ command yourself. -If you make custom changes to the network boot root image, you will need to run \ **mknb**\ again to regenerate the diskless image to include your changes. If you have an xCAT Hierarchical Cluster with Service Nodes having local /tftpboot directories (site.sharedtftp=0), you will need to copy the generated root image to each Service Node. +If you make custom changes to the network boot root image, run \ **mknb**\ again to regenerate it. In an xCAT hierarchical cluster where service nodes have local \ ``/tftpboot``\ directories (\ ``site.sharedtftp=0``\ ), install and refresh an OpenEmbedded image on the service nodes before the management node starts using its exact architecture name. Legacy images must still be copied to each service node. -An OpenEmbedded Genesis package installs an exported image under -``/opt/xcat/share/xcat/netboot/genesis-openembedded/ARCH``. \ **mknb**\ -prefers that image when it is installed. Otherwise it uses the old image under -``/opt/xcat/share/xcat/netboot/genesis/ARCH``. +An OpenEmbedded Genesis package installs an exported image under \ ``/opt/xcat/share/xcat/netboot/genesis-openembedded/ARCH``\ . \ **mknb**\ prefers that image when it is installed. Otherwise it uses the old image under \ ``/opt/xcat/share/xcat/netboot/genesis/ARCH``\ . -An export is identified by ``xcat-genesis.manifest``, which records its format -version and architecture. The directory also contains ``kernel``, -``initramfs.cpio.gz``, and ``SHA256SUMS``. \ **mknb**\ verifies the manifest -and both boot files before publishing them under the configured TFTP root. An -incomplete or invalid export leaves the current boot files unchanged. The -legacy ``fs/`` layout remains supported and is packed locally. +An export is identified by \ ``xcat-genesis.manifest``\ , which records its format version and architecture. The directory also contains \ ``kernel``\ , \ ``initramfs.cpio.gz``\ , and \ ``SHA256SUMS``\ . \ **mknb**\ verifies the manifest and both boot files before publishing them under the configured TFTP root. An incomplete or invalid export leaves the current boot files unchanged. The legacy \ ``fs/``\ layout remains supported and is packed locally. -When multiple IPv4 addresses are configured for the same network, \ **mknb**\ uses a locally assigned ``site.master`` for the xcatd endpoint, or the first address reported by the operating system when ``site.master`` is not local. POWER discovery configurations also use this address for their kernel and initrd URLs. +When multiple IPv4 addresses are configured for the same network, \ **mknb**\ uses a locally assigned \ ``site.master``\ for the xcatd endpoint, or the first address reported by the operating system when \ ``site.master``\ is not local. POWER discovery configurations also use this address for their kernel and initrd URLs. -OpenEmbedded images use the exact architecture names ``x86``, ``x86_64``, -``ppc64``, ``ppc64le``, ``armv7hf``, ``aarch64``, and ``riscv64``. If an -OpenEmbedded ``ppc64le`` image is not installed, \ **mknb**\ keeps the old -behavior and uses the legacy ``ppc64`` image. +OpenEmbedded images use the exact architecture names \ ``x86``\ , \ ``x86_64``\ , \ ``ppc64``\ , \ ``ppc64le``\ , \ ``armv7hf``\ , \ ``aarch64``\ , and \ ``riscv64``\ . If an OpenEmbedded \ ``ppc64le``\ image is not installed, \ **mknb**\ keeps the old behavior and uses the legacy \ ``ppc64``\ image. ******* @@ -60,10 +51,16 @@ OPTIONS -\ *arch*\ - +\ *arch*\ + The hardware architecture for which to build the boot image. - + + + +\ **-**\ **-remove-openembedded**\ + + Remove the published boot files for the selected OpenEmbedded architecture. Image packages use this option when they are removed. + diff --git a/docs/source/guides/install-guides/common_sections.rst b/docs/source/guides/install-guides/common_sections.rst index fc63ab6bd..0e28fb069 100644 --- a/docs/source/guides/install-guides/common_sections.rst +++ b/docs/source/guides/install-guides/common_sections.rst @@ -143,22 +143,22 @@ Unless you are downloading ``xcat-dep`` to match a specific version of xCAT, it' cd / ./mklocalrepo.sh -#. Configure the common repository if ``common`` is present in the archive. - This repository is independent of the management node operating system and - architecture: :: - - cd ~/xcat/xcat-dep/common - ./mklocalrepo.sh - - If ``common`` is not in the archive, mirror it before disconnecting the - installation network: :: +#. Mirror the common repository before disconnecting the installation network. + The xcat-dep archives do not contain this repository: :: mkdir -p ~/xcat/xcat-dep/common dnf reposync --repoid=xcat-dep-common --download-metadata \ --download-path ~/xcat/xcat-dep/common --norepopath - Run ``mklocalrepo.sh`` from the mirrored directory after copying the mirror - to the management node. + Copy the mirror to the management node and install ``xCAT-release`` from the + local xcat-core repository. Then point its common repository definition at + the mirror: :: + + sed -i \ + 's|^baseurl=.*|baseurl=file:///root/xcat/xcat-dep/common|' \ + /etc/yum.repos.d/xcat-dep-common.repo + dnf clean metadata + dnf makecache --disablerepo='*' --enablerepo=xcat-dep-common .. END_configure_xcat_local_repo_xcat-dep_RPM diff --git a/xCAT-client/pods/man8/mknb.8.pod b/xCAT-client/pods/man8/mknb.8.pod index 59c73a9c2..1e20015f0 100644 --- a/xCAT-client/pods/man8/mknb.8.pod +++ b/xCAT-client/pods/man8/mknb.8.pod @@ -6,6 +6,8 @@ B - creates a network boot root image for node discovery and flashing B I +B I B<--remove-openembedded> + =head1 DESCRIPTION @@ -14,7 +16,7 @@ It creates a network boot root image (used for node discovery, BMC programming, for the same architecture that the management node is. So you normally do not need to run the B command yourself. -If you make custom changes to the network boot root image, run B again to regenerate it. In an xCAT hierarchical cluster where service nodes have local C directories (C), copy the generated image to each service node. +If you make custom changes to the network boot root image, run B again to regenerate it. In an xCAT hierarchical cluster where service nodes have local C directories (C), install and refresh an OpenEmbedded image on the service nodes before the management node starts using its exact architecture name. Legacy images must still be copied to each service node. An OpenEmbedded Genesis package installs an exported image under C. B prefers that image when it is installed. Otherwise it uses the old image under C. @@ -32,6 +34,10 @@ OpenEmbedded images use the exact architecture names C, C, C The hardware architecture for which to build the boot image. +=item B<--remove-openembedded> + +Remove the published boot files for the selected OpenEmbedded architecture. Image packages use this option when they are removed. + =back =head1 RETURN VALUE