diff options
| -rw-r--r-- | doc/book-enea-nfv-access-getting-started/doc/getting_started_ucpe_manager.xml | 922 |
1 files changed, 689 insertions, 233 deletions
diff --git a/doc/book-enea-nfv-access-getting-started/doc/getting_started_ucpe_manager.xml b/doc/book-enea-nfv-access-getting-started/doc/getting_started_ucpe_manager.xml index 9d5eecc..1663e8c 100644 --- a/doc/book-enea-nfv-access-getting-started/doc/getting_started_ucpe_manager.xml +++ b/doc/book-enea-nfv-access-getting-started/doc/getting_started_ucpe_manager.xml | |||
| @@ -5,12 +5,13 @@ | |||
| 5 | <section id="prereq_ucpe"> | 5 | <section id="prereq_ucpe"> |
| 6 | <title>Prerequisites</title> | 6 | <title>Prerequisites</title> |
| 7 | 7 | ||
| 8 | <para>Listed below are the main generic prerequisites required so that the | 8 | <para>Listed below are the main generic prerequisites required so that the |
| 9 | uCPE Manager can be deployed on the host platform:</para> | 9 | uCPE Manager can be deployed on the host platform:</para> |
| 10 | 10 | ||
| 11 | <itemizedlist> | 11 | <itemizedlist> |
| 12 | <listitem> | 12 | <listitem> |
| 13 | <para>A uCPE device with Enea NFV Access Run Time Platform installed.</para> | 13 | <para>A uCPE device with Enea NFV Access Run Time Platform |
| 14 | installed.</para> | ||
| 14 | </listitem> | 15 | </listitem> |
| 15 | 16 | ||
| 16 | <listitem> | 17 | <listitem> |
| @@ -24,53 +25,408 @@ | |||
| 24 | <title>Install the Enea uCPE Manager</title> | 25 | <title>Install the Enea uCPE Manager</title> |
| 25 | 26 | ||
| 26 | <para>Unpack the uCPE Manager and install it following the instructions | 27 | <para>Unpack the uCPE Manager and install it following the instructions |
| 27 | provided within the release archive: | 28 | below.</para> |
| 28 | <literal>[unpacked_folder]/dist/README</literal>.</para> | ||
| 29 | 29 | ||
| 30 | <para>There are things to consider during the installation phase, as | 30 | <section id="prep_sys_ucpe_mg"> |
| 31 | there are a few steps where user input is required. In most cases, the | 31 | <title>Preparing your system</title> |
| 32 | default values should be used.</para> | ||
| 33 | 32 | ||
| 34 | <note><para>Check that the CentOS machine where the uCPE Manager is installed | 33 | <orderedlist> |
| 35 | has the firewall disabled.</para></note> | 34 | <listitem> |
| 35 | <para>Open a terminal with administrative rights, i.e. log into a | ||
| 36 | <emphasis role="bold">bash</emphasis> shell with | ||
| 37 | <literal>root</literal> privileges.</para> | ||
| 38 | </listitem> | ||
| 36 | 39 | ||
| 37 | <para>Verify that the installation has succeeded:</para> | 40 | <listitem> |
| 41 | <para>Choose the target installation folder, e.g. | ||
| 42 | <literal>/opt/ems</literal>. Everything will be installed under a | ||
| 43 | folder called <literal>ucpemanager</literal> within the target | ||
| 44 | installation folder.</para> | ||
| 45 | </listitem> | ||
| 46 | </orderedlist> | ||
| 38 | 47 | ||
| 39 | <orderedlist> | 48 | <para>The application files will be installed in |
| 40 | <listitem> | 49 | <literal>/opt/ems/ucpemanager/application</literal>. The database will |
| 41 | <para>Point your browser to the server machine running the uCPE | 50 | be installed in <literal>/opt/ems/ucpemanager/database</literal>.</para> |
| 42 | Manager.</para> | ||
| 43 | </listitem> | ||
| 44 | 51 | ||
| 45 | <listitem> | 52 | <note> |
| 46 | <para>In the login screen, log in with the username: <emphasis | 53 | <para>If you have multiple spindles, it is recommended to let the |
| 47 | role="bold">admin</emphasis> and password: <emphasis | 54 | application run off one and the database off the other. This will |
| 48 | role="bold">admin</emphasis>.</para> | 55 | result in optimum performance. It is also recommended that the swap |
| 49 | </listitem> | 56 | disk be the same as the one used for the application.</para> |
| 50 | </orderedlist> | 57 | </note> |
| 58 | |||
| 59 | <para>Assuming another spindle is used (<literal>/drive2</literal>) do | ||
| 60 | the following:</para> | ||
| 61 | |||
| 62 | <itemizedlist> | ||
| 63 | <listitem> | ||
| 64 | <para>Create a folder which will host the database (e.g. | ||
| 65 | <literal>emsDatabase</literal>).</para> | ||
| 66 | </listitem> | ||
| 67 | |||
| 68 | <listitem> | ||
| 69 | <para>Create a soft-link that will point to this folder:</para> | ||
| 70 | |||
| 71 | <programlisting>ln -s /opt/ems/elementcenter/database /drive2/emsDatabase</programlisting> | ||
| 72 | </listitem> | ||
| 73 | |||
| 74 | <listitem> | ||
| 75 | <para>Follow the installation process as described below.</para> | ||
| 76 | </listitem> | ||
| 77 | </itemizedlist> | ||
| 78 | </section> | ||
| 79 | |||
| 80 | <section id="installing_ucpe_mg"> | ||
| 81 | <title>Installing the uCPE Manager</title> | ||
| 82 | |||
| 83 | <orderedlist> | ||
| 84 | <listitem> | ||
| 85 | <para>Open a terminal with administrative rights, i.e. log into a | ||
| 86 | <emphasis role="bold">bash</emphasis> shell with | ||
| 87 | <literal>root</literal> privileges.</para> | ||
| 88 | </listitem> | ||
| 89 | |||
| 90 | <listitem> | ||
| 91 | <para><command>cd</command> to the folder you are installing | ||
| 92 | from.</para> | ||
| 93 | </listitem> | ||
| 94 | |||
| 95 | <listitem> | ||
| 96 | <para>Verify that the folder you are installing from contains the | ||
| 97 | following files:</para> | ||
| 98 | |||
| 99 | <itemizedlist> | ||
| 100 | <listitem> | ||
| 101 | <para><filename>README</filename></para> | ||
| 102 | </listitem> | ||
| 103 | |||
| 104 | <listitem> | ||
| 105 | <para><filename>install.sh</filename></para> | ||
| 106 | </listitem> | ||
| 107 | |||
| 108 | <listitem> | ||
| 109 | <para><filename>doinstall.sh</filename></para> | ||
| 110 | </listitem> | ||
| 111 | |||
| 112 | <listitem> | ||
| 113 | <para><literal>configureHA.sh</literal></para> | ||
| 114 | </listitem> | ||
| 115 | |||
| 116 | <listitem> | ||
| 117 | <para><filename>ucpemanager-x.y-Buildz-Linux.tar.gz</filename></para> | ||
| 118 | </listitem> | ||
| 119 | |||
| 120 | <listitem> | ||
| 121 | <para><filename>ReleaseNotes</filename></para> | ||
| 122 | </listitem> | ||
| 123 | </itemizedlist> | ||
| 124 | </listitem> | ||
| 125 | |||
| 126 | <listitem> | ||
| 127 | <para>Run the following command:</para> | ||
| 128 | |||
| 129 | <programlisting>./install.sh /opt/ems ucpemanager-x.y-Buildz-Linux.tar.gz.</programlisting> | ||
| 130 | </listitem> | ||
| 131 | </orderedlist> | ||
| 132 | |||
| 133 | <para>This command will:</para> | ||
| 134 | |||
| 135 | <itemizedlist> | ||
| 136 | <listitem> | ||
| 137 | <para>Extract the application files from the compressed install | ||
| 138 | kit.</para> | ||
| 139 | </listitem> | ||
| 140 | |||
| 141 | <listitem> | ||
| 142 | <para>Install the bundled database (if the user specifies an | ||
| 143 | internal database).</para> | ||
| 144 | </listitem> | ||
| 145 | |||
| 146 | <listitem> | ||
| 147 | <para>Install <literal>ucpemanager</literal> as a service with the | ||
| 148 | name <filename>ucpemanager</filename>.</para> | ||
| 149 | </listitem> | ||
| 150 | |||
| 151 | <listitem> | ||
| 152 | <para>Start the <literal>ucpemanager</literal> service.</para> | ||
| 153 | </listitem> | ||
| 154 | </itemizedlist> | ||
| 155 | |||
| 156 | <note> | ||
| 157 | <para>The service will be automatically started when the computer | ||
| 158 | boots up.</para> | ||
| 159 | |||
| 160 | <para>Check that the CentOS machine where the uCPE Manager is | ||
| 161 | installed has the firewall disabled.</para> | ||
| 162 | </note> | ||
| 163 | |||
| 164 | <para>Verify that the installation has succeeded by:</para> | ||
| 165 | |||
| 166 | <orderedlist> | ||
| 167 | <listitem> | ||
| 168 | <para>Pointing your browser to the server machine running the uCPE | ||
| 169 | Manager.</para> | ||
| 170 | </listitem> | ||
| 171 | |||
| 172 | <listitem> | ||
| 173 | <para>In the login screen, log in with the username: <emphasis | ||
| 174 | role="bold">admin</emphasis> and password: <emphasis | ||
| 175 | role="bold">admin</emphasis>.</para> | ||
| 176 | </listitem> | ||
| 177 | </orderedlist> | ||
| 178 | |||
| 179 | <para>In order to manage the ucpemanager service, user can run: | ||
| 180 | <programlisting>service ucpemanager start/stop</programlisting></para> | ||
| 181 | |||
| 182 | <para><emphasis role="bold">Installing with the restore | ||
| 183 | option</emphasis></para> | ||
| 184 | |||
| 185 | <para>It is possible to use a restore file created by the "System | ||
| 186 | Backup" utility provided in the uCPE Manager, to install a system and | ||
| 187 | set it to a known state.</para> | ||
| 188 | |||
| 189 | <note> | ||
| 190 | <para>The file to be used is the zip file created by System Backup, | ||
| 191 | not the one created by the uninstall or upgrade processes described | ||
| 192 | below.</para> | ||
| 193 | </note> | ||
| 194 | |||
| 195 | <para>The name format of this file will be: | ||
| 196 | <filename>SystemBackup_MMMDD_YYYY_HHMM_SS.zip</filename> (e.g | ||
| 197 | <literal>SystemBackup_Feb19_2013_2257_42.zip</literal>). </para> | ||
| 198 | |||
| 199 | <para>Follow the steps for Installation provided above and provide an | ||
| 200 | additional argument as shown below:</para> | ||
| 201 | |||
| 202 | <programlisting>"./install.sh \ | ||
| 203 | /opt/ems ucpemanager-1.0-Build8-Linux.tar.gz \ | ||
| 204 | SystemBackup_MMMDD_YYYY_HHMM_SS.zip"</programlisting> | ||
| 205 | |||
| 206 | <para>The other steps are exactly the same as specified in the | ||
| 207 | Installation instructions. There are things to consider during the | ||
| 208 | installation phase, as there are a few steps where user input is | ||
| 209 | required. In most cases, the default values should be used.</para> | ||
| 210 | </section> | ||
| 211 | |||
| 212 | <section id="upgrading_ucpe_mg"> | ||
| 213 | <title>Upgrading the uCPE Manager</title> | ||
| 214 | |||
| 215 | <orderedlist> | ||
| 216 | <listitem> | ||
| 217 | <para>Verify that the folder you are upgrading from contains the | ||
| 218 | following files:</para> | ||
| 219 | |||
| 220 | <itemizedlist> | ||
| 221 | <listitem> | ||
| 222 | <para><filename>upgrade.sh</filename></para> | ||
| 223 | </listitem> | ||
| 224 | |||
| 225 | <listitem> | ||
| 226 | <para><filename>doupgrade.sh</filename></para> | ||
| 227 | </listitem> | ||
| 228 | |||
| 229 | <listitem> | ||
| 230 | <para><filename>configureHA.sh</filename></para> | ||
| 231 | </listitem> | ||
| 232 | |||
| 233 | <listitem> | ||
| 234 | <para><filename>ucpemanager-x.y-Buildz-Linux.tar.gz</filename></para> | ||
| 235 | </listitem> | ||
| 236 | </itemizedlist> | ||
| 237 | </listitem> | ||
| 238 | |||
| 239 | <listitem> | ||
| 240 | <para>Run the following command:</para> | ||
| 241 | |||
| 242 | <programlisting>./upgrade.sh /opt/ems ucpemanager-1.0-Build8-Linux.tar.gz" </programlisting> | ||
| 243 | </listitem> | ||
| 244 | </orderedlist> | ||
| 245 | |||
| 246 | <para>Running this command will:</para> | ||
| 247 | |||
| 248 | <itemizedlist> | ||
| 249 | <listitem> | ||
| 250 | <para>Stop the currently running ucpemanager service.</para> | ||
| 251 | </listitem> | ||
| 252 | |||
| 253 | <listitem> | ||
| 254 | <para>Create a compressed file of the ucpemanager application | ||
| 255 | folder, called: | ||
| 256 | <literal>ucpemanager-Backup-YYYYddMMHHmm.tar.gz</literal>, which | ||
| 257 | contains a snapshot of the existing installation.</para> | ||
| 258 | </listitem> | ||
| 259 | |||
| 260 | <listitem> | ||
| 261 | <para>Rename the <literal>application</literal> folder to | ||
| 262 | <literal>application_original</literal>.</para> | ||
| 263 | </listitem> | ||
| 264 | |||
| 265 | <listitem> | ||
| 266 | <para>Extract the application files from the specified compressed | ||
| 267 | install kit. There will now exist a (new) application folder, with | ||
| 268 | the contents of the new kit.</para> | ||
| 269 | </listitem> | ||
| 270 | |||
| 271 | <listitem> | ||
| 272 | <para>Start the ucpemanager service.</para> | ||
| 273 | </listitem> | ||
| 274 | </itemizedlist> | ||
| 275 | |||
| 276 | <para>When the ucpemanager service starts, it will recognize the fact | ||
| 277 | that an old version of the application needs to be upgraded (based upon | ||
| 278 | the existence of the <literal>application_original</literal> folder. All | ||
| 279 | the relevant data from the old installation will be copied to the new | ||
| 280 | one and the <literal>application_original</literal> folder will be | ||
| 281 | deleted.</para> | ||
| 282 | </section> | ||
| 283 | |||
| 284 | <section id="uninstalling_ucpe_mg"> | ||
| 285 | <title>Uninstalling an existing uCPE Manager installation</title> | ||
| 286 | |||
| 287 | <orderedlist> | ||
| 288 | <listitem> | ||
| 289 | <para>Verify that the folder you are uninstalling from contains the | ||
| 290 | following files:</para> | ||
| 291 | |||
| 292 | <itemizedlist> | ||
| 293 | <listitem> | ||
| 294 | <para><filename>uninstall.sh</filename></para> | ||
| 295 | </listitem> | ||
| 296 | |||
| 297 | <listitem> | ||
| 298 | <para><filename>douninstall.sh</filename></para> | ||
| 299 | </listitem> | ||
| 300 | </itemizedlist> | ||
| 301 | </listitem> | ||
| 302 | |||
| 303 | <listitem> | ||
| 304 | <para>Run the following command:</para> | ||
| 305 | |||
| 306 | <programlisting>./uninstall.sh /opt/ems</programlisting> | ||
| 307 | </listitem> | ||
| 308 | </orderedlist> | ||
| 309 | |||
| 310 | <para>Running this command will:</para> | ||
| 311 | |||
| 312 | <itemizedlist> | ||
| 313 | <listitem> | ||
| 314 | <para>Stop the currently running ucpemanager service.</para> | ||
| 315 | </listitem> | ||
| 316 | |||
| 317 | <listitem> | ||
| 318 | <para>Create a compressed file of the ucpemanager application | ||
| 319 | folder, called | ||
| 320 | <literal>ucpemanager-Backup-YYYYddMMHHmm.tar.gz</literal>, which | ||
| 321 | contains a snapshot of the existing installation.</para> | ||
| 322 | </listitem> | ||
| 323 | |||
| 324 | <listitem> | ||
| 325 | <para>Uninstall the ucpemanager service, so that it will not startup | ||
| 326 | on reboot.</para> | ||
| 327 | </listitem> | ||
| 328 | |||
| 329 | <listitem> | ||
| 330 | <para>Uninstall the database service (if an internal database is | ||
| 331 | being used).</para> | ||
| 332 | </listitem> | ||
| 333 | |||
| 334 | <listitem> | ||
| 335 | <para>Completely remove the contents of the | ||
| 336 | <literal>application</literal> and <literal>database</literal> | ||
| 337 | folders.</para> | ||
| 338 | </listitem> | ||
| 339 | </itemizedlist> | ||
| 340 | |||
| 341 | <para>After these steps, the uCPE Manager is completely removed from the | ||
| 342 | system.</para> | ||
| 343 | </section> | ||
| 344 | |||
| 345 | <section id="restoring_pre_installation"> | ||
| 346 | <title>Restoring a previous uCPE Manager installation</title> | ||
| 347 | |||
| 348 | <orderedlist> | ||
| 349 | <listitem> | ||
| 350 | <para>Verify that the folder you are restoring from contains the | ||
| 351 | following files:</para> | ||
| 352 | |||
| 353 | <itemizedlist> | ||
| 354 | <listitem> | ||
| 355 | <para><filename>restore.sh</filename></para> | ||
| 356 | </listitem> | ||
| 357 | |||
| 358 | <listitem> | ||
| 359 | <para><filename>dorestore.sh</filename></para> | ||
| 360 | </listitem> | ||
| 361 | |||
| 362 | <listitem> | ||
| 363 | <para><filename>configureHA.sh</filename></para> | ||
| 364 | </listitem> | ||
| 365 | |||
| 366 | <listitem> | ||
| 367 | <para><filename>ucpemanager-Backup-YYYYddMMHHmm.tar.gz</filename> | ||
| 368 | (the original installation snapshot, as obtained from a previous | ||
| 369 | uninstall).</para> | ||
| 370 | </listitem> | ||
| 371 | </itemizedlist> | ||
| 372 | </listitem> | ||
| 373 | |||
| 374 | <listitem> | ||
| 375 | <para>Run the following command:</para> | ||
| 376 | |||
| 377 | <programlisting>./restore.sh /opt/ems ucpemanager-Backup-YYYYddMMHHmm.tar.gz</programlisting> | ||
| 378 | </listitem> | ||
| 379 | </orderedlist> | ||
| 380 | |||
| 381 | <para>Running this command will remove any vestiges of the existing | ||
| 382 | ucpemanager service, if they exist, and reinstall the ucpemanager | ||
| 383 | application on the specified target, restoring the data in the database | ||
| 384 | and files in the process. </para> | ||
| 385 | |||
| 386 | <para>The ucpemanager service is then started and the older version is | ||
| 387 | now running on the system.</para> | ||
| 388 | </section> | ||
| 51 | </section> | 389 | </section> |
| 52 | 390 | ||
| 53 | <section id="device_config_provision"> | 391 | <section id="device_config_provision"> |
| 54 | <title>Device Configuration and Provisioning</title> | 392 | <title>Device Configuration and Provisioning</title> |
| 55 | 393 | ||
| 394 | <para>The following describes the steps required for setting up the | ||
| 395 | virtualization infrastructure, ensuring that a uCPE device is ready for | ||
| 396 | virtualized service deployment. The sections herein contain information | ||
| 397 | about enrolling uCPE devices into the Enea uCPE Manager, selecting | ||
| 398 | physical interfaces to be used by virtualized networking and creating | ||
| 399 | different types of bridges to enable VNF communication. The Zero Touch | ||
| 400 | Provisioning mechanism is also touched upon, as alternative to manual | ||
| 401 | configuration of the virtualization infrastructure.</para> | ||
| 402 | |||
| 56 | <section id="device_config"> | 403 | <section id="device_config"> |
| 57 | <title>Add a uCPE device to the Management System</title> | 404 | <title>Add a uCPE device to the Management System</title> |
| 58 | 405 | ||
| 59 | <para>This section describes how to connect to an instance of NFV Access | 406 | <para>Enrolling uCPE devices into the Enea uCPE Manager can be |
| 60 | installed on a specific uCPE device, and how to setup the virtual | 407 | accomplished using one of the two possible methods.</para> |
| 61 | infrastructure.</para> | ||
| 62 | 408 | ||
| 63 | <section id="man_config"> | 409 | <section id="man_config"> |
| 64 | <title>Direct Connection</title> | 410 | <title>Direct Connection</title> |
| 65 | 411 | ||
| 66 | <para>When using this mechanism, the uCPE Manager will periodically poll | 412 | <para>When using this mechanism, the uCPE Manager will periodically |
| 67 | the uCPE device, using a specified IP address as the destination, attempting | 413 | poll the uCPE device, using a specified IP address as the destination, |
| 68 | to establish a management connection.</para> | 414 | attempting to establish a management connection.</para> |
| 69 | 415 | ||
| 70 | <para>Add the uCPE device running the NFV Access Run Time Platform to | 416 | <para>Add the uCPE device running the NFV Access Run Time Platform to |
| 71 | the management system by selecting <literal>Devices -> Manage -> | 417 | the management system by:</para> |
| 72 | Add</literal>. Supply information about the uCPE device, and set the | 418 | |
| 73 | parameters that will be used to connect to it.</para> | 419 | <orderedlist> |
| 420 | <listitem> | ||
| 421 | <para>Selecting in the uCPE Manager: <literal>Devices -> Manage | ||
| 422 | -> Add</literal>.</para> | ||
| 423 | </listitem> | ||
| 424 | |||
| 425 | <listitem> | ||
| 426 | <para>Suppling information about the uCPE device, and setting the | ||
| 427 | parameters that will be used to connect to it.</para> | ||
| 428 | </listitem> | ||
| 429 | </orderedlist> | ||
| 74 | 430 | ||
| 75 | <para>The relevant parameters are:</para> | 431 | <para>The relevant parameters are:</para> |
| 76 | 432 | ||
| @@ -90,19 +446,21 @@ | |||
| 90 | 446 | ||
| 91 | <itemizedlist> | 447 | <itemizedlist> |
| 92 | <listitem> | 448 | <listitem> |
| 93 | <para>IP Address. IP address of the device.</para> | 449 | <para>IP Address. IP address of the ucPE device.</para> |
| 94 | </listitem> | 450 | </listitem> |
| 95 | </itemizedlist> | 451 | </itemizedlist> |
| 96 | 452 | ||
| 97 | <itemizedlist> | 453 | <itemizedlist> |
| 98 | <listitem> | 454 | <listitem> |
| 99 | <para>SSH Port. The NETCONF Port used for communications.</para> | 455 | <para>SSH Port. The NETCONF Port used for communications. Default |
| 456 | is set to 830.</para> | ||
| 100 | </listitem> | 457 | </listitem> |
| 101 | </itemizedlist> | 458 | </itemizedlist> |
| 102 | 459 | ||
| 103 | <itemizedlist> | 460 | <itemizedlist> |
| 104 | <listitem> | 461 | <listitem> |
| 105 | <para>SSH User Name. The user name for SSH connectivity.</para> | 462 | <para>SSH User Name. The user name for SSH connectivity. Default |
| 463 | user is root.</para> | ||
| 106 | </listitem> | 464 | </listitem> |
| 107 | </itemizedlist> | 465 | </itemizedlist> |
| 108 | 466 | ||
| @@ -115,17 +473,17 @@ | |||
| 115 | <itemizedlist> | 473 | <itemizedlist> |
| 116 | <listitem> | 474 | <listitem> |
| 117 | <para>Device Calls Home. This checkbox indicates the direction of | 475 | <para>Device Calls Home. This checkbox indicates the direction of |
| 118 | device communications. In the Manual Configuration, leave this box | 476 | device communications. For Direct Connection, leave this flag |
| 119 | blank.</para> | 477 | unchecked.</para> |
| 120 | </listitem> | 478 | </listitem> |
| 121 | </itemizedlist> | 479 | </itemizedlist> |
| 122 | 480 | ||
| 123 | <itemizedlist> | 481 | <itemizedlist> |
| 124 | <listitem> | 482 | <listitem> |
| 125 | <para>Device ID. The unique instance ID of the device. This links | 483 | <para>Device ID. The unique identifier of the uCPE device. This |
| 126 | a device to its day-0 configuration (stored in the | 484 | links a device to its Day-0 configuration (stored in the offline |
| 127 | offline configuration system). It is a required field if you want | 485 | configuration system). It is a required field if you want to |
| 128 | to perform Zero-Touch Provisioning.</para> | 486 | perform Zero-Touch Provisioning.</para> |
| 129 | </listitem> | 487 | </listitem> |
| 130 | </itemizedlist> | 488 | </itemizedlist> |
| 131 | </section> | 489 | </section> |
| @@ -133,24 +491,26 @@ | |||
| 133 | <section id="using_call_home"> | 491 | <section id="using_call_home"> |
| 134 | <title>Device Call Home Connection</title> | 492 | <title>Device Call Home Connection</title> |
| 135 | 493 | ||
| 136 | <para>Follow the same steps as described in previous section, making sure | 494 | <para>Follow the same steps as described in the previous section, |
| 137 | that the <literal>Device Calls Home</literal> checkbox is selected.</para> | 495 | making sure that the <literal>Device Calls Home</literal> checkbox is |
| 138 | 496 | selected this time.</para> | |
| 139 | <para>When using this mechanism, the device will initiate a connection | 497 | |
| 140 | to the uCPE Manager for NETCONF traffic (over SSH), while the uCPE | 498 | <para>When using this mechanism, the device will initiate a connection |
| 141 | Manager waits for a device connection. Make sure the uCPE Manager IP | 499 | to the uCPE Manager for NETCONF traffic (over SSH), while the uCPE |
| 142 | address has been configured on the device. For more information please see section | 500 | Manager waits for a device connection. Make sure the uCPE Manager IP |
| 143 | <link linkend="install_ena_stick">Installing Enea NFV Access</link> for more details.</para> | 501 | address has been configured on the device. For more information please |
| 502 | see section <link linkend="install_ena_stick">Installing Enea NFV | ||
| 503 | Access</link> for more details.</para> | ||
| 144 | </section> | 504 | </section> |
| 145 | </section> | 505 | </section> |
| 146 | 506 | ||
| 147 | <section id="host_int_net_config"> | 507 | <section id="host_int_net_config"> |
| 148 | <title>Configure NFV Infrastructure</title> | 508 | <title>Configure NFV Infrastructure</title> |
| 149 | 509 | ||
| 150 | <para>Once a management connection with the uCPE device has been established | 510 | <para>Once a management connection with the uCPE device has been |
| 151 | by using any of the supported methods, the virtualization networking | 511 | established by using any of the supported methods, the virtualization |
| 152 | infrastructure can be configured either manually or by using Zero Touch | 512 | networking infrastructure can be configured either manually or by using |
| 153 | Provisioning.</para> | 513 | Zero Touch Provisioning.</para> |
| 154 | 514 | ||
| 155 | <para>The uCPE Manager can list network interfaces found on a device by | 515 | <para>The uCPE Manager can list network interfaces found on a device by |
| 156 | selecting the uCPE device first and then selecting | 516 | selecting the uCPE device first and then selecting |
| @@ -162,8 +522,8 @@ | |||
| 162 | 522 | ||
| 163 | <mediaobject> | 523 | <mediaobject> |
| 164 | <imageobject> | 524 | <imageobject> |
| 165 | <imagedata align="center" fileref="images/host_interface_caps.png" | 525 | <imagedata align="center" contentwidth="600" |
| 166 | scale="55" /> | 526 | fileref="images/host_interface_caps.png" /> |
| 167 | </imageobject> | 527 | </imageobject> |
| 168 | </mediaobject> | 528 | </mediaobject> |
| 169 | </figure> | 529 | </figure> |
| @@ -174,27 +534,40 @@ | |||
| 174 | <section id="man_configuration"> | 534 | <section id="man_configuration"> |
| 175 | <title>Manual Configuration</title> | 535 | <title>Manual Configuration</title> |
| 176 | 536 | ||
| 177 | <para>For Manual Configuration of uCPE networking, select the uCPE device | 537 | <para>For Manual Configuration of uCPE networking, select the uCPE |
| 178 | first and then <literal>Configuration</literal> -> <literal>OpenVSwitch</literal>. | 538 | device first and then <literal>Configuration</literal> -> |
| 179 | In the <literal>Host Interfaces Caps</literal>, one can find a list of available network | 539 | <literal>OpenVSwitch</literal>. In <literal>Host Interfaces |
| 180 | interfaces and their capabilities.</para> | 540 | Caps</literal>, one can find a list of available network interfaces |
| 541 | and their capabilities.</para> | ||
| 181 | 542 | ||
| 182 | <section id="configure_interfaces"> | 543 | <section id="configure_interfaces"> |
| 183 | <title>Configuring Interfaces</title> | 544 | <title>Configuring Interfaces</title> |
| 184 | 545 | ||
| 546 | <para>In order to make physical network interfaces available to the | ||
| 547 | virtualization infrastructure and VNFs, they must be configured into | ||
| 548 | the management system.</para> | ||
| 549 | |||
| 550 | <para>To add an interface into the uCPE Manager, select the uCPE | ||
| 551 | device, then from the top toolbar select <literal>Configuration | ||
| 552 | -> OpenVSwitch -> Host Interfaces</literal>. The available | ||
| 553 | Interface types are detailed below.</para> | ||
| 554 | |||
| 185 | <para><emphasis role="bold">DPDK Interface Type</emphasis></para> | 555 | <para><emphasis role="bold">DPDK Interface Type</emphasis></para> |
| 186 | 556 | ||
| 187 | <para>Configuring a physical interface in DPDK mode will require a | 557 | <para>Configuring a physical interface in DPDK mode will require a |
| 188 | DPDK-based application (e.g. OVS-DPDK) in order to access and use | 558 | DPDK-based application (e.g. OVS-DPDK) in order to access and use |
| 189 | the interface. An interface set as the DPDK can be attached to an | 559 | the interface. An interface set as the DPDK can be attached to an |
| 190 | OVS-DPDK bridge.</para> | 560 | OVS-DPDK bridge.</para> |
| 191 | 561 | ||
| 192 | <para>Select the uCPE device, then from the top toolbar | 562 | <note> |
| 193 | select <literal>Configuration</literal> -> <literal>OpenVSwitch | 563 | <para>Make sure the <literal>Enable DPDK</literal> checkbox is |
| 194 | </literal> -> <literal>Host Interfaces</literal> -> <literal> | 564 | selected in <literal>Device -> Configuration -> |
| 195 | Add</literal>.</para> | 565 | DPDK</literal>, otherwise no interface can be assigned to the |
| 566 | DPDK.</para> | ||
| 567 | </note> | ||
| 196 | 568 | ||
| 197 | <para>For DPDK mode, the user must set values for the following fields:</para> | 569 | <para>To add a DPDK interface under the management system, set |
| 570 | appropriate values for the following fields:</para> | ||
| 198 | 571 | ||
| 199 | <itemizedlist> | 572 | <itemizedlist> |
| 200 | <listitem> | 573 | <listitem> |
| @@ -210,26 +583,27 @@ | |||
| 210 | </listitem> | 583 | </listitem> |
| 211 | 584 | ||
| 212 | <listitem> | 585 | <listitem> |
| 213 | <para>Dpdk-type: the kernel module that allows user space access to the | 586 | <para>Dpdk-type: the kernel module that allows user space access |
| 214 | physical interface.</para> | 587 | to the physical interface. Enea recommends using the |
| 588 | <literal>vfio-pci</literal> driver.</para> | ||
| 215 | </listitem> | 589 | </listitem> |
| 216 | </itemizedlist> | 590 | </itemizedlist> |
| 217 | 591 | ||
| 218 | <para>Create an OpenVSwitch bridge (<literal>ovsbr0</literal>) on | 592 | <para>Create an OpenVSwitch bridge (<literal>ovsbr0</literal>) on |
| 219 | the device that uses a DPDK interface, by selecting the uCPE device, | 593 | the device that uses a DPDK interface type, by selecting the uCPE |
| 220 | then from the top toolbar selecting <literal>Configuration</literal> | 594 | device, then from the top toolbar selecting |
| 221 | -> <literal>OpenVSwitch</literal> -> <literal>Bridges</literal> -> | 595 | <literal>Configuration</literal> -> |
| 222 | <literal>Add</literal>.</para> | 596 | <literal>OpenVSwitch</literal> -> <literal>Bridges</literal> |
| 597 | -> <literal>Add</literal>.</para> | ||
| 223 | 598 | ||
| 224 | <para><emphasis role="bold">SR-IOV Interface Type</emphasis></para> | 599 | <para><emphasis role="bold">SR-IOV Interface Type</emphasis></para> |
| 225 | 600 | ||
| 226 | <para>SR-IOV mode will create a number of virtual functions on the host | 601 | <para>SR-IOV technology allows for the creation of a number of |
| 227 | which can be used to route traffic to VMs. Select the uCPE device, | 602 | virtual functions on the host interface, which can be used by VNFs |
| 228 | then from the top toolbar select <literal>Configuration</literal> | 603 | running on the uCPE device.</para> |
| 229 | -> <literal>OpenVSwitch</literal> -> <literal>Host Interfaces | ||
| 230 | </literal> -> <literal>Add</literal>.</para> | ||
| 231 | 604 | ||
| 232 | <para>For SR-IOV mode, the user must set values for the following fields:</para> | 605 | <para>For SR-IOV mode configuration, the user must set values for |
| 606 | the following fields:</para> | ||
| 233 | 607 | ||
| 234 | <itemizedlist> | 608 | <itemizedlist> |
| 235 | <listitem> | 609 | <listitem> |
| @@ -254,176 +628,220 @@ | |||
| 254 | </listitem> | 628 | </listitem> |
| 255 | </itemizedlist> | 629 | </itemizedlist> |
| 256 | 630 | ||
| 257 | <para><emphasis role="bold">PCI Passthrough Interface | 631 | <para><emphasis role="bold">Standard Interface |
| 258 | Type</emphasis></para> | 632 | Type</emphasis></para> |
| 259 | 633 | ||
| 260 | <para>For the PCI Passthrough a user does not have to configure a | 634 | <para>Some of the physical network interfaces available on a uCPE |
| 261 | physical interface, instead simply select the PCI address and | 635 | device, including Ethernet interfaces, do not have DPDK or SR-IOV |
| 262 | connect it to a virtual port when the VNF instantiation step is reached.</para> | 636 | support. Instead, the Linux kernel driver has to be used. Wi-Fi and |
| 637 | 4G/LTE modems can also be configured and used for virtualization | ||
| 638 | infrastructure and VNFs.</para> | ||
| 639 | |||
| 640 | <para>To add Standard interfaces under the management system, the | ||
| 641 | user must set values for the following fields:</para> | ||
| 642 | |||
| 643 | <itemizedlist> | ||
| 644 | <listitem> | ||
| 645 | <para>Source: the name of physical interface.</para> | ||
| 646 | </listitem> | ||
| 647 | |||
| 648 | <listitem> | ||
| 649 | <para>Networking-type: standard</para> | ||
| 650 | </listitem> | ||
| 651 | </itemizedlist> | ||
| 652 | |||
| 653 | <para condition="hidden"><emphasis role="bold">PCI Passthrough | ||
| 654 | Interface Type</emphasis></para> | ||
| 655 | |||
| 656 | <para condition="hidden">For the PCI Passthrough a user does not | ||
| 657 | have to configure a physical interface, instead simply select the | ||
| 658 | PCI address and connect it to a virtual port when the VNF | ||
| 659 | instantiation step is reached.</para> | ||
| 263 | </section> | 660 | </section> |
| 264 | 661 | ||
| 265 | <section id="configure_bridges"> | 662 | <section id="configure_bridges"> |
| 266 | <title>Configuring Bridges</title> | 663 | <title>Configuring Bridges</title> |
| 267 | 664 | ||
| 268 | <para><emphasis role="bold">In-band Management</emphasis></para> | 665 | <para>After networking interfaces have been added to the uCPE |
| 269 | 666 | Manager, the user can create the necessary OVS bridges.</para> | |
| 270 | <para>In-band Management refers to a model where both the data plane | ||
| 271 | and control plane flow over the same network path.</para> | ||
| 272 | 667 | ||
| 273 | <para>In some situations, In-band Management is the only option | 668 | <para><emphasis role="bold">How to add OVS bridges in the uCPE |
| 274 | available to both control and configure the uCPE device, while also | 669 | Manager</emphasis></para> |
| 275 | allowing for data-path traffic to pass over the same physical | ||
| 276 | interface.</para> | ||
| 277 | 670 | ||
| 278 | <para>The main requirement in order to use this solution is to have all | 671 | <orderedlist> |
| 279 | traffic pass through a defined WAN physical port.</para> | 672 | <listitem> |
| 280 | 673 | <para>Select the uCPE device.</para> | |
| 281 | <para>Three types of traffic are mentioned hereafter:</para> | 674 | </listitem> |
| 282 | 675 | ||
| 283 | <itemizedlist> | ||
| 284 | <listitem> | 676 | <listitem> |
| 285 | <para>Device management. Part of the device configuration done by the | 677 | <para>Select Configuration.</para> |
| 286 | uCPE Manager.</para> | ||
| 287 | </listitem> | 678 | </listitem> |
| 288 | 679 | ||
| 289 | <listitem> | 680 | <listitem> |
| 290 | <para>VNF(s) configuration. Enabling or disabling features of a | 681 | <para>Click OpenvSwitch.</para> |
| 291 | VNF. E.g. enabling/disabling the firewall or VPN setup.</para> | ||
| 292 | </listitem> | 682 | </listitem> |
| 293 | 683 | ||
| 294 | <listitem> | 684 | <listitem> |
| 295 | <para>Data-path. All other traffic that is not used in the | 685 | <para>Select the Bridges option, then click Add.</para> |
| 296 | control plane and needs to reach a LAN network.</para> | ||
| 297 | </listitem> | 686 | </listitem> |
| 298 | </itemizedlist> | 687 | </orderedlist> |
| 299 | 688 | ||
| 300 | <note> | 689 | <note> |
| 301 | <para>For use-cases where latency is very important, it is | 690 | <para>Depending on the settings in <literal>Configuration -> |
| 302 | recommended to use out-of-band management with a dedicated | 691 | OpenVSwitch -> DPDK</literal>, OVS bridges with or without DPDK |
| 303 | physical interface for the data-path.</para> | 692 | support will be used on the uCPE device.</para> |
| 304 | </note> | 693 | </note> |
| 305 | 694 | ||
| 306 | <para>The solution provided by Enea for In-band management is based | 695 | <para>There are three types of bridges which can be created, each |
| 307 | upon Open vSwitch bridges which control all traffic passing through | 696 | one fulfiling a different role:</para> |
| 308 | the WAN physical port. The NFV Access platform will assume the activated | 697 | |
| 309 | connection with the uCPE Manager should be used for In-band management. | 698 | <para><emphasis role="bold">uCPE In-band Management |
| 310 | The physical port used by the active connection will be attached to the | 699 | bridge</emphasis></para> |
| 311 | In-band management WAN bridge. Communication with the uCPE Manager | 700 | |
| 312 | should not be affected, it is reestablished automatically after In-band management | 701 | <para>In-band Management refers to a model where both the data plane |
| 313 | activation.</para> | 702 | and control plane flow over the same network path. In some |
| 314 | 703 | situations (e.g. the uCPE device has only one routable IP address), | |
| 315 | <para>All network traffic, with the exception of any received from | 704 | this is the only option available to both control and configure the |
| 316 | the uCPE Manager, will be sent to the VNF or dropped if there | 705 | uCPE device, while also allowing for data-path traffic to pass over |
| 317 | is no VNF instantiated on the uCPE device. The VNF connected to the | 706 | the same physical interface.</para> |
| 318 | WAN bridge must be configured for In-band management since traffic | 707 | |
| 319 | from the VNF manager and data-path will be sent to only one port | 708 | <para>The solution provided by Enea for in-band management is based |
| 320 | (WAN) of the VNF.</para> | 709 | upon an OpenvSwitch bridge fielding all traffic passing through the |
| 710 | WAN physical port. As a prerequisite, the WAN physical port has to | ||
| 711 | be configured to get its IP through DHCP. Any standard or | ||
| 712 | DPDK-assigned network interface can be used for the In-Band | ||
| 713 | management bridge.</para> | ||
| 321 | 714 | ||
| 322 | <note> | 715 | <note> |
| 323 | <para>Only one VNF must be connected to the In-band management WAN | 716 | <para>The In-Band Management bridge must be recreated each time |
| 324 | bridge.</para> | 717 | the uCPE Manager IP address is changed.</para> |
| 325 | </note> | 718 | </note> |
| 326 | 719 | ||
| 327 | <table> | 720 | <para>To create the In-Band Management bridge, the user must set |
| 328 | <title>Setup Prerequisites</title> | 721 | values for the following fields:</para> |
| 329 | 722 | ||
| 330 | <tgroup cols="2"> | 723 | <itemizedlist> |
| 331 | <colspec align="left" colwidth="2*" /> | 724 | <listitem> |
| 725 | <para>name: name of the bridge.</para> | ||
| 726 | </listitem> | ||
| 332 | 727 | ||
| 333 | <colspec align="left" colwidth="4*" /> | 728 | <listitem> |
| 729 | <para>ovs-bridge-type: inbandMgmt</para> | ||
| 730 | </listitem> | ||
| 334 | 731 | ||
| 335 | <tbody> | 732 | <listitem> |
| 336 | <row> | 733 | <para>mgmt-address: select IPv4 as the type and fill in the IP |
| 337 | <entry>WAN port</entry> | 734 | address of the uCPE Manager.</para> |
| 735 | </listitem> | ||
| 338 | 736 | ||
| 339 | <entry>The physical port supported by DPDK.</entry> | 737 | <listitem> |
| 340 | </row> | 738 | <para>mgmt-port: the NETCONF management port. Enea recommeneds |
| 739 | leaving this field unchanged.</para> | ||
| 740 | </listitem> | ||
| 741 | </itemizedlist> | ||
| 341 | 742 | ||
| 342 | <row> | 743 | <note> |
| 343 | <entry>Dynamic IP on WAN port</entry> | 744 | <para>The first VNF instantiated on the uCPE device must be |
| 745 | connected to the In-Band Management bridge and its WAN interface | ||
| 746 | must be configured as the DHCP client.</para> | ||
| 747 | </note> | ||
| 344 | 748 | ||
| 345 | <entry>The DHCP server configured to distribute the same IP address | 749 | <para><emphasis role="bold">In-band Management bridge for |
| 346 | for the same MAC.</entry> | 750 | VNFs</emphasis></para> |
| 347 | </row> | ||
| 348 | 751 | ||
| 349 | <row> | 752 | <para>If VNF management can be done over a dedicated virtual |
| 350 | <entry>uCPE Manager</entry> | 753 | interface, its possible to extend the networking infrastructure |
| 754 | configuration to also access the VNF's management interface over the | ||
| 755 | WAN port.</para> | ||
| 351 | 756 | ||
| 352 | <entry>The uCPE Manager IP address must be public (accessible | 757 | <para>For this setup, three types of traffic will pass over the WAN |
| 353 | for the uCPE device) and static.</entry> | 758 | physical interface:</para> |
| 354 | </row> | ||
| 355 | </tbody> | ||
| 356 | </tgroup> | ||
| 357 | </table> | ||
| 358 | 759 | ||
| 359 | <para><emphasis role="bold">How to activate In-band Management from | 760 | <itemizedlist> |
| 360 | the uCPE Manager</emphasis></para> | 761 | <listitem> |
| 762 | <para>Device management. Part of the device configuration done | ||
| 763 | by the uCPE Manager.</para> | ||
| 764 | </listitem> | ||
| 361 | 765 | ||
| 362 | <orderedlist> | ||
| 363 | <listitem> | 766 | <listitem> |
| 364 | <para>Select the uCPE device.</para> | 767 | <para>VNF(s) management. Enabling or disabling features of a |
| 768 | VNF. E.g. enabling/disabling the firewall or VPN setup.</para> | ||
| 365 | </listitem> | 769 | </listitem> |
| 366 | 770 | ||
| 367 | <listitem> | 771 | <listitem> |
| 368 | <para>Select Configuration.</para> | 772 | <para>Data-path. All other traffic that is not used in the |
| 773 | control plane and needs to reach a LAN network.</para> | ||
| 369 | </listitem> | 774 | </listitem> |
| 775 | </itemizedlist> | ||
| 776 | |||
| 777 | <para>To create a VNF In-Band Management bridge, the user must set | ||
| 778 | values for the following fields:</para> | ||
| 370 | 779 | ||
| 780 | <itemizedlist> | ||
| 371 | <listitem> | 781 | <listitem> |
| 372 | <para>Click OpenvSwitch.</para> | 782 | <para>name: name of the bridge.</para> |
| 373 | </listitem> | 783 | </listitem> |
| 374 | 784 | ||
| 375 | <listitem> | 785 | <listitem> |
| 376 | <para>Select the Bridges option, then click Add.</para> | 786 | <para>ovs-bridge-type: vnfMgmt</para> |
| 377 | </listitem> | 787 | </listitem> |
| 378 | </orderedlist> | ||
| 379 | 788 | ||
| 380 | <para> | 789 | <listitem> |
| 381 | <emphasis role="bold">In-band management WAN DPDK bridge configuration</emphasis> | 790 | <para>vnf-mgmt-address: select IPv4 as the type and fill in the |
| 382 | </para> | 791 | IP address for management network, e.g 10.0.0.1.</para> |
| 383 | 792 | </listitem> | |
| 384 | <itemizedlist> | 793 | </itemizedlist> |
| 385 | <listitem><para><emphasis role="bold">name</emphasis>. Provide a name for the WAN bridge e.g. | ||
| 386 | "ibm-wan-br".</para></listitem> | ||
| 387 | <listitem><para><emphasis role="bold">ovs-bridge-type</emphasis>. dpdkWan</para></listitem> | ||
| 388 | <listitem><para><emphasis role="bold">mgmt-address</emphasis>. IPv4 (add the IP address of the uCPE Manager machine).</para></listitem> | ||
| 389 | <listitem><para><emphasis role="bold">mgmt-port</emphasis>. 4334</para></listitem> | ||
| 390 | </itemizedlist> | ||
| 391 | 794 | ||
| 392 | <para>The connection between the uCPE device and uCPE Manager will | 795 | <note> |
| 393 | be recreated and all traffic will pass through the new bridge | 796 | <para>VNF management interfaces must be configured in same network |
| 394 | (ibm-wan-br). The WAN port of the very first instantiated VNF must | 797 | as the <literal>vnf-mgmt-address</literal> of the bridge. For more |
| 395 | be connected to the <literal>ibm-wan-br</literal> bridge and it | 798 | information, please see 4.4 <link linkend="vnf_management">VNF |
| 396 | should receive the same IP address as the WAN interfaces of the uCPE device.</para> | 799 | Management</link>.</para> |
| 800 | </note> | ||
| 397 | 801 | ||
| 398 | <figure> | 802 | <para><emphasis role="bold">Data-plane Bridge</emphasis> Data-plane |
| 399 | <title>Enea In-band Management solution</title> | 803 | bridges are generic bridges used for the VNF data-plane. There are |
| 804 | two supported sub-types:</para> | ||
| 400 | 805 | ||
| 401 | <mediaobject> | 806 | <itemizedlist> |
| 402 | <imageobject> | 807 | <listitem> |
| 403 | <imagedata align="center" | 808 | <para>communication: allows for VNF communication towards |
| 404 | fileref="images/In-bandManagement.png" scale="65" /> | 809 | LAN/WAN networks. This bridge type has at least one physical |
| 405 | </imageobject> | 810 | port attached to it.</para> |
| 406 | </mediaobject> | 811 | </listitem> |
| 407 | </figure> | ||
| 408 | 812 | ||
| 409 | <para>The VNF can be reached on the same IP address as the uCPE | 813 | <listitem> |
| 410 | device, e.g. <literal>https://<WAN_IP></literal> if a HTTP | 814 | <para>integration: allows for VNF-to-VNF communication (usually |
| 411 | server is present on that VNF.</para> | 815 | for service function chaining). This bridge type does not have |
| 816 | any physical port attached.</para> | ||
| 817 | </listitem> | ||
| 818 | </itemizedlist> | ||
| 412 | 819 | ||
| 413 | <note> | 820 | <para>To create a Data-plane bridge, the user must set values for |
| 414 | <para>The In-band management bridge must be recreated each time | 821 | the following fields:</para> |
| 415 | the uCPE Manager IP is changed.</para> | 822 | |
| 416 | </note> | 823 | <itemizedlist> |
| 824 | <listitem> | ||
| 825 | <para>name: name of the bridge.</para> | ||
| 826 | </listitem> | ||
| 827 | |||
| 828 | <listitem> | ||
| 829 | <para>ovs-bridge-type: select <literal>communication</literal> | ||
| 830 | or <literal>integration</literal>, depending on intended usage. | ||
| 831 | For communication bridges, physical interfaces can be added to | ||
| 832 | the bridge.</para> | ||
| 833 | </listitem> | ||
| 834 | </itemizedlist> | ||
| 417 | </section> | 835 | </section> |
| 418 | </section> | 836 | </section> |
| 419 | 837 | ||
| 420 | <section id="zero_touch_prov"> | 838 | <section id="zero_touch_prov"> |
| 421 | <title>Zero Touch Provisioning</title> | 839 | <title>Zero Touch Provisioning</title> |
| 422 | 840 | ||
| 423 | <para>Zero-Touch Provisioning (ZTP) refers to the process of when a device | 841 | <para>Zero-Touch Provisioning (ZTP) refers to the process of when a |
| 424 | starts up for the first time and its initial configuration is pushed down | 842 | device starts up for the first time and its initial configuration is |
| 425 | by an external management system, so that it is setup for proper | 843 | pushed down by an external management system, so that it is setup for |
| 426 | operation without additional manual intervention by an | 844 | proper operation without additional manual intervention by an |
| 427 | operator. ZTP is an alternative to Manual configuration.</para> | 845 | operator. ZTP is an alternative to Manual configuration.</para> |
| 428 | 846 | ||
| 429 | <para>A variety of operations can occur as part of ZTP such as initial | 847 | <para>A variety of operations can occur as part of ZTP such as initial |
| @@ -432,36 +850,40 @@ | |||
| 432 | operator to be physically present (initially) to manage the | 850 | operator to be physically present (initially) to manage the |
| 433 | device.</para> | 851 | device.</para> |
| 434 | 852 | ||
| 435 | <para>An offline configuration can be prepared in advance for the uCPE | 853 | <para>An offline configuration is usually prepared in advance for the |
| 436 | Manager to setup the infrastructure on the device.</para> | 854 | uCPE Manager to setup the virtualization infrastructure on the uCPE |
| 855 | device, as soon as a device enrolls into the management system.</para> | ||
| 437 | 856 | ||
| 438 | <section id="offline_configuration"> | 857 | <section id="offline_configuration"> |
| 439 | <title>Offline Configuration</title> | 858 | <title>Offline Configuration</title> |
| 440 | 859 | ||
| 441 | <para>The Offline Configuration subsystem is used to pre-populate a | 860 | <para>The Offline Configuration subsystem is used to pre-populate a |
| 442 | configuration for a device that will be brought under management at | 861 | configuration for a device that will be brought under management at |
| 443 | a future point in time.</para> | 862 | a future point in time. When creating an offline configuration store |
| 444 | 863 | a <literal>Device ID</literal> can be specified. This ID uniquely | |
| 445 | <para>When creating an offline configuration store a | 864 | identifies the device to be initialized.</para> |
| 446 | <literal>Device ID</literal> can be specified. This ID | 865 | |
| 447 | uniquely identifies the device to be initialized.</para> | 866 | <para>Alternatively, a wildcard can be used in the <literal>Device |
| 448 | 867 | ID</literal> field, which results in a configuration being pushed on | |
| 449 | <para>From the top toolbar menu select <literal>Applications</literal> -> | 868 | all uCPE devices upon their initial connection towards the uCPE |
| 450 | <literal>Offline Config</literal> -> <literal>Add</literal>. | 869 | Manager.</para> |
| 451 | Specify the exact value of the <literal>Device ID</literal> in the | 870 | |
| 452 | required field. This will tag the device needed for | 871 | <para>To create an offline configuration, from the top toolbar menu |
| 453 | the initial configuration provided by the | 872 | select <literal>Applications</literal> -> <literal>Offline |
| 454 | offline configuration store. Choose <literal>Merge</literal> as the | 873 | Config</literal> -> <literal>Add</literal>. Specify the value of |
| 455 | "Default Upload Method" if you do not want any boot configuration set | 874 | the <literal>Device ID</literal> in the required field or wildcard |
| 456 | on the device, to be wiped out. Selecting <literal>Replace</literal> | 875 | if appropriate. Choose <literal>Merge</literal> as the "Default |
| 457 | will set the entire device configuration to match values in the | 876 | Upload Method" if you do not want any boot configuration set on the |
| 458 | offline configuration.</para> | 877 | device, to be wiped out. Selecting <literal>Replace</literal> will |
| 878 | set the entire device configuration to match values in the offline | ||
| 879 | configuration.</para> | ||
| 459 | 880 | ||
| 460 | <para>After creating the Offline Config Store, access the device | 881 | <para>After creating the Offline Config Store, access the device |
| 461 | through <literal>Applications</literal> -> <literal>offline config</literal> | 882 | through <literal>Applications</literal> -> <literal>offline |
| 462 | -> <literal>Config App</literal> and provision it with the required initial | 883 | config</literal> -> <literal>Config App</literal> and provision |
| 463 | configuration. This operation mirrors what happens during regular | 884 | it with the required initial configuration. This operation mirrors |
| 464 | offline configuration.</para> | 885 | what happens during manual configuration described in the previous |
| 886 | section.</para> | ||
| 465 | </section> | 887 | </section> |
| 466 | </section> | 888 | </section> |
| 467 | </section> | 889 | </section> |
| @@ -509,8 +931,9 @@ | |||
| 509 | </listitem> | 931 | </listitem> |
| 510 | 932 | ||
| 511 | <listitem> | 933 | <listitem> |
| 512 | <para>Get access to the VNF specific VNF Manager for day 1 and 2 | 934 | <para>Optionally, get access to the VNF specific VNF Manager for |
| 513 | configuration (in cloud or for local deployment).</para> | 935 | day 1 and 2 configuration (in cloud or for local |
| 936 | deployment).</para> | ||
| 514 | </listitem> | 937 | </listitem> |
| 515 | 938 | ||
| 516 | <listitem> | 939 | <listitem> |
| @@ -548,18 +971,18 @@ | |||
| 548 | 971 | ||
| 549 | <listitem> | 972 | <listitem> |
| 550 | <para>Determine the amount of hardware resources needed for | 973 | <para>Determine the amount of hardware resources needed for |
| 551 | the VNF (RAM, CPUs and Disk size).</para> | 974 | the VNF (RAM, number of CPUs and storage size).</para> |
| 552 | </listitem> | 975 | </listitem> |
| 553 | 976 | ||
| 554 | <listitem> | 977 | <listitem> |
| 555 | <para>Determine how many Network Interfaces the VNF will | 978 | <para>Determine how many Virtual Network Interfaces the VNF |
| 556 | use.</para> | 979 | will use.</para> |
| 557 | </listitem> | 980 | </listitem> |
| 558 | </itemizedlist> | 981 | </itemizedlist> |
| 559 | </listitem> | 982 | </listitem> |
| 560 | 983 | ||
| 561 | <listitem> | 984 | <listitem> |
| 562 | <para>Determine the day zero configuration method from the VNF | 985 | <para>Determine the Day-0 configuration method from the VNF |
| 563 | Getting Started guidelines.</para> | 986 | Getting Started guidelines.</para> |
| 564 | 987 | ||
| 565 | <note> | 988 | <note> |
| @@ -596,14 +1019,14 @@ | |||
| 596 | <listitem> | 1019 | <listitem> |
| 597 | <para>When prompted by the UI, make sure the <literal>VM | 1020 | <para>When prompted by the UI, make sure the <literal>VM |
| 598 | Image</literal> radio button at the top of the onboarding screen | 1021 | Image</literal> radio button at the top of the onboarding screen |
| 599 | is selected, it will trigger a popup menu.</para> | 1022 | is selected, it will trigger a popup menu window.</para> |
| 600 | </listitem> | 1023 | </listitem> |
| 601 | </orderedlist> | 1024 | </orderedlist> |
| 602 | 1025 | ||
| 603 | <para>This menu contains data fields where both necessary and optional | 1026 | <para>This window contains data fields where both necessary and |
| 604 | information about the VNF can be supplied. After doing so, press the | 1027 | optional information about the VNF can be supplied. After doing so, |
| 605 | onboard button, the uCPE Manager will create the VNF package and | 1028 | press the Onboard button, the uCPE Manager will create the VNF |
| 606 | onboard it.</para> | 1029 | descriptor and add it to its VNF Catalog.</para> |
| 607 | 1030 | ||
| 608 | <figure> | 1031 | <figure> |
| 609 | <title>Onboard a VNF</title> | 1032 | <title>Onboard a VNF</title> |
| @@ -634,7 +1057,7 @@ | |||
| 634 | <listitem> | 1057 | <listitem> |
| 635 | <para><emphasis role="bold">VNF Type Name</emphasis>. This is the | 1058 | <para><emphasis role="bold">VNF Type Name</emphasis>. This is the |
| 636 | name that will be used to identify this VNF. It will be shown in | 1059 | name that will be used to identify this VNF. It will be shown in |
| 637 | the VNF tables.</para> | 1060 | the VNFs list.</para> |
| 638 | </listitem> | 1061 | </listitem> |
| 639 | 1062 | ||
| 640 | <listitem> | 1063 | <listitem> |
| @@ -741,8 +1164,8 @@ | |||
| 741 | <literal>Path</literal>. When a user uses the uCPE Manager to | 1164 | <literal>Path</literal>. When a user uses the uCPE Manager to |
| 742 | create an instance for multiple VNFs, they will be prompted to | 1165 | create an instance for multiple VNFs, they will be prompted to |
| 743 | provide a data file for each entry in this table. Each type of VNF | 1166 | provide a data file for each entry in this table. Each type of VNF |
| 744 | will require different cloud-init files, e.g.: a license | 1167 | will require different cloud-init files, e.g.: a license file. |
| 745 | file.</para> | 1168 | </para> |
| 746 | </listitem> | 1169 | </listitem> |
| 747 | </orderedlist> | 1170 | </orderedlist> |
| 748 | 1171 | ||
| @@ -760,8 +1183,40 @@ | |||
| 760 | 1183 | ||
| 761 | <para><emphasis role="bold">Property Values</emphasis></para> | 1184 | <para><emphasis role="bold">Property Values</emphasis></para> |
| 762 | 1185 | ||
| 763 | <para><literal>numHugePages</literal> defines the number of huge | 1186 | <itemizedlist> |
| 764 | memory pages the VNF uses (for DPDK).</para> | 1187 | <listitem> |
| 1188 | <para><literal>numHugePages</literal> defines the number of huge | ||
| 1189 | memory pages the VNF uses (for DPDK).</para> | ||
| 1190 | </listitem> | ||
| 1191 | |||
| 1192 | <listitem> | ||
| 1193 | <para><literal>vnfMgmtIpAddress</literal>: the IP address of the | ||
| 1194 | VNF's management interface, connected to a | ||
| 1195 | <literal>vnfMgmt</literal> bridge (e.g. 10.0.0.2).</para> | ||
| 1196 | </listitem> | ||
| 1197 | |||
| 1198 | <listitem> | ||
| 1199 | <para><literal>internalMgmtPort</literal>: the VNF's TCP/UDP port | ||
| 1200 | used for management (e.g. 443).</para> | ||
| 1201 | </listitem> | ||
| 1202 | |||
| 1203 | <listitem> | ||
| 1204 | <para><literal>externalMgmtPort</literal>: the Management port | ||
| 1205 | used for external access (e.g. 60001).</para> | ||
| 1206 | </listitem> | ||
| 1207 | </itemizedlist> | ||
| 1208 | |||
| 1209 | <note> | ||
| 1210 | <para>The last three properties are useful in conjuction with the | ||
| 1211 | <literal>vnfMgmt</literal> bridge type. They allow the user to map | ||
| 1212 | the internal VNF management port to an external port, useful for VNF | ||
| 1213 | configuration from WAN. </para> | ||
| 1214 | |||
| 1215 | <para>In the previous example, the internal TCP port 443 (HTTPS) was | ||
| 1216 | mapped to the external port 60001, which allows the user to access | ||
| 1217 | the VNF management port from a web browser e.g. | ||
| 1218 | <literal>https://<WAN_IP>:60001</literal>.</para> | ||
| 1219 | </note> | ||
| 765 | </section> | 1220 | </section> |
| 766 | </section> | 1221 | </section> |
| 767 | 1222 | ||
| @@ -770,8 +1225,10 @@ | |||
| 770 | 1225 | ||
| 771 | <para>When a VNF is onboarded and available in the VNF catalog, it can | 1226 | <para>When a VNF is onboarded and available in the VNF catalog, it can |
| 772 | be instantiated on connected uCPE devices. The configurations provided | 1227 | be instantiated on connected uCPE devices. The configurations provided |
| 773 | when the VNF is onboarded, serve as a template for instantiation. Follow | 1228 | when the VNF is onboarded, serve as a template for instantiation. |
| 774 | the instructions below to instantiate a VNF:</para> | 1229 | </para> |
| 1230 | |||
| 1231 | <para>Follow the instructions below to instantiate a VNF:</para> | ||
| 775 | 1232 | ||
| 776 | <orderedlist> | 1233 | <orderedlist> |
| 777 | <listitem> | 1234 | <listitem> |
| @@ -788,11 +1245,11 @@ | |||
| 788 | 1245 | ||
| 789 | <itemizedlist spacing="compact"> | 1246 | <itemizedlist spacing="compact"> |
| 790 | <listitem> | 1247 | <listitem> |
| 791 | <para>Name (a descriptive name).</para> | 1248 | <para>Name: a descriptive name.</para> |
| 792 | </listitem> | 1249 | </listitem> |
| 793 | 1250 | ||
| 794 | <listitem> | 1251 | <listitem> |
| 795 | <para>Device (the uCPE device to instantiate the VNF on).</para> | 1252 | <para>Device: the uCPE device to instantiate the VNF on.</para> |
| 796 | </listitem> | 1253 | </listitem> |
| 797 | 1254 | ||
| 798 | <listitem> | 1255 | <listitem> |
| @@ -805,8 +1262,7 @@ | |||
| 805 | </listitem> | 1262 | </listitem> |
| 806 | 1263 | ||
| 807 | <listitem> | 1264 | <listitem> |
| 808 | <para>Set up each NIC with a driver method (DPDK or | 1265 | <para>Set up each NIC with a driver method.</para> |
| 809 | e1000).</para> | ||
| 810 | </listitem> | 1266 | </listitem> |
| 811 | </itemizedlist> | 1267 | </itemizedlist> |
| 812 | 1268 | ||
| @@ -839,7 +1295,7 @@ | |||
| 839 | </section> | 1295 | </section> |
| 840 | 1296 | ||
| 841 | <section id="enter_console"> | 1297 | <section id="enter_console"> |
| 842 | <title>Entering the VNF Console</title> | 1298 | <title>Accessing the VNF console</title> |
| 843 | 1299 | ||
| 844 | <para>Once the VNF is deployed, the VNF console can be entered using SSH | 1300 | <para>Once the VNF is deployed, the VNF console can be entered using SSH |
| 845 | and virsh commands. The VNF Console is a typical starting point for | 1301 | and virsh commands. The VNF Console is a typical starting point for |
| @@ -872,4 +1328,4 @@ | |||
| 872 | </orderedlist> | 1328 | </orderedlist> |
| 873 | </section> | 1329 | </section> |
| 874 | </section> | 1330 | </section> |
| 875 | </chapter> | 1331 | </chapter> \ No newline at end of file |
