docs/APPC CDT Guide/APPC CDT Guide.rst

   1 .. ============LICENSE_START==========================================
   2 .. ===================================================================
   3 .. Copyright © 2018 AT&T Intellectual Property. All rights reserved.
   4 .. ===================================================================
   5 .. Licensed under the Creative Commons License, Attribution 4.0 Intl.  (the "License");
   6 .. you may not use this documentation except in compliance with the License.
   7 .. You may obtain a copy of the License at
   8 ..
   9 ..  https://creativecommons.org/licenses/by/4.0/
  10 ..
  11 .. Unless required by applicable law or agreed to in writing, software
  12 .. distributed under the License is distributed on an "AS IS" BASIS,
  13 .. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14 .. See the License for the specific language governing permissions and
  15 .. limitations under the License.
  16 .. ============LICENSE_END============================================
  17
  18 .. _appc_cdt_guide:
  19
  20 ===================
  21 APPC CDT User Guide
  22 ===================
  23
  24 Introduction
  25 ============
  26
  27 This document is the APPC Controller Design Tool (CDT) User Guide for self-service
  28 onboarding of VNF’s. VNF owners can create templates and other artifacts
  29 for APPC Configure command (used to apply a post-instantiation
  30 configuration) as well as other life cycle commands.
  31
  32 A complete list of all APPC supported commands is contained in the
  33 APPC LCM API Guide available on onap.readthedocs.io.
  34
  35 Overview of APPC Support for VNF Configuration and Lifecycle Commands
  36 ======================================================================
  37
  38 APPC is an ONAP component that performs functions to manage the
  39 lifecycle of VNF’s and their component. The picture below summarizes the
  40 APP-C design intent.
  41
  42 |image0|
  43
  44 Some lifecycle commands are supported on any VNF type, such as commands
  45 executed using OpenStack or for generic REST calls such as for
  46 HealthCheck. Other commands require models called templates to be
  47 created in the APPC Controller Design Tool(CDT) by the VNF owner.
  48
  49 Templates are needed for lifecycle commands such as for
  50 post-instantiation configuration and for passing payloads to a Chef or
  51 Ansible server. Templates contain static and instance-specific
  52 parameters in a structured language (currently limited to xml and JSON).
  53 The APPC CDT allows a VNF technology owner to identify the
  54 instance specific parameters with a unique name.
  55
  56 At run time, the instance specific parameter values are populated in the
  57 template to replace the parameter name.
  58
  59 |image1|
  60
  61 |image2|
  62
  63 |image3|
  64
  65 Overview of the Onboarding Process
  66 ==================================
  67
  68 Pre-Requisites for Onboarding:
  69 ------------------------------
  70
  71 -  The VNF must support the below listed device protocols along with OpenStack for VM-level commands:
  72    - Netconf,
  73    - Chef,
  74    - Ansible,
  75    - REST  - The REST protocol is used for REST interfaces to a VNF. Currently, the only action that can use REST is HealthCheck.
  76    - RESTCONF - The RESTCONF protocal is used only for VNFs that support Netconf and are able to be mounted in OpenDayLight (ODL). Use the protocal NETCONF-XML if the VNF is not ODL mountable.
  77
  78 -  In order to build the templates needed for lifecycle commands, the
  79    VNF owner will be asked to upload either an xml file (for Netconf) or
  80    a JSON file (for Chef or Ansible). This file contains the parameter
  81    values in a valid schema that would be sent to either the VNF or the
  82    Chef/Ansible server to execute the action. For more detail on
  83    Netconf, Chef, or Ansible, see the ONAP vendor guidelines at:
  84
  85    https://wiki.onap.org/pages/viewpage.action?pageId=1015852&preview=/1015849/1017888/VNF%20Management%20Requirements%20for%20OpenECOMP.pdf
  86
  87 -  The VNF related key identifiers (vnf-type, vnfc-type,
  88    vnfc-function-code) that will be stored in A&AI have been defined.
  89
  90 Onboarding Process Steps:
  91 -------------------------
  92
  93 1. Use the APPC CDT GUI to populate **reference data**
  94    describing the VNF and action to be onboarded.
  95
  96     -  Select the VNF, action, and protocol to be on-boarded.
  97
  98     -  Describe the VM/VNFC components that comprise the VNF’s. APPC
  99        will use this VM/VNFC data to update A&AI when configuring the VNF
 100        at run time.
 101
 102 2. Create a **template** from a “golden” configuration file.
 103
 104         -  Upload a “golden configuration” file (described later) into the APPC CDT GUI.
 105
 106         -  Manually edit the configuration file to associate parameter names
 107            with instance-specific values you wish to parameterize (e.g., IP addresses).
 108
 109         -  This creates a template file, which will be used at run-time to
 110            create the payload that APPC sends to the VNF or to Ansible/Chef.
 111
 112         -  Alternative: If the golden configuration changes, rather than
 113            manually re-creating an updated template, you can *automatically*
 114            create an updated template by **Merging** a current parameter
 115            name-value pairs file with the new configuration file. APPC will
 116            scan the new configuration file, and automatically replace values
 117            with parameter names.
 118
 119 3. Create a **parameter definition** file describing instance-specific
 120    parameters in the template.
 121
 122         -  Once you have a template, use the **Synchronize Template Parameters** button to
 123            automatically create/update a parameter definition file (and a
 124            parameter name-value pair file) based on the template.
 125
 126         -  You can then populate/update the fields describing each parameter.
 127
 128         -  If the parameters will be populated from external systems (such as INSTAR), you can upload
 129            a “key file” that automatically populates key fields used to retrieve
 130            data from the external system.
 131
 132         -  If the parameters will be populated from A&AI, you can select the
 133            rules and key fields used to retrieve data from A&AI.
 134
 135         -  The parameter definition file will be used at run time to
 136            automatically obtain parameter values from external system, A&AI, or a user
 137            input spreadsheet for insertion into the template.
 138
 139 4. Create a **parameter name-value pair file** for those parameters.
 140
 141         -  Once you have a template, use the **Synchronize Template Parameters** button to
 142            automatically create a parameter name-value pair file (and a
 143            parameter definition file) based on the template.
 144
 145         -  The parameter name-value file serves as a guide for populating
 146            instance-specific data into the user input spreadsheet used at run
 147            time. The parameter name-value file can also be used to automatically
 148            create a template via the **Merge** function as described in step 2.
 149
 150         - You can also use the **Synchronize With Name Values** button to update the parameter definitions to match an existing parameter name-values pair file.
 151
 152 5. **Test** the template in your test environment using the **TEST** function of APPC CDT
 153
 154         -  Use the **Save All to APP-C** button in the CDT GUI to save the
 155            artifacts for your VNF to APPC.  This makes the current version of artifacts available to both the APPC CDT and APPC Run Time.
 156
 157         -  Prepare a “user input” excel file on your PC and upload it to the APPC CDT.
 158
 159         -  **Execute** the onboarded action on the VNF. View test progress and test results. .
 160
 161 The screen shots in following sections illustrate how to use the APPC CDT GUI for each step.
 162
 163 Artifacts used for Onboarding:
 164 ------------------------------
 165
 166 For a given VNF, each action must be on-boarded separately. Actions can
 167 be on-boarded in any order; it is not required that “Configure” be the first action onboarded.
 168
 169 You will create 1 Reference Data file for each VNF, and a set of up to 3
 170 files for each action you are onboarding:
 171
 172         1. Template
 173         2. Parameter definition file (pd\_configure)
 174         3. Parameter name-value pair file (param\_configure)
 175
 176 For example, onboarding the “vABC” VNF for 2 actions (Configure and
 177 ConfigModify) may result in these 7 files:
 178
 179         1. reference\_AllAction\_vABC\_0.0.1V
 180         2. template\_Configure\_vABC\_0.0.1V
 181         3. pd\_Configure\_vABC\_0.0.1V
 182         4. param\_Configure\_vABC\_0.0.1V
 183         5. template\_ConfigModify\_vABC\_0.0.1V
 184         6. pd\_ConfigModify\_vABC\_0.0.1V
 185         7. param\_ConfigModify\_vABC\_0.0.1V
 186
 187 A **Template** is required for the Ansible, Chef and Netconf protocols.
 188
 189 The **Parameter Definition** and **Parameter Name-Value Pair** artifacts
 190 are typically used with the Configure and ConfigModify templates and are
 191 optional for templates of other actions.
 192
 193 OpenStack and REST protocols do not use a template or parameter
 194 definitions or name-value pairs.
 195
 196 Using the APPC Controller Design Tool for VNF Onboarding
 197 ========================================================
 198
 199 Go to the APPC CDT GUI in the test environment using a Firefox browser.
 200
 201 http://<server>:8080/config-design-tool/index.html#/home
 202
 203 |image4|
 204
 205 Clicking on “About Us” will display the current software version and who to contact for support. The contact information is configurable. What is display in diagram is just an example.
 206
 207 |image5|
 208
 209 Choose “My VNF’s”.
 210
 211 If you have not used APPC CDT previously, you will be asked to
 212 enter your user id. Your work will be stored under this user id. There
 213 is no password required at this time.
 214
 215 Note: If multiple self-service users will be working on a set of VNF’s,
 216 it is suggested that you enter a group\_name rather than your user\_id.
 217 This group name would be used by all users in the group so that all
 218 users can view/edit the same set of artifacts.
 219
 220 If you have previously used APPC CDT, you user id will
 221 automatically be selected.
 222
 223 |image6|
 224
 225 The “My VNFs” GUI displays a list of the vnf-type/vnfc-types which are
 226 stored under your userid in the APPC database. You can choose either
 227 “Create New VNF” or “View/Edit” for one of your existing VNF’s.
 228
 229 |image7|
 230
 231 If you have not created any VNF artifacts in the current release of the
 232 APPC CDT, you will see a screen like this; click “Create new
 233 VNF” to begin.
 234
 235 VNF artifacts created using earlier versions of the APPC CDT
 236 can be uploaded and then edited/saved, as shown on later screens. You
 237 should not have to re-create these VNF artifacts.
 238
 239 |image8|
 240
 241 If you choose to create a new VNF, you will see a pop-up box like this.
 242
 243 |image9|
 244
 245 Enter the VNF Type (and optional VNFC Type) and click next. (The optional VNFC check box is explained later)
 246
 247 Alternatively, you can leave the VNF type blank and choose “PROCEED
 248 ANYWAY” if you want to proceed to the Reference Data screen where you
 249 can populate the VNF reference data by uploading an existing Reference
 250 File or by manually entering it.
 251
 252 You must populate the VNF field if uploading the existing file does not
 253 populate it.
 254
 255 Populate reference data describing the VNF and action to be onboarded
 256 ---------------------------------------------------------------------
 257
 258 |image10|
 259
 260 |image11|
 261
 262 |image12|
 263
 264 |image13|
 265
 266 |image14|
 267
 268 Note 1: When downloading your work to APPC; the system will download
 269 only the artifacts that have been updated in the current session. You
 270 may not see all 4 artifacts unless you visit/edit the reference,
 271 template, parameter and parameter definition screens.
 272
 273 Note 2: When downloading files, the system will display a pop-up window
 274 for each file, but the windows are all placed on top of each other. You
 275 can drag the pop-up windows if you want to see them all at the same
 276 time.
 277
 278 |
 279
 280
 281
 282 |
 283
 284 When using the Mozilla Firefox browser, selecting “Download to PC will display a dialog box giving you a choice of opening or saving the files, and an option to “Do this automatically for files like this for now on”. Choosing “save” and checking this option is a convenient way to easily save multiple downloaded artifacts from APP-C to your PC
 285
 286 |image15a|
 287
 288 Note regarding VNFC Type
 289 ~~~~~~~~~~~~~~~~~~~~~~~~
 290
 291 There are a limited number of VNF’s that are identified by both VNF type and VNFC type. When adding a new VNF of this kind to APP-C, enter the VNF type and check the VNFC box in the pop-up window, and choose NEXT.
 292
 293 Alternatively, you can leave the VNF type blank and choose “PROCEED ANYWAY” if you want to proceed to the Reference Data screen where you can populate the VNF reference data by uploading an existing Reference File or by manually entering it.
 294
 295 |image15b|
 296
 297 On the subsequent Reference screen, you must add the VNFC type(s).
 298
 299 |image15c|
 300
 301 Enter the new VNFC type and click ADD to add it to a drop-down list of VNFC types for this VNF.  Repeat for each VNFC type you wish to add.
 302
 303 |image15d|
 304
 305 Choose the desired VNFC Type from the drop-down list of VNFC types.
 306
 307 |image15e|
 308
 309 In the VNFC section, you must re-enter the VNFC type to match what you previously selected.
 310
 311 |image15f|
 312
 313 Populate OpenStack actions for a VM
 314 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 315
 316 You can also onboard OpenStack commands for the VM level components of
 317 the VNF
 318
 319 Under ‘Action’, select “OpenStack Actions” and then under ‘Protocol’
 320 select “OpenStack”.
 321
 322 You must populate the ‘VNF type’ if it is not already populated.
 323
 324 |image16|
 325
 326 Next, upload an excel file of VM capabilities for your VNF. The excel
 327 must list OpenStack actions in the first column, and then have a column
 328 for each VM type (i.e., VNFC Function Code) showing which actions are
 329 applicable for that VM type, as shown Excel sample below:
 330
 331 |imageA|
 332
 333 APPC will import the data from the excel and display the results.
 334
 335 |image17|
 336
 337 The Template and Parameter Definition tabs do not apply to OpenStack
 338 commands.
 339
 340 **REFERENCE DATA SCREEN HELP**
 341
 342 +--------------------------+------------------------------------------------------------------------------------------------------------------+
 343 | **Field/Object**         | **Description**                                                                                                  |
 344 +==========================+==================================================================================================================+
 345 |                                                     **VNF Reference Data**                                                                  |
 346 +--------------------------+------------------------------------------------------------------------------------------------------------------+
 347 | Action                   | The action to be executed on the VNF, e.g., “CONFIGURE” (see table below).                                       |
 348 +--------------------------+------------------------------------------------------------------------------------------------------------------+
 349 | VNF Type                 | The name of the VNF, e.g. vDBE.                                                                                  |
 350 +--------------------------+------------------------------------------------------------------------------------------------------------------+
 351 | VNFC Type                | NA when describing a VNF; When describing a VNFC, enter the VNFC name e.g.,MSC, SSC, MMC, etc.                   |
 352 +--------------------------+------------------------------------------------------------------------------------------------------------------+
 353 | Device Protocol          | Choose desired protocol e.g., NETCONF-XML (see table below).                                                     |
 354 +--------------------------+------------------------------------------------------------------------------------------------------------------+
 355 | Template                 | Will there be a template created for this VNF and action? Yes/No.                                                |
 356 +--------------------------+------------------------------------------------------------------------------------------------------------------+
 357 | User Name                | Enter the user name used to configure the VNF e.g., “admin” or “root”.                                           |
 358 +--------------------------+------------------------------------------------------------------------------------------------------------------+
 359 | Port Number              | Enter the port number used to configure the VNF, e.g., 22.                                                       |
 360 +--------------------------+------------------------------------------------------------------------------------------------------------------+
 361 | Context URL              | Enter the context portion of the REST URL (Currently used only for the HealthCheck action with REST protocol).   |
 362 +--------------------------+------------------------------------------------------------------------------------------------------------------+
 363 |                                                      **VNFC information**                                                                   |
 364 +--------------------------+------------------------------------------------------------------------------------------------------------------+
 365 | VNFC Type                | Enter the VNFC name e.g. MSC, SSC, MMC, etc.                                                                     |
 366 +--------------------------+------------------------------------------------------------------------------------------------------------------+
 367 | VNFC Function Code       | Enter the standard 3 character value for the VNFC.                                                               |
 368 +--------------------------+------------------------------------------------------------------------------------------------------------------+
 369 | IP Address V4 OAM VIP    | Select Y to store the O&AM VIP address with the VNFC record; otherwise select N.                                 |
 370 +--------------------------+------------------------------------------------------------------------------------------------------------------+
 371 | Group Notation Type      | Select the naming scheme for VNFC/VM instances (first-vnfc-name, fixed value, relative value)                    |
 372 +--------------------------+------------------------------------------------------------------------------------------------------------------+
 373 | Group Notation Value     | For first-vnfc-name type, enter text such as “pair” or “group”.                                                  |
 374 |                          |                                                                                                                  |
 375 |                          | For fixed value type, enter any alpha-numeric text “1”, “test” etc.                                              |
 376 |                          |                                                                                                                  |
 377 |                          | For relative value type, enter a number “1”, “2”, “4”, etc                                                       |
 378 +--------------------------+------------------------------------------------------------------------------------------------------------------+
 379 | Number of VM’s           | Enter the # of VM’s for this VNFC.                                                                               |
 380 +--------------------------+------------------------------------------------------------------------------------------------------------------+
 381
 382 |
 383
 384 This table shows which actions and protocols are currently available for
 385 on-boarding with the Beijing release.
 386
 387 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
 388 |  **Action**                            |**Netconf-XML**| **Ansible**   | **Chef**   | **REST**   | **OpenStack**  |**Protocol is**|
 389 |                                        |**Restconf**   |               |            |            | **(VM Level)** |**Not**        |
 390 |                                        |               |               |            |            |                |**Applicable** |
 391 +========================================+===============+===============+============+============+================+===============+
 392 | **ActionStatus**                       |               |               |            |            |                |     NA        |
 393 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
 394 | **AttachVolume**                       |               |               |            |            | YES            |               |
 395 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
 396 | **Audit**                              | YES           | YES           | YES        | YES        |                |               |
 397 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
 398 | **CheckLock**                          |               |               |            |            |                |     NA        |
 399 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
 400 | **Configure**                          | YES           | YES           | YES        |            |                |               |
 401 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
 402 | **Config Modify**                      | YES           | YES           | YES        |            |                |               |
 403 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
 404 | **Config Backup**                      |               | YES           | YES        |            |                |               |
 405 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
 406 | **Config Restore**                     |               | YES           | YES        |            |                |               |
 407 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
 408 | **ConfigScaleOut**                     | YES           | YES           | YES        |            |                |               |
 409 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
 410 | **DetachVolume**                       |               |               |            |            | YES            |               |
 411 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
 412 | **Evacuate**                           |               |               |            |            | YES            |               |
 413 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
 414 | **HealthCheck**                        |               | YES           | YES        | YES        |                |               |
 415 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
 416 | **Lock**                               |               |               |            |            |                |      NA       |
 417 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
 418 | **Migrate**                            |               |               |            |            | YES            |               |
 419 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
 420 | **QuiesceTraffic**                     |               | YES           | YES        |            |                |               |
 421 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
 422 | **Rebuild**                            |               |               |            |            | YES            |               |
 423 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
 424 | **Restart**                            |               |               |            |            | YES            |               |
 425 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
 426 | **ResumeTraffic**                      |               | YES           | YES        |            |                |               |
 427 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
 428 | **Snapshot**                           |               |               |            |            | YES            |               |
 429 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
 430 | **Start**                              |               |               |            |            | YES            |               |
 431 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
 432 | **Start Application**                  |               | YES           | YES        |            |                |               |
 433 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
 434 | **Stop**                               |               |               |            |            | YES            |               |
 435 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
 436 | **Stop Application**                   |               | YES           | YES        |            |                |               |
 437 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
 438 | **Sync**                               | YES           | YES           | YES        |  YES       |                |               |
 439 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
 440 | **Unlock**                             |               |               |            |            |                |       NA      |
 441 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
 442 | **UpgradeBackout**                     |               | YES           | YES        |            |                |               |
 443 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
 444 | **UpgradeBackup**                      |               | YES           | YES        |            |                |               |
 445 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
 446 | **UpgradePostCheck**                   |               | YES           | YES        |            |                |               |
 447 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
 448 | **UpgradePreCheck**                    |               | YES           | YES        |            |                |               |
 449 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
 450 | **UpgradeSoftware**                    |               | YES           | YES        |            |                |               |
 451 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
 452
 453
 454
 455 Create a template from a “golden” configuration file
 456 ----------------------------------------------------
 457
 458 There are several ways to create a template in APPC CDT:
 459
 460 -  Start from golden instance config file; manually add parameters
 461    (described in this section)
 462
 463 -  Start with a template file, manually add more parameters. (described
 464    in section Synchronizing a Template)
 465
 466 -  Start with config file; create updated template by **merging**
 467    name-value pairs. (described in Create a file containing name-value pairs for parameters section)
 468
 469 Start with a working configuration for a “golden instance” of the VNF
 470 (xml if Netconf) or the payload to be downloaded to the Chef or Ansible
 471 server (JSON).
 472
 473 Open the XML or JSON file in Notepad ++ and verify that the format is
 474 schema compliant. If the xml file is for a post-instantiation
 475 configuration, then modify the config to include only statements that
 476 are to be added (merged) with any configuration that is on the VNF
 477 instance after instantiation. For example, remove statements that might
 478 change root passwords, etc.
 479
 480 Optionally, add Velocity statements to the file, if desired, to handle
 481 special constructs such as variable lists, template defined constants,
 482 conditional statements, etc.
 483
 484 Here are links with more information about the Velocity java-based
 485 template engine:
 486
 487     http://velocity.apache.org/engine/2.0/vtl-reference.html
 488
 489     http://velocity.apache.org/engine/2.0/user-guide.html
 490
 491 This screen shows a sample Golden Configuration file that has been
 492 uploaded to APP-C CDT.
 493
 494 |image18|
 495
 496 Next, designate instance-specific values as parameters, using this
 497 procedure:
 498
 499     1) Highlight the instance-specific value (such as “node0 )  with the cursor and then type “CTRL” and “4”
 500
 501     |image19|
 502
 503     2) Type the name you want to use for this parameter into the pop-up window and click SUBMIT
 504
 505     |image20|
 506
 507     3) The system will display your parameter name after the value you highlighted
 508
 509     |image21|
 510
 511     4) Repeat for each instance-specific value that you wish to turn into a parameter.
 512
 513 *Summary of editing commands:*
 514
 515  - CTRL+4 to add a parameter (also saves previous unsaved parameter)
 516  - CTRL+S to save a parameter
 517  - CTRL+Z to undo the last edit
 518
 519 Notes on naming Parameters:
 520
 521 -  Choose meaningful, unique parameter names for each parameter. If the
 522    same parameter value appears in multiple places in the config, the
 523    parameter name which is assigned to the first instance will be
 524    automatically assigned to all instances. However, you may choose a
 525    different parameter name for each instance of the parameter value
 526    (except when using the MERGE function).
 527
 528 -  Use only dash (-) or underline (\_) as separators between words in
 529    the name.
 530
 531 -  The name should not contain spaces or any other special characters.
 532
 533 -  Do not use parameter names which are sub-strings of other parameter
 534    names. For example, don’t use field1 and field12 as parameter names.
 535
 536 In the template, the first instance of a parameter will be highlighted in green and subsequent instances of the same parameter will be highlighted in orange.
 537
 538 Synchronizing a Template
 539 ~~~~~~~~~~~~~~~~~~~~~~~~
 540
 541 Once you have named all the parameters (this example shows 3
 542 parameters), click the “SYNCHRONIZE TEMPLATE PARAMETERS”  button to automatically create a
 543 parameter definition file and a parameter name-value file. The next
 544 sections describe these files.
 545
 546 It may take a few seconds for the system to synchronize; when it is
 547 complete, you will be taken to the Parameter Definition screen.
 548
 549 Remember to use the SAVE and/or DOWNLOAD buttons on the Reference Data
 550 screen to preserve your work.
 551
 552 |image23|
 553
 554 Modifying an Existing Template
 555 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 556
 557 In addition to creating new templates, you can also modify an existing
 558 template by adding or removing parameter names.
 559
 560 To add a new parameter name, follow the steps in the Create a template from a "golden" configuration file section above.
 561 SYNCHRONIZE TEMPLATE PARAMETERS  to add the new parameter to the name/value and parameter
 562 definition GUI.
 563
 564 To remove an existing parameter name, remove the parameter name (i.e.,
 565 ${name}) using the backspace key and replace with the static value. Then
 566 SYNCHRONIZE TEMPLATE PARAMETERS  to remove the parameter from the name/value and parameter
 567 definition GUI.
 568
 569 If the available template has parameter names (as opposed to the golden configuration/ base config typically shared by VNF owners), you can upload that template and manually add the braces around the parameter names.  Then click on SYNCHRONIZE TEMPLATE PARAMETERS to generate the PD file with source as Manual.
 570
 571 Remember to use the SAVE and/or DOWNLOAD buttons on the Reference Data
 572 screen to preserve your work.
 573
 574 Create a parameter definition file describing instance-specific parameters in the template
 575 ------------------------------------------------------------------------------------------
 576
 577 Clicking the “SYNCHRONIZE TEMPLATE PARAMETERS” button after creating a template will automatically create/update a parameter definition file for
 578 that template (and a parameter name-value file described in the next
 579 section). Alternatively, you can upload an existing parameter definition
 580 file from your PC.
 581
 582 You can view or edit the definition fields for each parameter via the
 583 Parameter Definition screen. Note that any edits to the parameter names
 584 would be overwritten by a subsequent SYNCHRONIZE TEMPLATE PARAMETERS.
 585
 586 |image24|
 587
 588 Select a Source for each parameter
 589 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 590
 591 There are three choices for the source:
 592
 593 1. **External Systems**. APPC will automatically obtain parameter values from
 594    an external system (typically IP addresses for VNF’s). First, obtain a
 595    “key file” for your VNF. Then use the
 596    “Upload Key File” button on the Parameter Definition screen. APPC
 597    will automatically populate key names and values used to retrieve data
 598    from an external system.
 599
 600
 601 2. **A&AI**. APPC will automatically obtain parameter values from
 602    A&AI (typically VNF/VNFC/VM identifiers). After selecting “A&AI”,
 603    select a rule type and APPC will automatically populate the key
 604    names and values. For rule types that include a list, populate the
 605    ‘Filter By Field’ and ‘Filter By Value’.
 606
 607     |image26|
 608
 609 3. **Manual**. APPC will use a manually-created excel to populate
 610    parameter values. Later section describes this User Input Spreadsheet.
 611
 612 Remember to use the SAVE and/or DOWNLOAD buttons on the Reference Data
 613 screen to preserve your work.
 614
 615 Create a file containing name-value pairs for parameters
 616 --------------------------------------------------------
 617
 618 Clicking the “SYNCHRONIZE TEMPLATE PARAMETERS” button after creating a template (see section
 619 Synchronizing a Template) will automatically create/update a parameter name-value pair file
 620 for that template (and a parameter definition file described in the
 621 previous section).
 622
 623 Navigate to the Template tab and “Param Values” subtab to view/edit
 624 parameter name-value pairs.
 625
 626 If you make any edits, remember to use the SAVE and/or DOWNLOAD buttons
 627 on the Reference Data screen to preserve your work.
 628
 629 |image27|
 630
 631 Option: Using MERGE to automatically create a template from a parameter name-value pair file
 632 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 633
 634 APPC CDT also provides a way to create a template from an
 635 existing parameter name-value pair file. This is useful when the
 636 configuration of the VNF has changed. Rather than manually recreating
 637 the template, you can use the MERGE function to automatically add
 638 parameter names based on a valid name-value pairs file from a previous
 639 template.
 640
 641 First, navigate to the Template tab and “Param Values” subtab and click
 642 on UPLOAD PARAM FILE
 643
 644 |image28|
 645
 646 Then navigate to the Template configuration screen. Upload a
 647 configuration file that contains values you wish to turn into
 648 parameters.
 649
 650 |image29|
 651
 652 Next, click “MERGE FROM PARAM”. APPC will automatically associate the parameter values in the uploaded configuration with parameter names from the parameter name/value. If duplicate parameter values are found in the configuration, APP-C will highlight the duplicate value & name in orange and let the user edit the parameter name.  When the duplicate parameter name has been successfully replaced with a unique name, the highlight will change from orange to green..
 653
 654 After using the MERGE FROM PARAM button to create a template, you can use the
 655 SYNCHRONIZE TEMPLATE PARAMETERS button to create/update the parameter definition file and
 656 name-value files.
 657
 658 Remember to use the SAVE and/or DOWNLOAD buttons on the Reference Data
 659 screen to preserve your work.
 660
 661 |image30|
 662
 663
 664 Option: Synchronize with Name/Values
 665 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 666 There may be a scenario where you have created or uploaded a template, and SYNCHONIZED TEMPLATE PARAMETERS, and then you want to remove some name-value pairs. APPC provides a SYNCHRONIZE WITH NAME VALUES button that will automatically synchronize the parameter definitions with your updated name value pairs.
 667
 668
 669   - Step 1: Create or upload template
 670
 671   - Step 2: SYNCHRONIZE TEMPLATE PARAMETERS. (APPC will update Parameter Definition file and Name-Value Pair file to match Template.)
 672
 673   - Step 3: Manually edit Name-Value Pair file (or upload a changed Name-Value Pair file)
 674
 675   - Step 4: SYNCHRONIZE WITH NAME VALUES. (see screen shot below)(APPC will update Parameter Definition file to match Name-Value Pair file.)
 676
 677   - Step 5: Examine Parameter Definitions to confirm they now match updated Name-Value Pair file.
 678
 679
 680 |image30a|
 681
 682
 683 Test the template in a lab using APPC CDT Test Function
 684 =======================================================
 685
 686 The APPC CDT **TEST** action is used to initiate configuration
 687 and other lifecycle commands
 688
 689 **Prerequisites:**
 690    - A. Testing requires an instance of the target VNF to be reachable from your test environment.
 691    - B. You have created the on-boarding artifacts (e.g., reference file, template, etc) for the target VNF type and action in CDT and saved  them to APPC.
 692    - C. You have created a user input spreadsheet for the VNF and action you wish to test.
 693
 694 **Steps to Test a template:**
 695    - 1. Choose the TEST function on the APPC CDT home page
 696    - 2. Upload the user input spreadsheet
 697    - 3. Click on EXECUTE TEST
 698    - 4. View test progress; poll for test status if necessary.
 699    - 5. View Test Results
 700
 701
 702 User Input Spreadsheet
 703 ----------------------
 704
 705 The following steps are used to prepare a user input spreadsheet for the
 706 VNF instance and action to be tested.
 707
 708 1. Start with this generic user input excel spreadsheet.
 709
 710     :download:`Generic 1802 User Input Spreadsheet v.02.xlsx` (compatible with excel 2013)
 711
 712     Update the user-input sections of the spreadsheet.
 713
 714      - a) Upload Data tab: choose action, populate VNF-ID
 715
 716      - b) >Action< tab: Select the tab for the action being tested. Choose a protocol and enter required action identifiers & request parameter values. Enter any payload parameter names and values required for this associated template. (copy/paste from a name-value pair file or other source).
 717
 718     The screen shots on the following pages show the user input sections highlighted in yellow.
 719
 720 2. Save the spreadsheet with a name for your VNF instance and action.
 721
 722 “Upload Data” tab – Select action to be tested and populate any action
 723 identifiers such as vnf-id.
 724
 725 |image31|
 726
 727 Action tab: This example is for the ConfigModify action, so the
 728 “ConfigModify” tab is shown. Choose a protocol and enter required action
 729 identifiers & request parameter values. Enter any payload parameter
 730 names and values required for this associated template. (You may
 731 copy/paste from a name-value pair file or other source).
 732
 733 |image32|
 734
 735 Using APPC CDT TEST Function
 736 ----------------------------
 737
 738 **Steps to use the “TEST” function of the APPC Design Tool**
 739
 740 1. Choose the TEST function on the APPC Design Tool home page
 741
 742    |image33|
 743
 744 2. Upload the user input spreadsheet
 745 3. Click on EXECUTE TEST
 746 4. View test progress; poll for test status if necessary.
 747
 748    |image34|
 749
 750    |image35|
 751
 752 5. View Test Results
 753
 754    |image36|
 755
 756
 757 Note on populating southbound properties:
 758 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 759
 760 When a new vnf-type is created or a new action is added to an existing
 761 vnf-type using the CDT tool and the Reference Data artifact is loaded to
 762 APPC, an update is made to the APPC run-time southbound properties
 763 file for the vnf-type.   The southbound properties are needed for
 764 connecting to a VNF instance or Ansible server.  The southbound
 765 properties contain the following information:
 766
 767 ``{vnf\_type}.{protocol}.{action}.user = {value}``
 768
 769 ``{vnf\_type}.{protocol}.{action}.port = {value}``
 770
 771 ``{vnf\_type}.{protocol}.{action}.password = {value}``
 772
 773 ``{vnf\_type}.{protocol}.{action}.url = {value}``
 774
 775 The user, port, and url values are contained in the Reference Data
 776 artifact, if populated by the self-service user.
 777
 778 The current process that creates the southbound properties from the Reference Data only updates the southbound properties file on a single APPC node in the ODL cluster..
 779
 780
 781 APP-C Design Tool - File Descriptions
 782 =====================================
 783
 784 +--------------------------------------------------------------------------------------------------------------------------------------+-------------------+
 785 | **File Description**                                                                                                                 | **File Format**   |
 786 +======================================================================================================================================+===================+
 787 |                                                                                                                                      |                   |
 788 | **Pre-template Config file** –contains a ‘golden’ or working configuration (for Netconf) or JSON data block (for Chef or Ansible).   | XML, JSON         |
 789 |                                                                                                                                      |                   |
 790 +--------------------------------------------------------------------------------------------------------------------------------------+-------------------+
 791 |                                                                                                                                      |                   |
 792 | **Reference file**  – describes a VNF in terms of its subtending VM’s and VNFC’s and the actions/protocols being onboarded.          | XML, JSON         |
 793 |                                                                                                                                      |                   |
 794 +--------------------------------------------------------------------------------------------------------------------------------------+-------------------+
 795 |                                                                                                                                      |                   |
 796 | **Template file** – a configuration file with parameters for instance-specific fields.                                               | XML               |
 797 |                                                                                                                                      |                   |
 798 +--------------------------------------------------------------------------------------------------------------------------------------+-------------------+
 799 |                                                                                                                                      |                   |
 800 | **Parameter Definition file** (aka pd\_Configure) contains **parameter definitions** associated with a template.                     | YAML              |
 801 |                                                                                                                                      |                   |
 802 +--------------------------------------------------------------------------------------------------------------------------------------+-------------------+
 803 |                                                                                                                                      |                   |
 804 | **Name-Value file** (aka param\_Configure) contains name-value pairs for parameters associated with a template.                      | JSON              |
 805 |                                                                                                                                      |                   |
 806 +--------------------------------------------------------------------------------------------------------------------------------------+-------------------+
 807 |                                                                                                                                      |                   |
 808 | **Key data file** – contains external system data to populate a PD configure file.                                                   | TXT               |
 809 |                                                                                                                                      |                   |
 810 +--------------------------------------------------------------------------------------------------------------------------------------+-------------------+
 811
 812
 813
 814 .. |image0| image:: media/image0.png
 815    :width: 7.88889in
 816    :height: 4.43750in
 817 .. |image1| image:: media/image1.png
 818    :width: 8.72292in
 819    :height: 4.51788in
 820 .. |image2| image:: media/image2.png
 821    :width: 8.75000in
 822    :height: 4.58908in
 823 .. |image3| image:: media/image3.png
 824    :width: 8.70833in
 825    :height: 4.89844in
 826 .. |image4| image:: media/image4.png
 827    :width: 7.46875in
 828    :height: 4.19310in
 829 .. |image5| image:: media/image5.png
 830    :width: 7.23958in
 831    :height: 3.87172in
 832 .. |image6| image:: media/image6.png
 833    :width: 7.58491in
 834    :height: 4.26651in
 835 .. |image7| image:: media/image7.png
 836    :width: 9.43750in
 837    :height: 5.30859in
 838 .. |image8| image:: media/image8.png
 839    :width: 7.86980in
 840    :height: 4.72917in
 841 .. |image9| image:: media/image9.png
 842    :width: 7.56250in
 843    :height: 4.54450in
 844 .. |image10| image:: media/image10.png
 845    :width: 9.01042in
 846    :height: 5.06836in
 847 .. |image11| image:: media/image11.png
 848    :width: 9.44792in
 849    :height: 5.31445in
 850 .. |image12| image:: media/image12.png
 851    :width: 9.48958in
 852    :height: 5.33789in
 853 .. |image13| image:: media/image13.png
 854    :width: 9.48125in
 855    :height: 5.33320in
 856 .. |image14| image:: media/image14.png
 857    :width: 9.25926in
 858    :height: 5.20833in
 859 .. |image15| image:: media/image15.png
 860    :width: 9.05556in
 861    :height: 5.09375in
 862 .. |image15a| image:: media/image15a.png
 863 .. |image15b| image:: media/image15b.png
 864 .. |image15c| image:: media/image15c.png
 865 .. |image15d| image:: media/image15d.png
 866 .. |image15e| image:: media/image15e.png
 867 .. |image15f| image:: media/image15f.png
 868 .. |image16| image:: media/image16.png
 869    :width: 5.79167in
 870    :height: 3.74135in
 871 .. |imageA| image:: media/imageA.png
 872    :width: 5.79167in
 873    :height: 3.74135in
 874 .. |image17| image:: media/image17.png
 875    :width: 6.13542in
 876    :height: 4.97745in
 877 .. |image18| image:: media/image18.png
 878    :width: 9.00000in
 879    :height: 5.27639in
 880 .. |image19| image:: media/image19.png
 881    :width: 5.43423in
 882    :height: 1.83333in
 883 .. |image20| image:: media/image20.png
 884    :width: 5.44473in
 885    :height: 1.93750in
 886 .. |image21| image:: media/image21.png
 887    :width: 5.32292in
 888    :height: 1.92771in
 889 .. |image23| image:: media/image23.png
 890    :width: 7.54167in
 891    :height: 4.24219in
 892 .. |image24| image:: media/image24.png
 893    :width: 7.48148in
 894    :height: 4.20833in
 895 .. |image26| image:: media/image26.png
 896    :width: 6.87789in
 897    :height: 3.78125in
 898 .. |image27| image:: media/image27.png
 899    :width: 7.97170in
 900    :height: 4.48408in
 901 .. |image28| image:: media/image28.png
 902    :width: 8.56604in
 903    :height: 4.81840in
 904 .. |image29| image:: media/image29.png
 905    :width: 9.00943in
 906    :height: 5.06781in
 907 .. |image30| image:: media/image30.png
 908    :width: 8.07407in
 909    :height: 4.54167in
 910 .. |image30a| image:: media/image30a.png
 911 .. |image31| image:: media/image31.png
 912    :width: 9.00000in
 913    :height: 5.18958in
 914 .. |image32| image:: media/image32.png
 915    :width: 9.00000in
 916    :height: 5.18958in
 917 .. |image33| image:: media/image33.png
 918    :width: 9.00000in
 919    :height: 5.18958in
 920 .. |image34| image:: media/image34.png
 921    :width: 9.00000in
 922    :height: 5.18958in
 923 .. |image35| image:: media/image35.png
 924    :width: 9.00000in
 925    :height: 5.18958in
 926 .. |image36| image:: media/image36.png
 927    :width: 9.00000in
 928    :height: 5.18958in
 929
 930