1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3 .. Copyright (c) 2017-2018 VMware, Inc.
5 ==============================
6 Event/Alert/Metrics Federation
7 ==============================
9 As a cloud mediation layer, Multicloud could be invoked by many projects,
10 through this feature, Multicloud will provide VM status/events check and also
11 can customize the type of event which user would like to receive. There are
12 some kinds of VM status can be chosen: DELETE, PAUSE, POWER_OFF, REBUILD
13 SHUT_DOWN, SOFT_DELETE, etc.. In VMware VIO Plugin, once any change of VM
14 status is detected of a given type, Multicloud will catch the event and throw
15 it to DMaaP. Other projects can try this way of getting VM status messages in
16 the future. Also, for other Multicloud plugin providers, due to some issues,
17 there will be rest apis for them to grab the VM status messages.
19 The APP-C won't be impacted since APP-C can still call the existing API which
20 implemented in Amsterdam Release and the API is an existing API
25 In VIO, one typical use case is to allow VIO users to fetch messages from
26 DMaaP, this will provide a easier way for fetching status of
27 VMs, it may drastically reduce the time of close loop, for other Multicloud
28 plugin providers, Multicloud will provide a set of
37 The proposed change will include two parts: * listener: to listen the events
38 of the status change of VM, for others it
39 will have rest apis to get the messages * publisher: to throw the event to
40 DMaaP.The message we try to send is something like this::
43 "state_description": "powering-off",
44 "availability_zone": "nova",
47 "instance_type_id": 5,
49 "reservation_id": "r-pvx3l6s2",
51 "display_name": "VM1",
55 "launched_at": "2018-03-07T05:59:46.000000",
57 "node": "domain-c202.22bfc05c-da55-4ba6-ba93-08d9a067138e",
64 "user_id": "aa90efa5c84c4084b39094da952e0bd1",
65 "image_ref_url": "http://10.154.9.172:9292/images/207b9b7c-9450-4a95-852b-0d6d41f35d24",
68 "tenant_id": "943ecb804cdf4103976b8a02cea12fdb",
69 "created_at": "2018-03-07 05:58:01+00:00",
70 "instance_id": "4f398943-7d39-4119-8058-74768d6dfa52",
71 "instance_type": "m1.small",
75 "container_format": "bare",
77 "vmware_disktype": "streamOptimized",
78 "disk_format": "vmdk",
80 "image_url": "https://cloud-images.ubuntu.com/releases/14.04/release/ubuntu-14.04-server-cloudimg-amd64-disk1.img",
81 "vmware_adaptertype": "lsiLogic",
83 "base_image_ref": "207b9b7c-9450-4a95-852b-0d6d41f35d24"
87 "instance_flavor_id": "2"
90 The eventual work flow looks like as follows::
101 +-----------------------+ +------------------+
102 | Multicloud VIO Plugin |----------->| Dmaap |
104 +--------|-----^--------+ +------------------+
108 +----------------------+
110 +----------------------+
115 Since the security rules of VIMs and network connectivity issues, other
116 multicloud plugins won't be suitable for the
117 oslo notification listener, so we will provide rest apis for them, the
118 specific implementation will be dicided by them
120 Input of <vim_id>/check_vim_status will be
125 "states": array // the set of VIM status which user wants to get
128 Output of check_vim_status will be
133 "state_description": string // VIM's state
134 "launched_at": string // time of state change
137 The work flow looks like as follows::
148 +-----------------------+
149 | Multicloud Plugins |
151 +--------|-----^--------+
155 +----------------------+
157 +----------------------+