starlingx/docs
Code Issues Proposed changes
docs/doc/source/deploy_install_guides/bootable_usb.rst
Lucas Terranova Barberio a196102577 Change links provided in doc for users 
In bullet point 4 inside the Host Setup topic, the link provided to
download the ISO gives the user too many options and unclear
instructions on wher exactly to find the ISO file. We propose that
the first link is always to the latest release and then additional
versions can be found on a second link. Other references to the
mirror are updated as well.

Additionally, on the Introduction page (https://docs.starlingx.io/),
the provided link is for release 8. We also changed it to point to
the latest release. The main page still shows the current version,
however now the change is pretty straighforwar for when new releases
come.

Closes-Bug: 2016032

Change-Id: I94201ef4f436b137f2601b033cb344d726384b55
Signed-off-by: Bruno Muniz <bruno.muniz@encora.com>
2023-04-13 20:43:27 -03:00

3.8 KiB
Raw Blame History

Create Bootable USB

Follow the instructions for your system to create a bootable USB with the StarlingX ISO:

  • bootable-usb-linux
  • bootable-usb-mac
  • bootable-usb-windows

Create a bootable USB drive on Linux*

  1. Open a terminal and get root privilege:

    sudo -s

  2. Get the latest StarlingX ISO from the CENGN StarlingX mirror. Alternately, you can get an older release ISO from here.

  3. Navigate to the directory with the StarlingX ISO.

  4. Plug in the USB drive and get its identifier:

    lsblk

    This will list available disks and their partitions.

  5. Unmount the USB drive before burning an image onto it. (Note that some Linux distros automatically mount a USB drive when it is plugged in.) For example:

    umount /dev/sdd2

  6. Burn the StarlingX bootimage.iso onto the USB drive:

    dd if=</path/to/bootimage.iso> of=<your USB device> bs=1M status=progress

Caution

Not fully unmounting the USB drive before burning an image can cause file system checksum errors. If this happens, burn the image again, ensuring all the USB drive partitions are unmounted first.

Create a bootable USB drive on macOS*

  1. Launch the Terminal app.

  2. Get the latest StarlingX ISO from the CENGN StarlingX mirror. Alternately, you can get an older release ISO from here.

  3. Navigate to the directory with the ISO.

  4. Plug in a USB drive and get its identifier:

    diskutil list

    This will list available disks and their partitions.

  5. Unmount the USB drive identified in the previous step. For example:

    diskutil umountDisk /dev/disk2

  6. Burn the StarlingX bootimage.iso onto the USB drive. The example below burns an ISO onto `<your USB device>`:

    sudo dd if=</path/to/bootimage.iso> of=<your USB device> bs=1m

    To speed up the imaging process, add an ‘r’ in front of the disk identifier. For example /dev/rdisk2.

    Press <CTL>-T to check imaging progress.

  7. Eject the USB drive.

    diskutil eject /dev/disk2

Create a bootable USB drive on Windows*

  1. Get the latest StarlingX ISO from the CENGN StarlingX mirror. Alternately, you can get an older release ISO from here.
  2. Download the Rufus utility to burn the image onto a USB drive. Only use the latest version of Rufus.
  3. Plug in the USB drive and open Rufus.
  4. Under Boot selection, click the SELECT button.
  5. Find and select the StarlingX ISO.
  6. Click the START button.
  7. When the dialogue appears, select Write in ISO image mode (Recommended).
  8. Select the Windows taskbar menu for USB and select eject.