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>:<port>
 202
 203 - Where:
 204         - <server> = The server IP or host where CDT is deployed.
 205         - <port> = By default 8080 for a HEAT deployed CDT or 30289 for an OOM deplyed CDT.
 206
 207 |image4|
 208
 209 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.
 210
 211 |image5|
 212
 213 Choose “My VNF’s”.
 214
 215 If you have not used APPC CDT previously, you will be asked to
 216 enter your user id. Your work will be stored under this user id. There
 217 is no password required at this time.
 218
 219 Note: If multiple self-service users will be working on a set of VNF’s,
 220 it is suggested that you enter a group\_name rather than your user\_id.
 221 This group name would be used by all users in the group so that all
 222 users can view/edit the same set of artifacts.
 223
 224 If you have previously used APPC CDT, you user id will
 225 automatically be selected.
 226
 227 |image6|
 228
 229 The “My VNFs” GUI displays a list of the vnf-type/vnfc-types which are
 230 stored under your userid in the APPC database. You can choose either
 231 “Create New VNF” or “View/Edit” for one of your existing VNF’s.
 232
 233 |image7|
 234
 235 If you have not created any VNF artifacts in the current release of the
 236 APPC CDT, you will see a screen like this; click “Create new
 237 VNF” to begin.
 238
 239 VNF artifacts created using earlier versions of the APPC CDT
 240 can be uploaded and then edited/saved, as shown on later screens. You
 241 should not have to re-create these VNF artifacts.
 242
 243 |image8|
 244
 245 If you choose to create a new VNF, you will see a pop-up box like this.
 246
 247 |image9|
 248
 249 Enter the VNF Type (and optional VNFC Type) and click next. (The optional VNFC check box is explained later)
 250
 251 Alternatively, you can leave the VNF type blank and choose “PROCEED
 252 ANYWAY” if you want to proceed to the Reference Data screen where you
 253 can populate the VNF reference data by uploading an existing Reference
 254 File or by manually entering it.
 255
 256 You must populate the VNF field if uploading the existing file does not
 257 populate it.
 258
 259 Populate reference data describing the VNF and action to be onboarded
 260 ---------------------------------------------------------------------
 261
 262 |image10|
 263
 264 |image11|
 265
 266 |image12|
 267
 268 |image13|
 269
 270 |image14|
 271
 272 Note 1: When downloading your work to APPC; the system will download
 273 only the artifacts that have been updated in the current session. You
 274 may not see all 4 artifacts unless you visit/edit the reference,
 275 template, parameter and parameter definition screens.
 276
 277 Note 2: When downloading files, the system will display a pop-up window
 278 for each file, but the windows are all placed on top of each other. You
 279 can drag the pop-up windows if you want to see them all at the same
 280 time.
 281
 282 |
 283
 284
 285
 286 |
 287
 288 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
 289
 290 |image15a|
 291
 292 Note regarding VNFC Type
 293 ~~~~~~~~~~~~~~~~~~~~~~~~
 294
 295 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.
 296
 297 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.
 298
 299 |image15b|
 300
 301 On the subsequent Reference screen, you must add the VNFC type(s).
 302
 303 |image15c|
 304
 305 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.
 306
 307 |image15d|
 308
 309 Choose the desired VNFC Type from the drop-down list of VNFC types.
 310
 311 |image15e|
 312
 313 In the VNFC section, you must re-enter the VNFC type to match what you previously selected.
 314
 315 |image15f|
 316
 317 Populate OpenStack actions for a VM
 318 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 319
 320 You can also onboard OpenStack commands for the VM level components of
 321 the VNF
 322
 323 Under ‘Action’, select “OpenStack Actions” and then under ‘Protocol’
 324 select “OpenStack”.
 325
 326 You must populate the ‘VNF type’ if it is not already populated.
 327
 328 |image16|
 329
 330 Next, upload an excel file of VM capabilities for your VNF. The excel
 331 must list OpenStack actions in the first column, and then have a column
 332 for each VM type (i.e., VNFC Function Code) showing which actions are
 333 applicable for that VM type, as shown Excel sample below:
 334
 335 |imageA|
 336
 337 APPC will import the data from the excel and display the results.
 338
 339 |image17|
 340
 341 The Template and Parameter Definition tabs do not apply to OpenStack
 342 commands.
 343
 344 **REFERENCE DATA SCREEN HELP**
 345
 346 +--------------------------+------------------------------------------------------------------------------------------------------------------+
 347 | **Field/Object**         | **Description**                                                                                                  |
 348 +==========================+==================================================================================================================+
 349 |                                                     **VNF Reference Data**                                                                  |
 350 +--------------------------+------------------------------------------------------------------------------------------------------------------+
 351 | Action                   | The action to be executed on the VNF, e.g., “CONFIGURE” (see table below).                                       |
 352 +--------------------------+------------------------------------------------------------------------------------------------------------------+
 353 | VNF Type                 | The name of the VNF, e.g. vDBE.                                                                                  |
 354 +--------------------------+------------------------------------------------------------------------------------------------------------------+
 355 | VNFC Type                | NA when describing a VNF; When describing a VNFC, enter the VNFC name e.g.,MSC, SSC, MMC, etc.                   |
 356 +--------------------------+------------------------------------------------------------------------------------------------------------------+
 357 | Device Protocol          | Choose desired protocol e.g., NETCONF-XML (see table below).                                                     |
 358 +--------------------------+------------------------------------------------------------------------------------------------------------------+
 359 | Template                 | Will there be a template created for this VNF and action? Yes/No.                                                |
 360 +--------------------------+------------------------------------------------------------------------------------------------------------------+
 361 | User Name                | Enter the user name used to configure the VNF e.g., “admin” or “root”.                                           |
 362 +--------------------------+------------------------------------------------------------------------------------------------------------------+
 363 | Port Number              | Enter the port number used to configure the VNF, e.g., 22.                                                       |
 364 +--------------------------+------------------------------------------------------------------------------------------------------------------+
 365 | Context URL              | Enter the context portion of the REST URL (Currently used only for the HealthCheck action with REST protocol).   |
 366 +--------------------------+------------------------------------------------------------------------------------------------------------------+
 367 |                                                      **VNFC information**                                                                   |
 368 +--------------------------+------------------------------------------------------------------------------------------------------------------+
 369 | VNFC Type                | Enter the VNFC name e.g. MSC, SSC, MMC, etc.                                                                     |
 370 +--------------------------+------------------------------------------------------------------------------------------------------------------+
 371 | VNFC Function Code       | Enter the standard 3 character value for the VNFC.                                                               |
 372 +--------------------------+------------------------------------------------------------------------------------------------------------------+
 373 | IP Address V4 OAM VIP    | Select Y to store the O&AM VIP address with the VNFC record; otherwise select N.                                 |
 374 +--------------------------+------------------------------------------------------------------------------------------------------------------+
 375 | Group Notation Type      | Select the naming scheme for VNFC/VM instances (first-vnfc-name, fixed value, relative value)                    |
 376 +--------------------------+------------------------------------------------------------------------------------------------------------------+
 377 | Group Notation Value     | For first-vnfc-name type, enter text such as “pair” or “group”.                                                  |
 378 |                          |                                                                                                                  |
 379 |                          | For fixed value type, enter any alpha-numeric text “1”, “test” etc.                                              |
 380 |                          |                                                                                                                  |
 381 |                          | For relative value type, enter a number “1”, “2”, “4”, etc                                                       |
 382 +--------------------------+------------------------------------------------------------------------------------------------------------------+
 383 | Number of VM’s           | Enter the # of VM’s for this VNFC.                                                                               |
 384 +--------------------------+------------------------------------------------------------------------------------------------------------------+
 385
 386 |
 387
 388 This table shows which actions and protocols are currently available for
 389 on-boarding with the Beijing release.
 390
 391 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
 392 |  **Action**                            |**Netconf-XML**| **Ansible**   | **Chef**   | **REST**   | **OpenStack**  |**Protocol is**|
 393 |                                        |**Restconf**   |               |            |            | **(VM Level)** |**Not**        |
 394 |                                        |               |               |            |            |                |**Applicable** |
 395 +========================================+===============+===============+============+============+================+===============+
 396 | **ActionStatus**                       |               |               |            |            |                |     NA        |
 397 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
 398 | **AttachVolume**                       |               |               |            |            | YES            |               |
 399 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
 400 | **Audit**                              | YES           | YES           | YES        | YES        |                |               |
 401 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
 402 | **CheckLock**                          |               |               |            |            |                |     NA        |
 403 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
 404 | **Configure**                          | YES           | YES           | YES        |            |                |               |
 405 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
 406 | **Config Modify**                      | YES           | YES           | YES        |            |                |               |
 407 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
 408 | **Config Backup**                      |               | YES           | YES        |            |                |               |
 409 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
 410 | **Config Restore**                     |               | YES           | YES        |            |                |               |
 411 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
 412 | **ConfigScaleOut**                     | YES           | YES           | YES        |            |                |               |
 413 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
 414 | **DetachVolume**                       |               |               |            |            | YES            |               |
 415 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
 416 | **DistributeTraffic**                  |               | YES           | YES        |            |                |               |
 417 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
 418 | **Evacuate**                           |               |               |            |            | YES            |               |
 419 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
 420 | **HealthCheck**                        |               | YES           | YES        | YES        |                |               |
 421 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
 422 | **Lock**                               |               |               |            |            |                |      NA       |
 423 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
 424 | **Migrate**                            |               |               |            |            | YES            |               |
 425 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
 426 | **QuiesceTraffic**                     |               | YES           | YES        |            |                |               |
 427 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
 428 | **Rebuild**                            |               |               |            |            | YES            |               |
 429 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
 430 | **Restart**                            |               |               |            |            | YES            |               |
 431 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
 432 | **ResumeTraffic**                      |               | YES           | YES        |            |                |               |
 433 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
 434 | **Snapshot**                           |               |               |            |            | YES            |               |
 435 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
 436 | **Start**                              |               |               |            |            | YES            |               |
 437 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
 438 | **Start Application**                  |               | YES           | YES        |            |                |               |
 439 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
 440 | **Stop**                               |               |               |            |            | YES            |               |
 441 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
 442 | **Stop Application**                   |               | YES           | YES        |            |                |               |
 443 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
 444 | **Sync**                               | YES           | YES           | YES        |  YES       |                |               |
 445 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
 446 | **Unlock**                             |               |               |            |            |                |       NA      |
 447 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
 448 | **UpgradeBackout**                     |               | YES           | YES        |            |                |               |
 449 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
 450 | **UpgradeBackup**                      |               | YES           | YES        |            |                |               |
 451 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
 452 | **UpgradePostCheck**                   |               | YES           | YES        |            |                |               |
 453 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
 454 | **UpgradePreCheck**                    |               | YES           | YES        |            |                |               |
 455 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
 456 | **UpgradeSoftware**                    |               | YES           | YES        |            |                |               |
 457 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
 458
 459
 460
 461 Create a template from a “golden” configuration file
 462 ----------------------------------------------------
 463
 464 There are several ways to create a template in APPC CDT:
 465
 466 -  Start from golden instance config file; manually add parameters
 467    (described in this section)
 468
 469 -  Start with a template file, manually add more parameters. (described
 470    in section Synchronizing a Template)
 471
 472 -  Start with config file; create updated template by **merging**
 473    name-value pairs. (described in Create a file containing name-value pairs for parameters section)
 474
 475 Start with a working configuration for a “golden instance” of the VNF
 476 (xml if Netconf) or the payload to be downloaded to the Chef or Ansible
 477 server (JSON).
 478
 479 Open the XML or JSON file in Notepad ++ and verify that the format is
 480 schema compliant. If the xml file is for a post-instantiation
 481 configuration, then modify the config to include only statements that
 482 are to be added (merged) with any configuration that is on the VNF
 483 instance after instantiation. For example, remove statements that might
 484 change root passwords, etc.
 485
 486 Optionally, add Velocity statements to the file, if desired, to handle
 487 special constructs such as variable lists, template defined constants,
 488 conditional statements, etc.
 489
 490 Here are links with more information about the Velocity java-based
 491 template engine:
 492
 493     http://velocity.apache.org/engine/2.0/vtl-reference.html
 494
 495     http://velocity.apache.org/engine/2.0/user-guide.html
 496
 497 This screen shows a sample Golden Configuration file that has been
 498 uploaded to APP-C CDT.
 499
 500 |image18|
 501
 502 Next, designate instance-specific values as parameters, using this
 503 procedure:
 504
 505     1) Highlight the instance-specific value (such as “node0 )  with the cursor and then type “CTRL” and “4”
 506
 507     |image19|
 508
 509     2) Type the name you want to use for this parameter into the pop-up window and click SUBMIT
 510
 511     |image20|
 512
 513     3) The system will display your parameter name after the value you highlighted
 514
 515     |image21|
 516
 517     4) Repeat for each instance-specific value that you wish to turn into a parameter.
 518
 519 *Summary of editing commands:*
 520
 521  - CTRL+4 to add a parameter (also saves previous unsaved parameter)
 522  - CTRL+S to save a parameter
 523  - CTRL+Z to undo the last edit
 524
 525 Notes on naming Parameters:
 526
 527 -  Choose meaningful, unique parameter names for each parameter. If the
 528    same parameter value appears in multiple places in the config, the
 529    parameter name which is assigned to the first instance will be
 530    automatically assigned to all instances. However, you may choose a
 531    different parameter name for each instance of the parameter value
 532    (except when using the MERGE function).
 533
 534 -  Use only dash (-) or underline (\_) as separators between words in
 535    the name.
 536
 537 -  The name should not contain spaces or any other special characters.
 538
 539 -  Do not use parameter names which are sub-strings of other parameter
 540    names. For example, don’t use field1 and field12 as parameter names.
 541
 542 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.
 543
 544 Synchronizing a Template
 545 ~~~~~~~~~~~~~~~~~~~~~~~~
 546
 547 Once you have named all the parameters (this example shows 3
 548 parameters), click the “SYNCHRONIZE TEMPLATE PARAMETERS”  button to automatically create a
 549 parameter definition file and a parameter name-value file. The next
 550 sections describe these files.
 551
 552 It may take a few seconds for the system to synchronize; when it is
 553 complete, you will be taken to the Parameter Definition screen.
 554
 555 Remember to use the SAVE and/or DOWNLOAD buttons on the Reference Data
 556 screen to preserve your work.
 557
 558 |image23|
 559
 560 Modifying an Existing Template
 561 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 562
 563 In addition to creating new templates, you can also modify an existing
 564 template by adding or removing parameter names.
 565
 566 To add a new parameter name, follow the steps in the Create a template from a "golden" configuration file section above.
 567 SYNCHRONIZE TEMPLATE PARAMETERS  to add the new parameter to the name/value and parameter
 568 definition GUI.
 569
 570 To remove an existing parameter name, remove the parameter name (i.e.,
 571 ${name}) using the backspace key and replace with the static value. Then
 572 SYNCHRONIZE TEMPLATE PARAMETERS  to remove the parameter from the name/value and parameter
 573 definition GUI.
 574
 575 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.
 576
 577 Remember to use the SAVE and/or DOWNLOAD buttons on the Reference Data
 578 screen to preserve your work.
 579
 580 Create a parameter definition file describing instance-specific parameters in the template
 581 ------------------------------------------------------------------------------------------
 582
 583 Clicking the “SYNCHRONIZE TEMPLATE PARAMETERS” button after creating a template will automatically create/update a parameter definition file for
 584 that template (and a parameter name-value file described in the next
 585 section). Alternatively, you can upload an existing parameter definition
 586 file from your PC.
 587
 588 You can view or edit the definition fields for each parameter via the
 589 Parameter Definition screen. Note that any edits to the parameter names
 590 would be overwritten by a subsequent SYNCHRONIZE TEMPLATE PARAMETERS.
 591
 592 |image24|
 593
 594 Select a Source for each parameter
 595 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 596
 597 There are three choices for the source:
 598
 599 1. **External Systems**. APPC will automatically obtain parameter values from
 600    an external system (typically IP addresses for VNF’s). First, obtain a
 601    “key file” for your VNF. Then use the
 602    “Upload Key File” button on the Parameter Definition screen. APPC
 603    will automatically populate key names and values used to retrieve data
 604    from an external system.
 605
 606
 607 2. **A&AI**. APPC will automatically obtain parameter values from
 608    A&AI (typically VNF/VNFC/VM identifiers). After selecting “A&AI”,
 609    select a rule type and APPC will automatically populate the key
 610    names and values. For rule types that include a list, populate the
 611    ‘Filter By Field’ and ‘Filter By Value’.
 612
 613     |image26|
 614
 615 3. **Manual**. APPC will use a manually-created excel to populate
 616    parameter values. Later section describes this User Input Spreadsheet.
 617
 618 Remember to use the SAVE and/or DOWNLOAD buttons on the Reference Data
 619 screen to preserve your work.
 620
 621 Create a file containing name-value pairs for parameters
 622 --------------------------------------------------------
 623
 624 Clicking the “SYNCHRONIZE TEMPLATE PARAMETERS” button after creating a template (see section
 625 Synchronizing a Template) will automatically create/update a parameter name-value pair file
 626 for that template (and a parameter definition file described in the
 627 previous section).
 628
 629 Navigate to the Template tab and “Param Values” subtab to view/edit
 630 parameter name-value pairs.
 631
 632 If you make any edits, remember to use the SAVE and/or DOWNLOAD buttons
 633 on the Reference Data screen to preserve your work.
 634
 635 |image27|
 636
 637 Option: Using MERGE to automatically create a template from a parameter name-value pair file
 638 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 639
 640 APPC CDT also provides a way to create a template from an
 641 existing parameter name-value pair file. This is useful when the
 642 configuration of the VNF has changed. Rather than manually recreating
 643 the template, you can use the MERGE function to automatically add
 644 parameter names based on a valid name-value pairs file from a previous
 645 template.
 646
 647 First, navigate to the Template tab and “Param Values” subtab and click
 648 on UPLOAD PARAM FILE
 649
 650 |image28|
 651
 652 Then navigate to the Template configuration screen. Upload a
 653 configuration file that contains values you wish to turn into
 654 parameters.
 655
 656 |image29|
 657
 658 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..
 659
 660 After using the MERGE FROM PARAM button to create a template, you can use the
 661 SYNCHRONIZE TEMPLATE PARAMETERS button to create/update the parameter definition file and
 662 name-value files.
 663
 664 Remember to use the SAVE and/or DOWNLOAD buttons on the Reference Data
 665 screen to preserve your work.
 666
 667 |image30|
 668
 669
 670 Option: Synchronize with Name/Values
 671 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 672 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.
 673
 674
 675   - Step 1: Create or upload template
 676
 677   - Step 2: SYNCHRONIZE TEMPLATE PARAMETERS. (APPC will update Parameter Definition file and Name-Value Pair file to match Template.)
 678
 679   - Step 3: Manually edit Name-Value Pair file (or upload a changed Name-Value Pair file)
 680
 681   - Step 4: SYNCHRONIZE WITH NAME VALUES. (see screen shot below)(APPC will update Parameter Definition file to match Name-Value Pair file.)
 682
 683   - Step 5: Examine Parameter Definitions to confirm they now match updated Name-Value Pair file.
 684
 685
 686 |image30a|
 687
 688
 689 Test the template in a lab using APPC CDT Test Function
 690 =======================================================
 691
 692 The APPC CDT **TEST** action is used to initiate configuration
 693 and other lifecycle commands
 694
 695 **Prerequisites:**
 696    - A. Testing requires an instance of the target VNF to be reachable from your test environment.
 697    - 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.
 698    - C. You have created a user input spreadsheet for the VNF and action you wish to test.
 699
 700 **Steps to Test a template:**
 701    - 1. Choose the TEST function on the APPC CDT home page
 702    - 2. Upload the user input spreadsheet
 703    - 3. Click on EXECUTE TEST
 704    - 4. View test progress; poll for test status if necessary.
 705    - 5. View Test Results
 706
 707
 708 User Input Spreadsheet
 709 ----------------------
 710
 711 The following steps are used to prepare a user input spreadsheet for the
 712 VNF instance and action to be tested.
 713
 714 1. Start with this generic user input excel spreadsheet.
 715
 716     :download:`Generic 1802 User Input Spreadsheet v.02.xlsx` (compatible with excel 2013)
 717
 718     Update the user-input sections of the spreadsheet.
 719
 720      - a) Upload Data tab: choose action, populate VNF-ID
 721
 722      - 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).
 723
 724     The screen shots on the following pages show the user input sections highlighted in yellow.
 725
 726 2. Save the spreadsheet with a name for your VNF instance and action.
 727
 728 “Upload Data” tab – Select action to be tested and populate any action
 729 identifiers such as vnf-id.
 730
 731 |image31|
 732
 733 Action tab: This example is for the ConfigModify action, so the
 734 “ConfigModify” tab is shown. Choose a protocol and enter required action
 735 identifiers & request parameter values. Enter any payload parameter
 736 names and values required for this associated template. (You may
 737 copy/paste from a name-value pair file or other source).
 738
 739 |image32|
 740
 741 Using APPC CDT TEST Function
 742 ----------------------------
 743
 744 **Steps to use the “TEST” function of the APPC Design Tool**
 745
 746 1. Choose the TEST function on the APPC Design Tool home page
 747
 748    |image33|
 749
 750 2. Upload the user input spreadsheet
 751 3. Click on EXECUTE TEST
 752 4. View test progress; poll for test status if necessary.
 753
 754    |image34|
 755
 756    |image35|
 757
 758 5. View Test Results
 759
 760    |image36|
 761
 762
 763 Note on populating southbound properties:
 764 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 765
 766 When a new vnf-type is created or a new action is added to an existing
 767 vnf-type using the CDT tool and the Reference Data artifact is loaded to
 768 APPC, an update is made to the APPC run-time southbound properties
 769 file for the vnf-type.   The southbound properties are needed for
 770 connecting to a VNF instance or Ansible server.  The southbound
 771 properties contain the following information:
 772
 773 ``{vnf\_type}.{protocol}.{action}.user = {value}``
 774
 775 ``{vnf\_type}.{protocol}.{action}.port = {value}``
 776
 777 ``{vnf\_type}.{protocol}.{action}.password = {value}``
 778
 779 ``{vnf\_type}.{protocol}.{action}.url = {value}``
 780
 781 The user, port, and url values are contained in the Reference Data
 782 artifact, if populated by the self-service user.
 783
 784 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..
 785
 786
 787 APP-C Design Tool - File Descriptions
 788 =====================================
 789
 790 +--------------------------------------------------------------------------------------------------------------------------------------+-------------------+
 791 | **File Description**                                                                                                                 | **File Format**   |
 792 +======================================================================================================================================+===================+
 793 |                                                                                                                                      |                   |
 794 | **Pre-template Config file** –contains a ‘golden’ or working configuration (for Netconf) or JSON data block (for Chef or Ansible).   | XML, JSON         |
 795 |                                                                                                                                      |                   |
 796 +--------------------------------------------------------------------------------------------------------------------------------------+-------------------+
 797 |                                                                                                                                      |                   |
 798 | **Reference file**  – describes a VNF in terms of its subtending VM’s and VNFC’s and the actions/protocols being onboarded.          | XML, JSON         |
 799 |                                                                                                                                      |                   |
 800 +--------------------------------------------------------------------------------------------------------------------------------------+-------------------+
 801 |                                                                                                                                      |                   |
 802 | **Template file** – a configuration file with parameters for instance-specific fields.                                               | XML               |
 803 |                                                                                                                                      |                   |
 804 +--------------------------------------------------------------------------------------------------------------------------------------+-------------------+
 805 |                                                                                                                                      |                   |
 806 | **Parameter Definition file** (aka pd\_Configure) contains **parameter definitions** associated with a template.                     | YAML              |
 807 |                                                                                                                                      |                   |
 808 +--------------------------------------------------------------------------------------------------------------------------------------+-------------------+
 809 |                                                                                                                                      |                   |
 810 | **Name-Value file** (aka param\_Configure) contains name-value pairs for parameters associated with a template.                      | JSON              |
 811 |                                                                                                                                      |                   |
 812 +--------------------------------------------------------------------------------------------------------------------------------------+-------------------+
 813 |                                                                                                                                      |                   |
 814 | **Key data file** – contains external system data to populate a PD configure file.                                                   | TXT               |
 815 |                                                                                                                                      |                   |
 816 +--------------------------------------------------------------------------------------------------------------------------------------+-------------------+
 817
 818
 819
 820 .. |image0| image:: media/image0.png
 821    :width: 7.88889in
 822    :height: 4.43750in
 823 .. |image1| image:: media/image1.png
 824    :width: 8.72292in
 825    :height: 4.51788in
 826 .. |image2| image:: media/image2.png
 827    :width: 8.75000in
 828    :height: 4.58908in
 829 .. |image3| image:: media/image3.png
 830    :width: 8.70833in
 831    :height: 4.89844in
 832 .. |image4| image:: media/image4.png
 833    :width: 7.46875in
 834    :height: 4.19310in
 835 .. |image5| image:: media/image5.png
 836    :width: 7.23958in
 837    :height: 3.87172in
 838 .. |image6| image:: media/image6.png
 839    :width: 7.58491in
 840    :height: 4.26651in
 841 .. |image7| image:: media/image7.png
 842    :width: 9.43750in
 843    :height: 5.30859in
 844 .. |image8| image:: media/image8.png
 845    :width: 7.86980in
 846    :height: 4.72917in
 847 .. |image9| image:: media/image9.png
 848    :width: 7.56250in
 849    :height: 4.54450in
 850 .. |image10| image:: media/image10.png
 851    :width: 9.01042in
 852    :height: 5.06836in
 853 .. |image11| image:: media/image11.png
 854    :width: 9.44792in
 855    :height: 5.31445in
 856 .. |image12| image:: media/image12.png
 857    :width: 9.48958in
 858    :height: 5.33789in
 859 .. |image13| image:: media/image13.png
 860    :width: 9.48125in
 861    :height: 5.33320in
 862 .. |image14| image:: media/image14.png
 863    :width: 9.25926in
 864    :height: 5.20833in
 865 .. |image15| image:: media/image15.png
 866    :width: 9.05556in
 867    :height: 5.09375in
 868 .. |image15a| image:: media/image15a.png
 869 .. |image15b| image:: media/image15b.png
 870 .. |image15c| image:: media/image15c.png
 871 .. |image15d| image:: media/image15d.png
 872 .. |image15e| image:: media/image15e.png
 873 .. |image15f| image:: media/image15f.png
 874 .. |image16| image:: media/image16.png
 875    :width: 5.79167in
 876    :height: 3.74135in
 877 .. |imageA| image:: media/imageA.png
 878    :width: 5.79167in
 879    :height: 3.74135in
 880 .. |image17| image:: media/image17.png
 881    :width: 6.13542in
 882    :height: 4.97745in
 883 .. |image18| image:: media/image18.png
 884    :width: 9.00000in
 885    :height: 5.27639in
 886 .. |image19| image:: media/image19.png
 887    :width: 5.43423in
 888    :height: 1.83333in
 889 .. |image20| image:: media/image20.png
 890    :width: 5.44473in
 891    :height: 1.93750in
 892 .. |image21| image:: media/image21.png
 893    :width: 5.32292in
 894    :height: 1.92771in
 895 .. |image23| image:: media/image23.png
 896    :width: 7.54167in
 897    :height: 4.24219in
 898 .. |image24| image:: media/image24.png
 899    :width: 7.48148in
 900    :height: 4.20833in
 901 .. |image26| image:: media/image26.png
 902    :width: 6.87789in
 903    :height: 3.78125in
 904 .. |image27| image:: media/image27.png
 905    :width: 7.97170in
 906    :height: 4.48408in
 907 .. |image28| image:: media/image28.png
 908    :width: 8.56604in
 909    :height: 4.81840in
 910 .. |image29| image:: media/image29.png
 911    :width: 9.00943in
 912    :height: 5.06781in
 913 .. |image30| image:: media/image30.png
 914    :width: 8.07407in
 915    :height: 4.54167in
 916 .. |image30a| image:: media/image30a.png
 917 .. |image31| image:: media/image31.png
 918    :width: 9.00000in
 919    :height: 5.18958in
 920 .. |image32| image:: media/image32.png
 921    :width: 9.00000in
 922    :height: 5.18958in
 923 .. |image33| image:: media/image33.png
 924    :width: 9.00000in
 925    :height: 5.18958in
 926 .. |image34| image:: media/image34.png
 927    :width: 9.00000in
 928    :height: 5.18958in
 929 .. |image35| image:: media/image35.png
 930    :width: 9.00000in
 931    :height: 5.18958in
 932 .. |image36| image:: media/image36.png
 933    :width: 9.00000in
 934    :height: 5.18958in
 935
 936