OTA

# OTA Operations Portal - User Manual ***   ## Content 1. **Login, Logout and User Roles** 2. **Software Bundles (Deployments)** - 2.1. Creation of a Safety Deployment - 2.2. Deployment Details - 2.3. Deprecate a safety software version 3. **Deployment of Software Bundles** - Deployment Selection - Manual Deployment 4. **Installations & Completed Deployments** - Installations Overview - Installation Details   ***   ## 1. Login, Logout and User Roles Login to the platform relies on SSO. It's reserved to users with a Schindler account which is included in the OTA Operations group on Azure. To Request your user, if authorized, please contact an Administrator Different users, depending on their authorization level and role in the organization, can be recorded as part of different categories: |User Category |Role Description |Allowed Operations | |-- |-- |-- | |Delivery Manager|He/she is responsible to keep all installations under his/her jurisdiction updated and safe|Monitors the SW and Safety SW version of an elevator, creates and starts software deployments and ensures that the elevator is functional following a deployment, can put the elevator out of service if needed|   **Note:** Currently, the only group available is the Delivery Manager one. All users have visibility on all elevators present in the DB. To **Log-In**, simply click on the Login button that you see once you access https://gpieos-dev-ota-operations-ui.azurewebsites.net - You must access the portal via EUROPE VPN. If there are problems in logging-in with Google Chrome, inspect the page, go on the "Application" window, and click on "Clear All". Then reload the page and retry. To **Log-out** click on the arrow close to the "Delivery Manager" writing in the side menu, then choose the "Logout" option.   ***   ## 2. Software Bundles (Deployments) A Software Bundle (Also called "Deployment") is a mender package including: - The **Software Package(s)** to be installed on the elevator, including: - **SW image(s)** to be installed - **Plugin(s)** necessary to install that image(s) on the device - The **Deployment Manifest**, containing: - the **list of elevators** this software will be installed on - the various **devices** inside the elevator which will be updated - for each device, a **list of packages** containing name, file, plugin, artifact and priority - The **Signature Store TAR archive** used to verify the single components of the SW bundle with the necessary signatures - The **Signature Store SIG** used to verify the Signature Store TAR archive   **Note:** For Safety SW, the only type of software which can be currently installed via the OTA Portal, it's only possible to install the SW package on a single elevator. This will prevent safety-critical bugs to spread too rapidly. Once created with the process explained in the following chapters, the Deployment is saved on the Mender server. From there it is downloaded on the Mender Client and installed on the various nodes of the elevator. ### 2.1. Creation of a Safety Deployment This section explains **how to create a Safety software bundle** via the OTA Platform and **which details are included** in it. When logged-in as a Delivery Manager, the steps to create a Safety Software Bundle are: 1. **Click on the "Deploy SW" button** in the side menu 2. **Click on the "Safety" button** to proceed 3. **Select the SW Version to install** clicking on the corresponding row. For more details about the naming convention of SW versions please check the _Deployment Details_ (2.3) section 4. **Select the single installation to deploy that SW version to** clicking on the corresponding row. Installations are identified by the Equipment Number, the Building Name, and the Address. More details about this can be found in the _Installations_ (4) chapter 5. **Check the SW Bundle recap**, if something is not correct repeat the previous steps 6. If everything is correct, **confirm your choice with the "Save" button**   ### 2.2. Deployment Details Each Deployment contains a set of info which is visible from the OTA Portal: - **SW Version** - (e.g. 1.0.0-20211023.1) comprising the SW version (1.0.0), the build date (20211023) and the build number for that day (.1) - **SW Type** - it can be either Safety or Non-Safety, for now there will be only Safety SW packages - **Installations** - it's an array of equipment numbers, but its length will always be 1 with the current setup: Safety SW Deployments can only have 1 target. To understand where this installation is located click on the Deployment Row to open the "Deployment Details" page - **Creation Date** - **Status** - can be: - **Created** - the "Save Deployment" command has been received but the software package has not been compiled and saved on the server - **Ready** - the Deployment has been saved on the Mender server and is ready to be installed on the target elevator(s) - **Starting** - the Deployment is being created on Mender. This status should not be visible on the portal. - **InProgress** - the Installation has started but is not completed yet - **Completed** - the Installation was successful - **Error** - the Deployment Saving or Installation was not successful. It's necessary to create a new software bundle and install it again   ### 2.3. Deprecate safety software version When a safety software version is not longer valid, it can be marked as deprecated. When a specific safety software version marked as deprecated: - it cannot be used anymore to create new deployment - any existing deployment based on that safety software version will be deprecated as well - each elevator running a deprecated safety software version set out of service   ***   ## 3. Deployment of Software Bundles Deploying a new Safety SW Bundle (Deployment) is the process Delivery Managers use to keep EOS Installations safe and up to date.\ A Deployment can be triggered **manually** or, in the future, **automatically** (by setting the time and date). In any case, the installation on the various nodes will only start if the elevator has not received any calls in the past five minutes, otherwise it will be postponed until this condition is met. This section explains **how to select and install a deployment** which was created following the instructions in the previous section. ### 3.1. Deployment Selection To start the installation of a specific software bundle, also referred to as "Deployment", visit the **Deployments Page** available in the side menu. This page includes all software bundles created by the logged-in Delivery Manager, regardless of their status.\ The "Ready" deployments (indicated as a light blue box) are SW Bundles ready to be installed.\ Deployments in this page are sorted by date (most recently modified ones on top). Filters are available to help you in the process: - Click on **"Pending Deployments"** to see all deployments with status Created or Ready - _see section 2.3 for more details_. These are the deployments that have not been installed on their target yet - Click on **"Closed Deployments"** to see all deployments with status Complete, InProgress or Error - _see section 2.3 for more details_   Once you have located the correct deployment, click on it to open the **Deployment Details** page, containing information about the deployment itself, the installations included in it, and a button to launch it manually.\   ### 3.2. Manual Deployment A manual deployment allows the Delivery Manager to start a software bundle installation immediately. More precisely, when a manual deployment is triggered, the download is started and, when completed and anyway after 5 minutes without any calls for the target, the installation on the various nodes is also started. To lunch a deployment manually, once a software bundle has been selected as explained in the _Software Bundle Selection_ (3.2) section, **click on the "Start Now" button** on the bottom-right of the screen, then **confirm your choice on the confirmation PopUp** **"Start Now" button disabled in two cases** - deployment status not "Ready" - user do not have rights to start deployment on selected installation Once this step is complete, you should immediately see the status of your Deployment changed to "InProgress" in the "Deployments" page. After a few minutes the status will change again in either Complete or Error.   ***   ## 4. Installations & Completed Deployments The OTA portal gives each delivery manager the possibility to monitor the installations under his/her jurisdiction, which in the current state of the portal includes **all elevators**. This section explains **how to monitor an elevator** and **which details can be observed** from the portal. ### 4.1. Installations Overview To get an overview of the state of the elevator, a Delivery Manager can select the **"Installations"** page in the side menu. In this page a list of all installations under the logged-in delivery manager's jurisdiction can be found. This list contains details about the **installation name**, **building name**, **address** and **Safety SW Version**. At the moment, there is no possibility to filter or sort this list. ### 4.2. Installation Details To get a complete view on the details of an installation and its OTA updates history, when in the "Installations" page, click on the installation you are interested in. The page that opens has **details about the installation itself** on the top-left, **details about the installed Safety SW version** on the top-right, and a **complete list of OTA Operations** which were successful or failed on that installation on the bottom. The OTA History table is ordered with the most recently updated deployments on top. Clicking on each row of this table it's possible to go to the "Deployment Details" page for that deployment.