commit	fd9ab9e1cfca7b9fb31eb6d29b4468fdb0f515de	[log] [tgz]
author	James Feist <james.feist@linux.intel.com>	Tue May 19 13:48:07 2020 -0700
committer	James Feist <james.feist@linux.intel.com>	Thu May 28 18:02:31 2020 +0000
tree	41f94806bc5f3632100ba075a455ef8e1c09792d
parent	ac1ba02ad7a8479d1ef84fa3feeba98e8cd17a7f [diff]

FW Update: Task: Update messages

This adds reporting of percent updated and changes
"staged" to paused to indicate some further action
must happen to change state to Completed.

Tested: validator passed

 "Messages": [
    {
        "@odata.type": "#Message.v1_0_0.Message",
        "Message": "The task with id 2 has started.",
        "MessageArgs": [
            "2"
        ],
        "MessageId": "TaskEvent.1.0.1.TaskStarted",
        "Resolution": "None.",
        "Severity": "OK"
    },
    {
        "@odata.type": "#Message.v1_0_0.Message",
        "Message": "The task with id 2 has changed to progress 5 percent complete.",
        "MessageArgs": [
            "2",
            5
        ],
        "MessageId": "TaskEvent.1.0.1.TaskProgressChanged",
        "Resolution": "None.",
        "Severity": "OK"
    },
    {
        "@odata.type": "#Message.v1_0_0.Message",
        "Message": "The task with id 2 has changed to progress 10 percent complete.",
        "MessageArgs": [
            "2",
            10
        ],
        "MessageId": "TaskEvent.1.0.1.TaskProgressChanged",
        "Resolution": "None.",
        "Severity": "OK"
    },
    {
        "@odata.type": "#Message.v1_0_0.Message",
        "Message": "The task with id 2 has changed to progress 15 percent complete.",
        "MessageArgs": [
            "2",
            15
        ],
        "MessageId": "TaskEvent.1.0.1.TaskProgressChanged",
        "Resolution": "None.",
        "Severity": "OK"
    },
    {
        "@odata.type": "#Message.v1_0_0.Message",
        "Message": "The task with id 2 has changed to progress 20 percent complete.",
        "MessageArgs": [
            "2",
            20
        ],
        "MessageId": "TaskEvent.1.0.1.TaskProgressChanged",
        "Resolution": "None.",
        "Severity": "OK"
    },
    {
        "@odata.type": "#Message.v1_0_0.Message",
        "Message": "The task with id 2 has changed to progress 25 percent complete.",
        "MessageArgs": [
            "2",
            25
        ],
        "MessageId": "TaskEvent.1.0.1.TaskProgressChanged",
        "Resolution": "None.",
        "Severity": "OK"
    },
    {
        "@odata.type": "#Message.v1_0_0.Message",
        "Message": "The task with id 2 has changed to progress 30 percent complete.",
        "MessageArgs": [
            "2",
            30
        ],
        "MessageId": "TaskEvent.1.0.1.TaskProgressChanged",
        "Resolution": "None.",
        "Severity": "OK"
    },
    {
        "@odata.type": "#Message.v1_0_0.Message",
        "Message": "The task with id 2 has changed to progress 35 percent complete.",
        "MessageArgs": [
            "2",
            35
        ],
        "MessageId": "TaskEvent.1.0.1.TaskProgressChanged",
        "Resolution": "None.",
        "Severity": "OK"
    },
    {
        "@odata.type": "#Message.v1_0_0.Message",
        "Message": "The task with id 2 has changed to progress 40 percent complete.",
        "MessageArgs": [
            "2",
            40
        ],
        "MessageId": "TaskEvent.1.0.1.TaskProgressChanged",
        "Resolution": "None.",
        "Severity": "OK"
    },
    {
        "@odata.type": "#Message.v1_0_0.Message",
        "Message": "The task with id 2 has changed to progress 45 percent complete.",
        "MessageArgs": [
            "2",
            45
        ],
        "MessageId": "TaskEvent.1.0.1.TaskProgressChanged",
        "Resolution": "None.",
        "Severity": "OK"
    },
    {
        "@odata.type": "#Message.v1_0_0.Message",
        "Message": "The task with id 2 has changed to progress 50 percent complete.",
        "MessageArgs": [
            "2",
            50
        ],
        "MessageId": "TaskEvent.1.0.1.TaskProgressChanged",
        "Resolution": "None.",
        "Severity": "OK"
    },
    {
        "@odata.type": "#Message.v1_0_0.Message",
        "Message": "The task with id 2 has changed to progress 55 percent complete.",
        "MessageArgs": [
            "2",
            55
        ],
        "MessageId": "TaskEvent.1.0.1.TaskProgressChanged",
        "Resolution": "None.",
        "Severity": "OK"
    },
    {
        "@odata.type": "#Message.v1_0_0.Message",
        "Message": "The task with id 2 has changed to progress 60 percent complete.",
        "MessageArgs": [
            "2",
            60
        ],
        "MessageId": "TaskEvent.1.0.1.TaskProgressChanged",
        "Resolution": "None.",
        "Severity": "OK"
    },
    {
        "@odata.type": "#Message.v1_0_0.Message",
        "Message": "The task with id 2 has changed to progress 65 percent complete.",
        "MessageArgs": [
            "2",
            65
        ],
        "MessageId": "TaskEvent.1.0.1.TaskProgressChanged",
        "Resolution": "None.",
        "Severity": "OK"
    },
    {
        "@odata.type": "#Message.v1_0_0.Message",
        "Message": "The task with id 2 has changed to progress 70 percent complete.",
        "MessageArgs": [
            "2",
            70
        ],
        "MessageId": "TaskEvent.1.0.1.TaskProgressChanged",
        "Resolution": "None.",
        "Severity": "OK"
    },
    {
        "@odata.type": "#Message.v1_0_0.Message",
        "Message": "The task with id 2 has changed to progress 75 percent complete.",
        "MessageArgs": [
            "2",
            75
        ],
        "MessageId": "TaskEvent.1.0.1.TaskProgressChanged",
        "Resolution": "None.",
        "Severity": "OK"
    },
    {
        "@odata.type": "#Message.v1_0_0.Message",
        "Message": "The task with id 2 has changed to progress 80 percent complete.",
        "MessageArgs": [
            "2",
            80
        ],
        "MessageId": "TaskEvent.1.0.1.TaskProgressChanged",
        "Resolution": "None.",
        "Severity": "OK"
    },
    {
        "@odata.type": "#Message.v1_0_0.Message",
        "Message": "The task with id 2 has changed to progress 85 percent complete.",
        "MessageArgs": [
            "2",
            85
        ],
        "MessageId": "TaskEvent.1.0.1.TaskProgressChanged",
        "Resolution": "None.",
        "Severity": "OK"
    },
    {
        "@odata.type": "#Message.v1_0_0.Message",
        "Message": "The task with id 2 has changed to progress 90 percent complete.",
        "MessageArgs": [
            "2",
            90
        ],
        "MessageId": "TaskEvent.1.0.1.TaskProgressChanged",
        "Resolution": "None.",
        "Severity": "OK"
    },
    {
        "@odata.type": "#Message.v1_0_0.Message",
        "Message": "The task with id 2 has changed to progress 95 percent complete.",
        "MessageArgs": [
            "2",
            95
        ],
        "MessageId": "TaskEvent.1.0.1.TaskProgressChanged",
        "Resolution": "None.",
        "Severity": "OK"
    },
    {
        "@odata.type": "#Message.v1_0_0.Message",
        "Message": "The task with id 2 has changed to progress 100 percent complete.",
        "MessageArgs": [
            "2",
            100
        ],
        "MessageId": "TaskEvent.1.0.1.TaskProgressChanged",
        "Resolution": "None.",
        "Severity": "OK"
    },
    {
        "@odata.type": "#Message.v1_0_0.Message",
        "Message": "The task with id 2 has been paused.",
        "MessageArgs": [
            "2"
        ],
        "MessageId": "TaskEvent.1.0.1.TaskPaused",
        "Resolution": "None.",
        "Severity": "Warning"
    },
    {
        "@odata.type": "#Message.v1_0_0.Message",
        "Message": "The task with id 2 has Completed.",
        "MessageArgs": [
            "2"
        ],
        "MessageId": "TaskEvent.1.0.1.TaskCompletedOK",
        "Resolution": "None.",
        "Severity": "OK"
    }
],

Change-Id: I32103e53486d459fe945a8b451d2092232c12e83
Signed-off-by: James Feist <james.feist@linux.intel.com>

2 files changed

tree: 41f94806bc5f3632100ba075a455ef8e1c09792d

README.md

OpenBMC webserver

This component attempts to be a "do everything" embedded webserver for openbmc.

Capabilities

At this time, the webserver implements a few interfaces:

Authentication middleware that supports cookie and token based authentication, as well as CSRF prevention backed by linux PAM authentication credentials.
An (incomplete) attempt at replicating phosphor-dbus-rest interfaces in C++. Right now, a few of the endpoint definitions work as expected, but there is still a lot of work to be done. The portions of the interface that are functional are designed to work correctly for phosphor-webui, but may not yet be complete.
Replication of the rest-dbus backend interfaces to allow bmc debug to logged in users.
An initial attempt at a read-only redfish interface. Currently the redfish interface targets ServiceRoot, SessionService, AccountService, Roles, and ManagersService. Some functionality here has been shimmed to make development possible. For example, there exists only a single user role.
SSL key generation at runtime. See the configuration section for details.
Static file hosting. Currently, static files are hosted from the fixed location at /usr/share/www. This is intended to allow loose coupling with yocto projects, and allow overriding static files at build time.
Dbus-monitor over websocket. A generic endpoint that allows UIs to open a websocket and register for notification of events to avoid polling in single page applications. (this interface may be modified in the future due to security concerns.

Configuration

BMCWeb is configured by setting -D flags that correspond to options in bmcweb/CMakeLists.txt and then compiling. For example, cmake -DBMCWEB_ENABLE_KVM=NO ... followed by make. The option names become C++ preprocessor symbols that control which code is compiled into the program.

When BMCWeb starts running, it reads persistent configuration data (such as UUID and session data) from a local file. If this is not usable, it generates a new configuration.

When BMCWeb SSL support is enabled and a usable certificate is not found, it will generate a self-sign a certificate before launching the server. The keys are generated by the secp384r1 algorithm. The certificate

is issued by C=US, O=OpenBMC, CN=testhost,
is valid for 10 years,
has a random serial number, and
is signed using the SHA-256 algorithm.