Fix API spec doc format
[multicloud/framework.git] / docs / multicloud-plugin-windriver / Tutorial-HPA-Provision-Discovery-WindRiver-TitaniumCloud.rst
1 ..
2  This work is licensed under a Creative Commons Attribution 4.0
3  International License.
4
5 Tutorial: Enable ONAP HPA Orchestation to Wind River Titanium Cloud
6 ```````````````````````````````````````````````````````````````````
7
8
9 To fulfil the functional requirement of HPA enablement, MultiCloud plugin for
10 Wind River Titanium Cloud expects the administrator to provision the Titanium
11 Cloud instance conforming to certain conventions.
12
13 This tutorial demonstrates how to enable ONAP HPA orchestration to Wind River Titanium Cloud.
14
15 Architecture & Policies & Mappings
16 ----------------------------------
17
18 Please refer to the link for more architecture details:
19
20 ..
21   https://wiki.onap.org/pages/viewpage.action?pageId=20874679
22
23 Please refer to the link for more Policies&Mappings details:
24
25 ..
26   https://wiki.onap.org/display/DW/HPA+Policies+and+Mappings
27
28 Provision Flavors
29 -----------------
30
31 configure openstack with proper flavors (with name prefixed by "onap." to carry HPA information to ONAP), example flavor:
32
33 .. code-block:: console
34
35     nova flavor-create onap.hpa.medium 110 4096 0 6
36     #cpu pining
37     nova flavor-key onap.hpa.medium set hw:cpu_policy=dedicated
38     nova flavor-key onap.hpa.medium set hw:cpu_thread_policy=prefer
39     #cpu topology
40     nova flavor-key onap.hpa.medium set hw:cpu_sockets=2
41     nova flavor-key onap.hpa.medium set hw:cpu_cores=4
42     nova flavor-key onap.hpa.medium set hw:cpu_threads=8
43     #hugepage
44     nova flavor-key onap.hpa.medium set hw:mem_page_size=large
45     #numa
46     nova flavor-key onap.hpa.medium set hw:numa_nodes=2    
47     nova flavor-key onap.hpa.medium set hw:numa_cpus.0=0,1 hw:numa_cpus.1=2,3,4,5 hw:numa_mem.0=2048 hw:numa_mem.1=2048
48
49 Access configuration of Titanium Cloud Instance
50 -----------------------------------------------
51
52 collect following information for on-boarding this Cloud instance to ONAP:
53
54 .. code-block:: console
55
56     your openstack project name
57     your openstack user
58     your openstack password
59     your openstack keystone endpoint
60     your openstack Region ID: e.g. RegionOne
61
62
63 On-board the Titanium Cloud instance
64 ------------------------------------
65
66 Now you can onboard this Titanium Cloud instance, make sure the multicloud registration process is triggered.
67
68 See `Tutorial: Onboard instance of Wind River Titanium Cloud`