starlingx/docs
Code Issues Proposed changes
docs/doc/source/node_management/kubernetes/hardware_acceleration_devices/uploading-a-device-image.rst
Ron Stone f125a8b892 Remove spurious escapes (r8,dsR8) 
This change addresses a long-standing issue in rST documentation imported from XML.
That import process added backslash escapes in front of various characters. The three
most common being '(', ')', and '_'.
These instances are removed.

Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Change-Id: Id43a9337ffcd505ccbdf072d7b29afdb5d2c997e
2023-03-01 11:19:04 +00:00

2.3 KiB
Raw Blame History

Upload a Device Image

The device image must exist where the system command is executed, such as a remote CLI, before proceeding.

Note

For images on N3000 hardware, it is recommended that the admin user uses the md5sum of the device image file as the bitstream ID. This will ensure that different files get unique IDs, and the same file gets the same ID.

  • Upload the device image.

    • To upload a root-key device image:

      ~(keystone_admin)$ system device-image-upload <imagefile> root-key <pci_vendor> <pci_device> --key-signature <key_signature> --name <imagename> --description <description> --image-version <version>

    • To upload a revocation key device image:

      ~(keystone_admin)$ system device-image-upload <imagefile> key-revocation <pci_vendor> <pci_device> --revoke-key-id <revoke_key_id> --name <imagename> --description <description> --image-version <version>

    • To upload a functional device image:

      ~(keystone_admin)$ system device-image-upload <imagefile> functional <pci_vendor> <pci_device> --functional <bitstream_id> --name <imagename> --description <description> --image-version <version>

    In the above device-image-upload commands, the following substitutions apply:

    <imagefile>

    The filepath of the binary device image file.

    <pci_vendor>

    The hexadecimal string identifying the vendor ID of the device this image applies to.

    <pci_device>

    The hexadecimal string identifying the device ID of the device this image applies to.

    <key_signature>

    A hexadecimal string identifying the root key device image.

    <revoke_key_id>

    A decimal key ID for the key revocation device image.

    <bitstream_id>

    A hexadecimal string of the functional device image.

    <name>

    The name of the device image (optional).

    <description>

    Is the description of the device image (optional).

    <image-version>

    The version of the device image (optional).