5676e4fda4
- Migrated reorged content from wiki - Naming, title, and capitalization consistency, minor rewording in sections - Set up includes to reuse common content across pages - Introduction: remove 'openstack users' and 'kubernetes users' - Consolidate term definition into Key concepts page - Archive R1, move R2 to current releast, set up for R3 - Remove stub pages for duplicate content, or content deferred to R3 - Rework intro and contribute pages for better readability - Split Key concepts into two pages: Terms and Deployment Options - Pass for grammar, punctuation, licensing, etc. - Pull streamlined intro content into R2 install guides (from prev version) - Added R2 release note page - Update links to projects/project names to remove the "stx-" - Add instructions for creating a bootable USB Story: 2006315 Task: 36046 Change-Id: I38656fd382d1d9cf2969812c548fb7b2dc9dd31e Signed-off-by: Kristal Dale <kristal.dale@intel.com>
144 lines
3.6 KiB
ReStructuredText
144 lines
3.6 KiB
ReStructuredText
===================
|
||
Create Bootable USB
|
||
===================
|
||
|
||
Follow the instructions for your system to create a bootable USB with the
|
||
StarlingX ISO:
|
||
|
||
* :ref:`bootable-usb-linux`
|
||
* :ref:`bootable-usb-mac`
|
||
* :ref:`bootable-usb-windows`
|
||
|
||
|
||
.. _bootable-usb-linux:
|
||
|
||
--------------------------------------
|
||
Create a bootable USB drive on Linux\*
|
||
--------------------------------------
|
||
|
||
#. Open a terminal and get root privilege:
|
||
|
||
::
|
||
|
||
sudo -s
|
||
|
||
#. Get the StarlingX ISO.
|
||
This can be from a private StarlingX build or from the public Cengn StarlingX
|
||
build off the 'master' branch as shown below:
|
||
|
||
::
|
||
|
||
wget http://mirror.starlingx.cengn.ca/mirror/starlingx/release/2.0.0/centos/outputs/iso/bootimage.iso
|
||
|
||
#. Navigate to the directory with the ISO.
|
||
|
||
#. Plug in the USB drive and get its identifier:
|
||
|
||
::
|
||
|
||
lsblk
|
||
|
||
This will list available disks and their partitions.
|
||
|
||
#. 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
|
||
|
||
#. 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.
|
||
|
||
|
||
.. _bootable-usb-mac:
|
||
|
||
--------------------------------------
|
||
Create a bootable USB drive on macOS\*
|
||
--------------------------------------
|
||
|
||
#. Launch the Terminal app.
|
||
|
||
#. Get the StarlingX ISO.
|
||
This can be from a private StarlingX build or from the public Cengn StarlingX
|
||
build off the 'master' branch as shown below:
|
||
|
||
::
|
||
|
||
curl -O http://mirror.starlingx.cengn.ca/mirror/starlingx/release/2.0.0/centos/outputs/iso/bootimage.iso
|
||
|
||
#. Navigate to the directory with the ISO.
|
||
|
||
#. Plug in a USB drive and get its identifier:
|
||
|
||
::
|
||
|
||
diskutil list
|
||
|
||
This will list available disks and their partitions.
|
||
|
||
#. Unmount the USB drive identified in the previous step. For example:
|
||
|
||
::
|
||
|
||
diskutil umountDisk /dev/disk2
|
||
|
||
#. Burn the StarlingX bootimage.iso onto the USB drive.
|
||
The example below burns an ISO onto `<your USB device>`:
|
||
|
||
.. code-block:: bash
|
||
|
||
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.
|
||
|
||
#. Eject the USB drive.
|
||
|
||
.. code-block:: bash
|
||
|
||
diskutil eject /dev/disk2
|
||
|
||
.. _bootable-usb-windows:
|
||
|
||
----------------------------------------
|
||
Create a bootable USB drive on Windows\*
|
||
----------------------------------------
|
||
|
||
#. Get the StarlingX ISO.
|
||
This can be from a private StarlingX build or from the public Cengn StarlingX
|
||
build off the 'master' branch:
|
||
|
||
http://mirror.starlingx.cengn.ca/mirror/starlingx/release/2.0.0/centos/outputs/iso/bootimage.iso
|
||
|
||
#. Download the `Rufus`_ utility to burn the image onto a USB drive.
|
||
**Only use the latest version of Rufus**.
|
||
|
||
#. Plug in the USB drive and open Rufus.
|
||
|
||
#. Under `Boot selection`, click the :guilabel:`SELECT` button.
|
||
|
||
#. Find and select the StarlingX ISO.
|
||
|
||
#. Click the :guilabel:`START` button.
|
||
|
||
#. When the dialogue appears, select
|
||
:guilabel:`Write in ISO image mode (Recommended)`.
|
||
|
||
#. Select the Windows taskbar menu for USB and select eject.
|
||
|
||
.. _Rufus: https://rufus.ie/
|
||
|