Gitiles
Code Review Sign In
gerrit.nordix.org / onap / dcaegen2 / 34c4022892609815e4b2007827273a3643c9a7c1 / . / docs / sections / installation_pnda.rst
blob: d1c0a3838a51367841fe973a4c025e9fe004b1cc [file] [log] [blame]
Donald Huntera5683c62018-11-06 22:54:51 +0000[diff] [blame]1.. This work is licensed under a Creative Commons Attribution 4.0 International License.
2.. http://creativecommons.org/licenses/by/4.0
3
4Installing PNDA During Helm Chart Based DCAE Deployment
5=======================================================
6
7PNDA is integrated into ONAP as a component system of DCAE. It is possible to deploy PNDA as
8part of an ONAP OOM deployment on Openstack infrastructure. This is achieved by using a
9pnda-bootstrap container in kubernetes to deploy Openstack VMs and then install a PNDA cluster
10onto those VMs.
11
12Requirements
13------------
14
15PNDA deployment within ONAP requires the following:
16
17* Openstack based infrastructure. Follow the `PNDA guide <http://pnda.io/pnda-guide/provisioning/openstack/PREPARE.html>`_
18 for more information.
19* OOM / Helm template based installation of ONAP on Kubernetes.
20* Kubernetes and PNDA need to share the same Openstack network subnet.
21
22The dcae-pnda-bootstrap Helm chart currently deploys a PNDA cluster with the following resource
23requirements:
24
25+--------------------+--------------------+--------------------+--------------------+
26|Node | CPU | RAM GB | Disk GB |
27+====================+====================+====================+====================+
28|Gateway | 2 | 4 | 20 |
29+--------------------+--------------------+--------------------+--------------------+
30|Edge | 8 | 32 | 50 |
31+--------------------+--------------------+--------------------+--------------------+
32|Hadoop Manager | 4 | 16 | 50 |
33+--------------------+--------------------+--------------------+--------------------+
34|Hadoop Data x 2 | 4 | 8 | 20 + 45 |
35+--------------------+--------------------+--------------------+--------------------+
36|Kafka | 2 | 8 | 50 |
37+--------------------+--------------------+--------------------+--------------------+
38
39There are several parameters that need to be defined with values from your environment for a
40successful PNDA deployment within ONAP. These parameters can be grouped in separate files that
41are passed as parameters to helm install. With the following files, the command to install ONAP
42with PNDA would then look like this:
43
44::
45
46 helm install -f ~/pnda.yaml -f ~/pnda-openstack.yaml -f ~/pnda-pem.yaml local/onap -n dev --namespace onap
47
48
49
50``pnda.yaml``
51-------------
52
53This file contains settings to enable PNDA install and the evironment settings required by PNDA.
54
55::
56
57 pnda:
58 dcae-pnda-bootstrap:
59 enabled: true
60 pnda:
61 osUser: {guest-os-username} # e.g. centos
62 nameserver: nn.nn.nn.nn # IP address of a reachable nameserver
63 ntp: nn.nn.nn.nn # IP address of a reachable NTP server
64 apps:
65 fsType: local
66 networkCidr: 192.168.0.0/24
67 outboundCidr: 0.0.0.0/0
68
69Description
70~~~~~~~~~~~
71
72+-----------------------------------------+----------+--------------------------------------------------------+
73|pnda.dcae-pnda-bootstrap.enabled |boolean |Deploy PNDA or not. |
74+-----------------------------------------+----------+--------------------------------------------------------+
75|pnda.dcae-pnda-bootstrap.pnda.osUser |string |Login used during PNDA installation process to connect |
76| | |to newly created Openstack PNDA instances. |
77+-----------------------------------------+----------+--------------------------------------------------------+
78|pnda.dcae-pnda-bootstrap.pnda.nameserver |string |IP address of the nameserver that will be used by all |
79| | |Openstack PNDA instances. |
80+-----------------------------------------+----------+--------------------------------------------------------+
81|pnda.dcae-pnda-bootstrap.pnda.ntp |string |Hostname or IP address of a NTP server. This NTP server |
82| | |MUST be reachable from the Openstack PNDA instances. |
83+-----------------------------------------+----------+--------------------------------------------------------+
84|pnda.dcae-pnda-bootstrap.pnda.apps.fsType|string |Type of storage used to store PNDA application packages |
85| | |(s3, sshfs, local, swift). Set it to local. |
86+-----------------------------------------+----------+--------------------------------------------------------+
87|pnda.dcae-pnda-bootstrap.pnda.networkCidr|string |CIDR specifying the address range for the network |
88| | |containing all PNDA instances. |
89+-----------------------------------------+----------+--------------------------------------------------------+
90|pnda.dcae-pnda-bootstrap.pnda.dataNodes |number |Number of data nodes to deploy. Defaults to 2. |
91+-----------------------------------------+----------+--------------------------------------------------------+
92|pnda.dcae-pnda-bootstrap.pnda.kafkaNodes |number |Number of kafka nodes to deploy. Defaults to 1. |
93+-----------------------------------------+----------+--------------------------------------------------------+
94
95
96``pnda-openstack.yaml``
97-----------------------
98
99This file contains the Openstack connection settings and Openstack entity identifiers.
100
101::
102
103 pnda:
104 dcae-pnda-bootstrap:
105 openstack:
106 keystoneUser: {openstack-username}
107 keystonePassword: {openstack-password}
108 keystoneTenant: {openstack-tenant-name}
109 keystoneAuthUrl: {openstack-auth-url} # e.g. http://openstack-host:5000/v2.0/
110 keystoneRegion: {openstack-region-name}
111 useExistingNetwork: true
112 existingNetworkId: {kubernetes-cluster-network}
113 existingSubnetId: {kubernetes-cluster-subnet}
114 imageId: {pnda-vm-image-id} # Openstack imageId to use for PNDA VMs
115 publicNetworkId: {public-network-id} # Openstack networkId of public facing network
116 publicSubnetCidr: nn.nn.nn.nn/nn # CIDR address of the public subnet e.g. 10.40.10.0/24
117
118Description
119~~~~~~~~~~~
120
121+-----------------------------------------------------+----------+-----------------------------------------------+
122|pnda.dcae-pnda-bootstrap.openstack.keystoneUser |string |Openstack user. |
123+-----------------------------------------------------+----------+-----------------------------------------------+
124|pnda.dcae-pnda-bootstrap.openstack.keystonePassword |string |Openstack password. |
125+-----------------------------------------------------+----------+-----------------------------------------------+
126|pnda.dcae-pnda-bootstrap.openstack.keystoneTenant |string |Openstack tenant. |
127+-----------------------------------------------------+----------+-----------------------------------------------+
128|pnda.dcae-pnda-bootstrap.openstack.keystoneAuthUrl |string |Openstack authentication url. |
129+-----------------------------------------------------+----------+-----------------------------------------------+
130|pnda.dcae-pnda-bootstrap.openstack.keystoneRegion |string |Openstack region. |
131+-----------------------------------------------------+----------+-----------------------------------------------+
132|pnda.dcae-pnda-bootstrap.openstack.useExistingNetwork|boolean |Do you want to create a new Openstack network |
133| | |or do you want to use an already existing one? |
134+-----------------------------------------------------+----------+-----------------------------------------------+
135|pnda.dcae-pnda-bootstrap.openstack.existingNetworkId |string |If you want to use an already existing |
136| | |Openstack network, specify its UUID. |
137+-----------------------------------------------------+----------+-----------------------------------------------+
138|pnda.dcae-pnda-bootstrap.openstack.existingSubnetId |string |If you want to use an already existing |
139| | |Openstack network, specify the UUID of the |
140| | |Openstack subnet to use. |
141+-----------------------------------------------------+----------+-----------------------------------------------+
142|pnda.dcae-pnda-bootstrap.openstack.imageId |string |Base image to use for the created Openstack |
143| | |PNDA instances. |
144+-----------------------------------------------------+----------+-----------------------------------------------+
145|pnda.dcae-pnda-bootstrap.openstack.publicNetworkId |string |UUID of the public network in openstack to use.|
146+-----------------------------------------------------+----------+-----------------------------------------------+
147|pnda.dcae-pnda-bootstrap.openstack.publicSubnetCidr |string |CIDR specifying the address range for the |
148| | |public subnet. |
149+-----------------------------------------------------+----------+-----------------------------------------------+
150
151
152``pnda-pem.yaml``
153-----------------
154
155This file contains the private secret and Openstack keypair name to use for the guest VMs in Openstack.
156
157::
158
159 pnda:
160 dcae-pnda-bootstrap:
161 pnda_keypair_name: {keypair-name} # Name of the keypair you have created in Openstack, e.g. pnda-key
162 pnda_secret: |
163 -----BEGIN DSA PRIVATE KEY-----
164 MIIBugIBAAKBgQCLLCmDJdxCxOOmaSGoH0WUyoiGUJiE0JnzEEhXd4SZWmoxo7yn
165 9d3iA9z2OiOnbQ4s5tAOWknpFEnIwtFb+L2x3Fzv7yEdHBk0tgC8c91sIxb72SVp
166 RgJDaseL2C5RRdWqDiKlXnA1iY7H5z/k/bZD61/4eGdAojVxroQX2H6uLQIVAIrG
167 WVGBudBQmfwKzyP5eO1nevNFAoGAALSGjzP0/yVnEKZ8JO8Vw/eC1YDmTG1IwBdN
168 Rm8fXqyUjd03ijpmOoPISPM6Jt0TrJTvGNVfqSI1mKVznJ+5B7y5M9qvjzHQW5hL
169 GkXHL57mN2QkaJE/m4ilKr/p5RzTBk6c/zhvxg/8DEne6klQ3NQhapzY4cL9aLK6
170 hrR4T94CgYAhGFZI5buQUk8MtG9nac9hEQuYw+lrdjy+y1F8XIjq8+ZLAdCY5gw/
171 ph+4di/R8MyesqG5AtqUqXQY3tibya3YrqyNZ5mTz6kMN1lT26QHwYMBF1IymMWV
172 lq5wzjpctVovYchCLagrh7KepetNigni0Vrjc0TLPbvXQkoLG5JifgIURmDpblYA
173 HSNN6un6nlCoGnm07SA=
174 -----END DSA PRIVATE KEY-----
175
176Description
177~~~~~~~~~~~
178
179+------------------------------------------+----------+-------------------------------------------------------+
180|pnda.dcae-pnda-bootstrap.pnda_keypair_name|string |Name of the keypair to use to spawn the Openstack PNDA |
181| | |instances.Note that the private key above is a |
182| | |generated sample that is unusable. |
183+------------------------------------------+----------+-------------------------------------------------------+
184|pnda.dcae-pnda-bootstrap.pnda_secret |string |Secret key of the pnda_keypair_name keypair. |
185+------------------------------------------+----------+-------------------------------------------------------+