summaryrefslogtreecommitdiffstats
path: root/docs/specs/multicloud4k8s-hpa-discovery.rst
blob: 4d90a8c10cc2cb9011a38c7a9549c23e8e05c026 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
.. Copyright (c) 2019 Intel, Inc.

=================================================
MultiCloud for k8s HPA Discovery And Registration
=================================================
Discover HPA capability and register it to A&AI

Problem Description
===================

Kubernetes clusters using ONAP Multicloud K8s Plugin Project for R4/R5 do not report hardware
features to A&AI. Consequently during the CNF/VNF life cycle CNFs/VNFs that require or recommend
specific hardware during instantiation cannot dynamically reach the correct cluster and node that
provides the needed hardware capabilities.


Propose Change
==============

Cluster Registration FLOW
-------------------------
#. Cluster is deployed.
#. K8s registration agent is deployed on cluster.
#. K8s registration agent gathers features and cluster info.
#. K8s registration agent registers with K8s scheduler with labels identifying it's capabilities.
#. K8s Scheduler hook gives HPA Placement Plugin hardware features.
#. HPA Placement Plugins stores features in mongoDB.

AAI Registration
----------------
#. CLI registers cluster with K8s plugin.
#. Registration asks HPA Placement for cluster features.
#. HPA Placement gets cluster features from mongoDB.
#. HPA Placement plugin returns map of nodes/features to registration.
#. Registration module munges features into tenant/flavors updates AAI.

Converting node feature label to flavor properties
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Node feature label::
    
    feature.node.kubernetes.io/network-sriov.capable=True
    feature.node.kubernetes.io/network-sriov.configured=True
    feature.node.kubernetes.io/pci-1200_8086.present=True

Comments: The other parameter we can set default because node feature label can not provide.


Flavor properties::
    
    +-----------------------------------------------------+-------------+
    | Field                                               | Value       |
    +-----------------------------------------------------+-------------+
    | OS-FLV-DISABLED:disabled                            | False       |
    | OS-FLV-DISABLED:ephemeral                           | 0           |
    | feature.node.kubernetes.io/network-sriov.capable    | True        |
    | feature.node.kubernetes.io/network-sriov.configured | True        |
    | feature.node.kubernetes.io/pci-1200_8086.present    | True        |
    | disk                                                | 1           |
    | id                                                  | 1           |
    | name                                                | k8s_sriov_1 |
    | ram                                                 | 512         |
    | vcpus                                               | 1           |
    +-----------------------------------------------------+-------------+

Add API for K8s Plugin
^^^^^^^^^^^^^^^^^^^^^^
API V0 URL: POST http://{{MSB_IP}}:{{MSB_PORT}}/api/v0/multicloud-k8s/{{cloud-owner}}_{{cloud-region-id}}/registry
API V1 URL: POST http://{{MSB_IP}}:{{MSB_PORT}}/api/v1/multicloud-k8s/{{cloud-owner}}/{{cloud-region-id}}/registry

Request Body:
>>>>>>>>>>>>>
::

  {
  }

Response:
>>>>>>>>>

Response Codes
::::::::::::::
Success
.......

+--------------------+----------------------------------------------------------------------+
| Code               | Reason                                                               |
+====================+======================================================================+
| 202 - ACCEPTED     | Discover HPA and successfully register it                            |
+--------------------+----------------------------------------------------------------------+

Error
.....

+----------------------------+--------------------------------------------------------------+
| Code                       | Reason                                                       |
+============================+==============================================================+
| 500 - INTERAL_SERVER_ERROR | Some content in the request was invalid.                     |
+----------------------------+--------------------------------------------------------------+


Response Body
:::::::::::::
::

    {
    }
	
API V0 URL: GET http://{{MSB_IP}}:{{MSB_PORT}}/api/v0/multicloud-k8s/{{cloud-owner}}_{{cloud-region-id}}/registry
API V1 URL: GET http://{{MSB_IP}}:{{MSB_PORT}}/api/v1/multicloud-k8s/{{cloud-owner}}/{{cloud-region-id}}/registry

Request Body:
>>>>>>>>>>>>>
::

  {
  }

Response:
>>>>>>>>>

Response Codes
::::::::::::::
Success
.......

+--------------------+----------------------------------------------------------------------+
| Code               | Reason                                                               |
+====================+======================================================================+
| 202 - ACCEPTED     | Discover HPA and successfully register it                            |
+--------------------+----------------------------------------------------------------------+

Error
.....

+----------------------------+--------------------------------------------------------------+
| Code                       | Reason                                                       |
+============================+==============================================================+
| 500 - INTERAL_SERVER_ERROR | Some content in the request was invalid.                     |
+----------------------------+--------------------------------------------------------------+


Response Body
:::::::::::::
::

    {
    }
	
	
API V0 URL: DELETE http://{{MSB_IP}}:{{MSB_PORT}}/api/v0/multicloud-k8s/{{cloud-owner}}_{{cloud-region-id}}/registry
API V1 URL: DELETE http://{{MSB_IP}}:{{MSB_PORT}}/api/v1/multicloud-k8s/{{cloud-owner}}/{{cloud-region-id}}/registry

Request Body:
>>>>>>>>>>>>>
::

  {
  }

Response:
>>>>>>>>>

Response Codes
::::::::::::::
Success
.......

+--------------------+----------------------------------------------------------------------+
| Code               | Reason                                                               |
+====================+======================================================================+
| 204 - NO_CONTENT   | Successfully delete HPA information from AAI                         |
+--------------------+----------------------------------------------------------------------+

Error
.....

+----------------------------+--------------------------------------------------------------+
| Code                       | Reason                                                       |
+============================+==============================================================+
| 500 - INTERAL_SERVER_ERROR | Some content in the request was invalid.                     |
+----------------------------+--------------------------------------------------------------+


Response Body
:::::::::::::
::

    {
    }

Work Items
==========

#. Work with CLI.
#. Work with AAI.
#. Expose API by broker and k8s plugin.

Tests
=====

#. Unit Tests with tox
#. Pairwise test with AAI project.
#. Integration test with vFW HPA test.
#. CSIT Tests, the input/ouput of broker and k8s plugin see API design above.

Reference
=========
https://wiki.onap.org/display/DW/Extending+HPA+for+K8S