UEFI Manageability and REST Services

Transcription

1 presented by UEFI Manageability and REST Services Fall 2017 UEFI Seminar and Plugfest October 30 November 3, 2017 Presented by Abner Chang (HPE), Ting Ye (Intel) UEFI Plugfest October

2 Agenda Introduction UEFI Manageability Real Use Case: UEFI iscsi REST in UEFI Insufficient Capabilities in and Proposals for Enhancement Summary & Call to Action UEFI Plugfest October

3 Introduction UEFI Plugfest October

4 Introduction Today s platforms have amazing capabilities, but they are complex to configure Firmware configuration model is still focused on Press <DEL> to Enter Setup Remote management isn t consistent UEFI has abundant firmware manageability interfaces, and is adopting REST/Redfish, but there are still gaps in the standard UEFI Plugfest October

5 Goals Overview of UEFI manageability interfaces & Human Interface Infrastructure (HII) Examples of handling configuration data Overview of protocol Proposals to cover gaps in REST services Background of REST service provider and U Client UEFI Plugfest October

6 UEFI Manageability UEFI Plugfest October

7 UEFI Manageability Human Interface Infrastructure HII s x-uefi language Keyword Handler Configuration Namespace UEFI Plugfest October

8 Human Interface Infrastructure HII Database Package containing forms + strings Package containing forms + strings Add-in Device UEFI Driver Export Data O/S Boot Forms Browser/Processor UEFI Plugfest October

9 HII s Content Registration: HII Font, Font Ex, Font Glyph Generator HII Image, Image Ex Image Decoder HII String HII Database Browser : Config Access / Routing Form Browser HII Popup UEFI Plugfest October

10 Multiple Language Support UEFI Plugfest October

11 x-uefi: a UEFI Language machine-to-machine language String Pack Language Token #1 String Pack Language Token #1 String Pack Language Token #1 ENG BIOS Vendor SPA Vendedor de BIOS x-uefi BIOS_VENDOR_KEYWORD... String Pack Language NULL UEFI Plugfest October

12 How To Use This Language Retrieve platform exported data Get String Token of x-uefi keyword Find op-code using the string token UEFI Plugfest October

13 Real Use Case: UEFI iscsi UEFI Plugfest October

14 Real Use Case: UEFI iscsi iscsi is a popular network boot target UEFI iscsi defines a number of dynamic HII forms UEFI Plugfest October

15 UEFI Plugfest October

16 iscsi x-uefi keywords Registered to iscsiinitiatorname ReadWrite iscsimacaddr ReadWrite iscsiattemptname:# ReadOnly iscsiaddattempts ReadWrite iscsibootenable:# ReadWrite iscsideleteattempts ReadWrite iscsiconnectretry:# ReadWrite iscsidisplayattemptlist ReadOnly UEFI Plugfest October

17 x-uefi Usage Example iscsiinitiatorname VFR file string varid = ISCSI_CONFIG_IFR_NVDATA.InitiatorName, prompt = STRING_TOKEN(STR_ISCSI_CONFIG_INIT_NAME), UNI file #string STR_ISCSI_CONFIG_INIT_NAME #string STR_ISCSI_CONFIG_INIT_NAME #language en-us "iscsi Initiator Name #language x-uefi "iscsiinitiatorname" Script file IScsiScript -i iqn.edkii.intel.com UEFI Plugfest October

18 General Guidelines OEMs Get keywords definition from Use KeywordHandler.GetData/ SetData Firmware vendors Get HII updates from the latest Intel UEFI Development Kit IHVs Define and register x-uefi keywords Support keyword setting in ConfigAccess.RouteConfig Application (e.g. Browser, Management App) EFI_CONFIG_KEYWORD_HANDLER_PROTOCOL EFI_HII_CONFIG_ROUTING_PROTOCOL OEMs EFI_HII_CONFIG_ACCESS_PROTOCOL Device (e.g.motherboard, Add-in Card, etc.) Firmware Vendors 4 IHVs UEFI Plugfest October

19 REST in UEFI UEFI Plugfest October

20 REST in UEFI REST = REpresentational State Transfer (architecture) Most common client/server REST interface is HTTP HTTP protocol Client HTTP verbs like PUT, GET, POST, PATCH, HEAD and DELETE URL XML, JSON and etc. HTTP request header and body. HTTP response header and body. UEFI Plugfest October

21 How does REST Relate to UEFI? Setup Browser HII Forms HII Database Config Access / UEFI Variable Device UEFI Driver UEFI Plugfest October

22 How does REST Relate to UEFI? #x-uefi Keyword "iscsiinitiatorname" Platform Management Driver Keyword Handler Setup Browser HII Forms HII Database Device UEFI Driver EFI_REST_PROTOCOL Config Access / UEFI Variable Internet Redfish s Configure Redfish BIOS property Remotely BIOS Redfish Attribute iscsiinitiatorname" UEFI Plugfest October

23 How does REST Relate to UEFI? #x-uefi Keyword "iscsiinitiatorname" Platform Management Driver Keyword Handler Setup Browser HII Forms HII Database Device UEFI Driver EFI_REST_PROTOCOL Config Access / UEFI Variable Internet Redfish s Configure Redfish BIOS property Remotely BIOS Redfish Attribute iscsiinitiatorname" UEFI Plugfest October

24 How does REST Relate to UEFI? #x-uefi Keyword "iscsiinitiatorname" Platform Management Driver Keyword Handler HII Form HII Database Device UEFI Driver EFI_REST_PROTOCOL Config Access / UEFI Variable Internet Redfish s Configure Redfish BIOS property Remotely BIOS Redfish Attribute iscsiinitiatorname" UEFI Plugfest October

25 How does REST Relate to UEFI? #x-uefi Keyword "iscsiinitiatorname" Platform Management Driver Keyword Handler Setup Browser HII Forms HII Database Device UEFI Driver EFI_REST_PROTOCOL Config Access / UEFI Variable Redfish s Configure Redfish BIOS property Remotely BMC BIOS Redfish Attribute iscsiinitiatorname" UEFI Plugfest October

26 How does REST Relate to UEFI? #x-uefi Keyword "iscsiinitiatorname" Platform Management Driver Keyword Handler HII Form HII Database Device UEFI Driver EFI_REST_PROTOCOL Config Access / UEFI Variable Redfish s Configure Redfish BIOS property Remotely BMC BIOS Redfish Attribute iscsiinitiatorname" UEFI Plugfest October

27 How does REST Relate to UEFI? #x-uefi Keyword "iscsiinitiatorname" Platform Management Driver Keyword Handler HII Form HII Database Device UEFI Driver EFI_REST_PROTOCOL Config Access / UEFI Variable Client Redfish s Configure Redfish BIOS property Remotely BMC BIOS Redfish Attribute iscsiinitiatorname" UEFI Plugfest October

28 in UEFI Spec v2.5 use HTTP-like message as the format of REST service request and response typedef struct _EFI_REST_PROTOCOL { EFI_REST_SEND_RECEIVE SendReceive; EFI_REST_GET_TIME GetServiceTime; } EFI_REST_PROTOCOL; Client EFI_HTTP_MESSAGE EFI_HTTP_MESSAGE Response UEFI Plugfest October

29 in UEFI Spec v2.5 driver instances may use different underlying protocol to communicate with REST server. #x-uefi Keyword "iscsiinitiatorname" Client BIOS Redfish Attribute iscsiinitiatorname" Driver Instance Driver Instance Through EFI Network stack Platform specific protocol to REST server provided by BMC UEFI Plugfest October

30 Insufficient Capabilities in and Proposals for Enhancement UEFI Plugfest October

31 Are Capabilities Sufficient? Are capabilities sufficient for UEFI Manageability? Are capabilities sufficient for the modern REST Services? UEFI Plugfest October

32 Are Capabilities Sufficient? How can we support a variety of in-band/out of band UEFI management models as shown in this figure? Client Client client client Client client 1 OOB Redfish In-band OData EFI REST OOB Redfish In-band EFI REST Platform 1 Platform 2 In-band EFI REST OOB OData OOB Redfish iscsiinitiatorname" Redfish REST service Remote Redfish REST service owned by Platform 2 iscsiinitiatorname" Remote OData REST service owned by Platform 1 iscsiinitiatorname" Out of band REST driver instance In-band REST driver instance UEFI Plugfest October

33 Are Capabilities Sufficient? How can we support On-platform/Off-Platform REST services for clients? On-platform REST Service (such as BMC or others) Off-platform REST service Client Driver Client iscsiinitiatorname" iscsiinitiatorname" Client (Platform Management, HII configuration) Client iscsiinitiatorname" Client Application Client Driver Instance UEFI Plugfest October Reso urce Vendor-specific REST Service 33

34 Suggestions for Enhancements Multiple driver instances for different REST services The information of REST service The location of REST service Asynchronous request and response Address the events from REST service UEFI Plugfest October

35 Suggestions for Enhancements Multiple driver instances for different REST services Multiple driver instances can be installed on system for communicating to different REST services. The client drivers and applications can use the specific protocol to access to REST service. iscsiinitiatorname" Keyword Handler Platform Management Driver iscsiinitiatorname" iscsiinitiatorname" Vendor-specific REST Service iscsiinitiatorname" UEFI Plugfest October

36 Suggestions for Enhancements The information of REST service? Each driver instance has to provide the information about REST service it supports. This is OData REST service iscsiinitiatorname" Keyword Handler Platform Management Driver This is Redfish REST service iscsiinitiatorname" iscsiinitiatorname" This is vendorspecific REST service Vendor-specific REST Service iscsiinitiatorname" UEFI Plugfest October

37 Suggestions for Enhancements The location of REST service? Each driver instance has to provide the information about the location of REST service. On-platform REST Keyword Handler iscsiinitiatorname" Platform Management Driver This is inband REST driver instance This is out of band REST driver instance EFI EX iscsiinitiatorname" iscsiinitiatorname" This is out of band REST driver instance Vendor-specific REST Service iscsiinitiatorname" UEFI Plugfest October Off-platform REST service 37

38 Suggestions for Enhancements Synchronous request and response leads to a downtime SendReceive() function provided in protocol is synchronous transfer. client has to wait for the response once it sends the request out. Platform Management Driver Execution Timeline Response SendReceive () Downtime wait for the response iscsiinitiatorname" 38

39 Suggestions for Enhancements Asynchronous request and response Support asynchronous SendReceive() function to provide efficient REST request and response. Also provides the better user experience when users use client application Execution timeline Platform Management Driver Asynchronous Send and Receive EFI Timer Event Token Response iscsiinitiatorname" #x-uefi Keyword "iscsiinitiatorname" UEFI Plugfest October

40 Suggestions for Enhancements Address the events from REST service Most of REST service support event capability to indicate the changes of resource. User can register the event for certain type resource change such as resource created, modified, deleted and etc. Platform Management Driver Execution Timeline Subscribe Event Event Service Subscribe Event Event notification Event Token iscsiinitiatorname" #x-uefi Keyword "iscsiinitiatorname" Configure BIOS setting Remotely UEFI Plugfest October

41 Summary & Call to Action UEFI Plugfest October

42 Summary UEFI provides interfaces for improved manageability (HII, x-uefi, Keyword handle protocol, EFI REST protocol) Improvements to REST are required for adoption of standardized manageability UEFI Plugfest October

43 Call to Action Define and register more x-uefi keywords Enhance current for flexible, scalable and user friendly interfaces for Clients Asynchronous request/response in the enhanced EFI REST Event subscription for monitoring resource changes in enhanced Provide sufficient information for target REST service UEFI Plugfest October

44 Thanks for attending the Fall 2017 UEFI Plugfest For more information on the UEFI Forum and UEFI Specifications, visit presented by UEFI Plugfest October

45 Backup UEFI Plugfest October

46 What is REST? REpresentational State Transfer, which is a software architecture style. There are some constraints applied to this architecture. No client context stored in server. The necessary state is contained within request itself. *The request contains the unique identifier of resource and the request body contains the state (or state change) of that resource *The state after server processed the request is retuned in response body. Client Layered system SW, HW or middleware Uniform Interface Between client and server Nouns and Verbs Client and, separating the user interface from resource. Which improves portability and scalability. * Client don t have to concern the data storage * don t have to concern the user interface and user state. could be identified Separate resource from representation represented separately in certain formats manipulation through representations UEFI Plugfest October

47 REST in HTTP HTTP is not the only interface (protocol) for REST architecture. However, it s most commonly used in Web REST service. Any transport interface which is unified to REST service and have the well defined verb to manipulate resource could be the interface between REST server and REST client. HTTP protocol Client HTTP verbs like PUT, GET, POST, PATCH, HEAD and DELETE URL XML, JSON and etc. HTTP request header and body. HTTP response header and body. UEFI Plugfest October

48 REST Client and REST Services UEFI Plugfest October

49 REST Services There are many REST Services and Providers. Most of those services provide RESTful APIs which are Web service API adhere to REST constraints. Those are called RESTful services. openstack RESTful Service OData RESTful Service Client Redfish RESTful Service AWS RESTful Service Vendor-specific REST Service UEFI Plugfest October

50 REST Service and Client Client Driver Client Client (Platform Management, HII configuration) Client #x-uefi Keyword "iscsiinitiatorname" iscsiinitiatorname" Client Application Client Driver Instance Vendor-specific REST Service UEFI Plugfest October

51 Suggestions for Enhancements The location of REST service provided by specific driver instance Each driver instance has to provide the information about the location of REST service it supports. Out-of-band ) EFI Network Stack Client Application/Drivers In-band Underlying Interface to REST service On platform Off platform REST Service on another platform REST or web Service server on another in which platform REST the resource or web Service is owned server on another in by which platform the another resource or web platform is server owned in by which the another resource platform is owned by another platform On Platform REST Service On Platform REST Service Manage platform in out of band Remote OS REST client UEFI Plugfest October

52 Suggestions for Enhancements Asynchronous request and response Enhancement of SendReceive() function provided in protocol is synchronous transfer. EFI REST client has to wait for the response once it sends the request out. Client Execution timeline Asynchronous Send and Receive Usage example, Add Prefer: respond-async to HTTP message header Support asynchronous SendReceive() function to provide efficient REST request and response. Also provide the better user experience when users use client application EFI Timer Return HTTP 202 and URI for the status polling Check URI status for the response Event Token response Signal event token to indicate the response is ready. Return HTTP 200 to indicate the response is ready. iscsiinitiatorname" Return HTTP 202 to indicate the request is still in process. #x-uefi Keyword "iscsiinitiatorname" UEFI Plugfest October

53 Suggestions for Enhancements Asynchronous request and response Enhancement of SendReceive() function provided in protocol is synchronous transfer. EFI REST client has to wait for the response once it sends the request out. Support asynchronous SendReceive() function to provide efficient REST request and response. Also provide the better user experience when users use client application The way how REST service returns final response to REST driver instance is REST service implementation-specific and transparent to REST client. Execution Usage example, timeline Add Prefer: respond-async The content of URI which pointed to HTTP by message HTTP header Location header is REST service implementation-specific and not AsynSendReceive () Client defined in REST specification. REST EX driver instance provider should have knowledge about EFI Timer how to poll the status of returning response resource from given HTTP Location header. Event Token Signal Event token to indicate the response is ready. Return HTTP 200 to indicate the response is ready. Return HTTP 202 and URI for the status polling Check URI status for the response Return HTTP 202 to indicate the request is still in process. UEFI Plugfest October

54 Suggestions for Enhancements Address the events from REST service Enhancement of Most of REST service support event capability to indicate the changes of resource. The user can register the event for certain type resource change such as resource created, modified, deleted, etc. Client Event Service Subscribe Event Event sent to specific URI iscsiinitiatorname" #x-uefi Keyword "iscsiinitiatorname" UEFI Plugfest October Vendor-specific REST Service

55 Suggestions for Enhancements Multiple clients to access to different REST service Each child instance communicates to different REST services. Enhancement of Client Client Client Client Client UEFI Plugfest October

56 Suggestions for Enhancements Multiple clients to access to one REST service Each child instance communicates to different REST services. Or multiple child instances access to the same REST service. Enhancement of Client Client Client Client Client UEFI Plugfest October