Browse Source

Add spec for Huawei iBMC driver

This spec proposes to add Power and Management interfaces for Huawei's
iBMC Driver.

Change-Id: If66303dfdeefb667b28d85ee0481fb268e65f71d
Story: 2004635
Bill Chan 3 months ago
parent
commit
d9a8625186
2 changed files with 178 additions and 0 deletions
  1. 177
    0
      specs/approved/ibmc-driver.rst
  2. 1
    0
      specs/not-implemented/ibmc-driver.rst

+ 177
- 0
specs/approved/ibmc-driver.rst View File

@@ -0,0 +1,177 @@
1
+..
2
+ This work is licensed under a Creative Commons Attribution 3.0 Unported
3
+ License.
4
+
5
+ http://creativecommons.org/licenses/by/3.0/legalcode
6
+
7
+**********************
8
+Huawei iBMC Driver
9
+**********************
10
+
11
+https://storyboard.openstack.org/#!/story/2004635
12
+
13
+This specification proposes to add new interfaces that provide Ironic support
14
+to Huawei iBMC 2288H V5, CH121 V5 series servers.
15
+
16
+Problem description
17
+===================
18
+
19
+Huawei’s Intelligent Baseboard Management System (iBMC) is an embedded server
20
+management system that is used to manage servers throughout their lifecycle.
21
+It provides a series of management tools for hardware status monitoring,
22
+deployment, energy savings, and security protection.
23
+
24
+In addition to managing the nodes using IPMI protocol, this specification
25
+proposes to add hardware types and interfaces to manage Huawei servers using
26
+iBMC REST API.
27
+
28
+Proposed change
29
+===============
30
+New hardware type named *ibmc* will be added as part of this change.
31
+New power, management and vendor interfaces will be implemented for
32
+the *ibmc* hardware.
33
+
34
+The interfaces use iBMC REST API to communicate with iBMC.
35
+The interfaces used are:
36
+
37
+    * iBMC.IBMCPower for Power operations
38
+    * iBMC.IBMCManagement for Management operations
39
+    * iBMC.IBMCVendor for Vendorspecific operations
40
+
41
+* Power:
42
+
43
+  This feature allows the user to turn the node on/off or reboot by using the
44
+  power interface which will in turn call iBMC REST API.
45
+
46
+* Management:
47
+
48
+  This feature allows the user to get and set the primary boot device of the
49
+  Huawei servers, and to get the supported boot devices.
50
+
51
+* Vendor:
52
+
53
+  This feature allows the user to perform vendor specific operations.
54
+  For example, query the boot up sequence of the Huawei servers.
55
+
56
+.. code-block:: bash
57
+
58
+  $ openstack baremetal node passthru call --http-method GET \
59
+    <node id or node name> boot_up_seq
60
+  $ ["Pxe", "Hdd", "Cd", "Others"]
61
+
62
+
63
+Alternatives
64
+------------
65
+None
66
+
67
+Data model impact
68
+-----------------
69
+None
70
+
71
+RPC API impact
72
+--------------
73
+None
74
+
75
+State Machine Impact
76
+--------------------
77
+None
78
+
79
+REST API impact
80
+---------------
81
+None
82
+
83
+Client (CLI) impact
84
+-------------------
85
+None
86
+
87
+Driver API impact
88
+-----------------
89
+None
90
+
91
+Nova driver impact
92
+------------------
93
+None
94
+
95
+Security impact
96
+---------------
97
+None
98
+
99
+Other end user impact
100
+---------------------
101
+None
102
+
103
+Scalability impact
104
+------------------
105
+None
106
+
107
+Performance Impact
108
+------------------
109
+None
110
+
111
+Ramdisk impact
112
+--------------
113
+None
114
+
115
+Other deployer impact
116
+---------------------
117
+The following driver_info fields are required while enrolling node into Ironic:
118
+
119
+    * ibmc_address: The URL address to the ibmc controller, example: https://example.com
120
+    * ibmc_username: User account with admin/server-profile access privilege
121
+    * ibmc_password: User account password
122
+    * ibmc_verify_ca(optional): Whether to verify the host certificate or the
123
+      path of a certificate file or directory with trusted certificates
124
+
125
+Developer impact
126
+----------------
127
+None
128
+
129
+Implementation
130
+==============
131
+
132
+Assignee(s)
133
+-----------
134
+
135
+Primary assignee:
136
+
137
+* QianBiao Ng (iampurse@vip.qq.com)
138
+* Bill Chan (biaocy91@gmail.com)
139
+
140
+Other contributors:
141
+    None
142
+
143
+
144
+Work Items
145
+----------
146
+* Add new iBMC hardware type, and adding new interfaces for Power,
147
+  Management and Vendor.
148
+
149
+* Writing appropriate unit tests to provide test coverage for iBMC driver.
150
+
151
+* Writing configuration documents.
152
+
153
+* Building a third party CI.
154
+
155
+Dependencies
156
+============
157
+* Use python-ibmcclient library (not released) to communicate
158
+  with HUAWEI iBMC REST API.
159
+
160
+Testing
161
+=======
162
+* Unit tests will be implemented for new iBMC driver.
163
+
164
+* Third party CI will be provided.
165
+
166
+Upgrades and Backwards Compatibility
167
+====================================
168
+None
169
+
170
+Documentation Impact
171
+====================
172
+* Updating Ironic documentation section `Enabling Drivers`
173
+  with iBMC related instructions.
174
+
175
+References
176
+==========
177
+None

+ 1
- 0
specs/not-implemented/ibmc-driver.rst View File

@@ -0,0 +1 @@
1
+../approved/ibmc-driver.rst

Loading…
Cancel
Save