Notes on ONU upgrade procedures using the openonu-go adapter

Openonu-go adapter supports the download and activation of new ONU software from some external http(s) server to the ONUs over the OMCI channel. There are three relevant voltctl (image) commands for the ONU upgrade procedure:

  • voltctl device onuimage list

  • voltctl device onuimage status

  • voltctl device onuimage download

  • voltctl device onuimage activate

  • voltctl device onuimage commit

  • voltctl device onuimage abort

The complete ONU upgrade process consists of:

  • downloading the requested ONU Image from some http(s) server that must be reachable from the VOLTHA stack

  • transferring this image via the OMCI communication channel to the concerned ONU based on the software image activities as defined in the G.988 specification

  • activating the image on the ONU (which should result into some autonomous ONU reboot)

  • committing the new image if it was detected to work correctly

Preconditions:

  • HTTP(s)/IP connectivity is given between the VOLTHA stack and the indicated HTTP(s) server

  • ONU uses dual image control handling (image ID usage 0 and 1 according to G.988)

  • ONU supports software download via the OMCI communication channel as per G.988

The command syntax is based on upgrading one specific ONU of the system. The concerned <onu-device-id> can e.g. be found by using this command and taking the ‘ID’ field from the response:

voltctl device list -f Type~brcm_openomci_onu

Images list on the Onu

The syntax of the complete voltctl command is:

voltctl device onuimage list <onu-device-id>

This command displays OMIC information on the active and standby images on the device.

Here is some example output for this command:

VERSION           ISCOMMITED    ISACTIVE    ISVALID    PRODUCTCODE    HASH
090140.1.0.304    true          true        true                      00000000000000000000000000000000
090140.9.9.308    false         false       false                     00000000000000000000000000000000

The command output lists:

  • the VERSION the version of each image

  • the ISCOMMITED is the image commited on the ONU

  • the ISACTIVE is the image active on the ONU

  • the ISVALID is the image valide for that ONU

  • the PRODUCTCODE infomration about the image that can be provided by the ONU via OMCI. (optional)

  • the HASH infomration about the image that can be provided by the ONU via OMCI. (optional)

All the attributes specified in the output of this command are retrieved from the ONU via OMCI as per G.988 specification.

Image status display

The syntax of the complete voltctl command is:

voltctl device onuimage status <image-version> <onu-device-ids>

with:

  • <image-version>: version of the image, e.g 090140.1.0.304.

  • <onu-device-ids>: set of devices for which to display the status of the given image.

Here is some example output for this command:

DEVICEID                                IMAGESTATE.VERSION    IMAGESTATE.DOWNLOADSTATE    IMAGESTATE.REASON    IMAGESTATE.IMAGESTATE
420792c1-84fb-465a-a775-283e54247be9    090140.1.0.304        DOWNLOAD_SUCCEEDED          NO_ERROR             IMAGE_INACTIVE

The command output lists:

  • the DOWNLOADSTATE with values defined in the protobuf implementation for the image download

  • the IMAGESTATE with values defined in the protobuf implementation for the image activation

  • the REASON with values defined in the protobuf implementation for the image failure reasons

This command exposes the status of operations in relation to an image on one or multiple devices.

In above example output the given states indicate that for image software-image.img the download first to the openonu-go adapter and then to the ONU was correctly done. The image is in the inactive ONU partition (not yet activated).

Image download from http(s) server to the Onu

The syntax of the complete voltctl command is:

voltctl device onuimage download <image-version> <image-url> <image-vendor> <activate-on-success> <commit-on-success> <crc> <onu-device-ids>

with:

  • <image-version>: version of the image, e.g 090140.1.0.304.

  • <image-url>: A full path of the location of the image in a given location, e.g. http://10.103.21.52:8080/downloads/090140.1.0.304.img .

  • <image-vendor>: the ONU vendor for which the image can be used, e.g. SCOM.

  • <activate-on-success>: activate the image automatically if the download is successful.

  • <commit-on-success>: commits the image automatically on succesful reboot of the ONU after activation.

  • <crc>: the crc of the image as described in OMCI specification. Can be set to 0, in which case the onu adapter will compute it.

  • <onu-device-ids>: set of devices on which to activate the given image.

A sample output of this command is:

DEVICEID                                IMAGESTATE.VERSION    IMAGESTATE.DOWNLOADSTATE    IMAGESTATE.REASON    IMAGESTATE.IMAGESTATE
420792c1-84fb-465a-a775-283e54247be9    090140.1.0.304        DOWNLOAD_STARTED            NO_ERROR             IMAGE_DOWNLOADING

This command downloads the given image on one or multiple devices. First it fetches the image from and http(s) server if the image is not already present in the openonu adapter. It then transfers the image to the device via OMCI, placing it in the standby partition.

The processing of the command can basically be verified with above given image status command, where the DOWNLOADSTATE defines the progress of this activity. Depending on the file size and the IP connectivity the transfer may take some seconds up to minutes. Image status directly on the ONU device can always be performed by the list command.

The download fails e.g. in case the image cannot be found on the server, in which case the DOWNLOADSTATE goes to “DOWNLOAD_FAILED”

If the ActivateOnSuccess flag is set the adapter will automatically activate the image upon successful download to the ONU. If the CommitOnSuccess flag is set the adapter will automatically commit the image upon successful reboot of the ONU.

Image activation on the onu

The syntax of the complete voltctl command is:

voltctl device onuimage activate <image-version> <commit-on-success> <onu-device-ids>

with:

  • <image-version>: version of the image, the same identifier as used in the download and activate command

  • <commit-on-success>: commits the image automatically if activation is successful.

  • <onu-device-ids>: set of devices on which to activate the given image.

A sample output of this command is:

DEVICEID                                IMAGESTATE.VERSION    IMAGESTATE.DOWNLOADSTATE    IMAGESTATE.REASON    IMAGESTATE.IMAGESTATE
420792c1-84fb-465a-a775-283e54247be9    090140.1.0.304        DOWNLOAD_SUCCEEDED          NO_ERROR             IMAGE_ACTIVATING

This command activates the given image on one or multiple devices, if the requested image is in the inactive ONU partition. This implies the switching of the active partition and reboot of the ONU. Effectively moves the image from the standby to the active partition. The previously standby image will be active after the ONU re-start. If the image for which the activate request arrives is already in the active partition no action will be taken.

The processing of the command can be verified by checking the IMAGESTATE in the initial output of the command and then in result of the above given image status command. Image status directly on the ONU device can always be performed by the list command.

If the CommitOnSuccess flag is set the adapter will automatically commit the image upon successful reboot of the ONU.

Image commit on the Onu

The syntax of the complete voltctl command is:

voltctl device onuimage commit <image-version> <onu-device-ids>

with:

  • <image-version>: version of the image, the same identifier as used in the download and activate command

  • <onu-device-ids>: set of devices on which to commit the given image.

A sample output of this command is:

DEVICEID                                IMAGESTATE.VERSION    IMAGESTATE.DOWNLOADSTATE    IMAGESTATE.REASON    IMAGESTATE.IMAGESTATE
420792c1-84fb-465a-a775-283e54247be9    090140.1.0.304        DOWNLOAD_UNKNOWN            NO_ERROR             IMAGE_COMMITTING

This command commits the given image on one or multiple devices. The commit command confirms the image on the active partition to be the default one upon reboot.

The processing of the command can be verified by checking the IMAGESTATE in the initial output of the command and then in result of the above given image status command.

The result of this command in the list should be that the desired image is also printed on the active partition and its IsCommitted and IsActive flags are set to true.

Image activity abort

The syntax of the complete voltctl command is:

voltctl device onuimage abort <image-version> <onu-device-ids>

with:

  • <image-version>: version of the image, the same identifier as used in the download activate and commit commands

  • <onu-device-ids>: set of devices on which to abort image processing.

A sample output of this command is:

DEVICEID                                IMAGESTATE.VERSION    IMAGESTATE.DOWNLOADSTATE    IMAGESTATE.REASON    IMAGESTATE.IMAGESTATE
420792c1-84fb-465a-a775-283e54247be9    090140.1.0.304        DOWNLOAD_UNKNOWN            NO_ERROR             IMAGE_ACTIVATION_ABORTING

This command aborts any upgrade related activity that the adapter is performing in relation to the given image for the one or multiple devices. This command does not imply any automated activity by the system to bring the ONU upgrade status to a previous or more consistent state. If required some further commands can be used to try to bring the ONU into the desired upgrade state.

The processing of the command can be verified with above given image status command, where the IMAGESTATE defines the progress of this activity. Image status directly on the ONU device can always be performed by the list command.