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
9 .. https://creativecommons.org/licenses/by/4.0/
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============================================
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.
32 A complete list of all APPC supported commands is contained in the
33 APPC LCM API Guide available on onap.readthedocs.io.
35 Overview of APPC Support for VNF Configuration and Lifecycle Commands
36 ======================================================================
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
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.
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.
56 At run time, the instance specific parameter values are populated in the
57 template to replace the parameter name.
65 Overview of the Onboarding Process
66 ==================================
68 Pre-Requisites for Onboarding:
69 ------------------------------
71 - The VNF must support the below listed device protocols along with OpenStack for VM-level commands:
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.
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:
85 https://wiki.onap.org/pages/viewpage.action?pageId=1015852&preview=/1015849/1017888/VNF%20Management%20Requirements%20for%20OpenECOMP.pdf
87 - The VNF related key identifiers (vnf-type, vnfc-type,
88 vnfc-function-code) that will be stored in A&AI have been defined.
90 Onboarding Process Steps:
91 -------------------------
93 1. Use the APPC CDT GUI to populate **reference data**
94 describing the VNF and action to be onboarded.
96 - Select the VNF, action, and protocol to be on-boarded.
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
102 2. Create a **template** from a “golden” configuration file.
104 - Upload a “golden configuration” file (described later) into the APPC CDT GUI.
106 - Manually edit the configuration file to associate parameter names
107 with instance-specific values you wish to parameterize (e.g., IP addresses).
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.
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.
119 3. Create a **parameter definition** file describing instance-specific
120 parameters in the template.
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.
126 - You can then populate/update the fields describing each parameter.
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.
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.
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.
139 4. Create a **parameter name-value pair file** for those parameters.
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.
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.
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.
152 5. **Test** the template in your test environment using the **TEST** function of APPC CDT
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.
157 - Prepare a “user input” excel file on your PC and upload it to the APPC CDT.
159 - **Execute** the onboarded action on the VNF. View test progress and test results. .
161 The screen shots in following sections illustrate how to use the APPC CDT GUI for each step.
163 Artifacts used for Onboarding:
164 ------------------------------
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.
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:
173 2. Parameter definition file (pd\_configure)
174 3. Parameter name-value pair file (param\_configure)
176 For example, onboarding the “vABC” VNF for 2 actions (Configure and
177 ConfigModify) may result in these 7 files:
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
187 A **Template** is required for the Ansible, Chef and Netconf protocols.
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.
193 OpenStack and REST protocols do not use a template or parameter
194 definitions or name-value pairs.
196 Using the APPC Controller Design Tool for VNF Onboarding
197 ========================================================
199 Go to the APPC CDT GUI in the test environment using a Firefox browser.
201 http://<server>:<port>
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.
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.
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.
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.
224 If you have previously used APPC CDT, you user id will
225 automatically be selected.
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.
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
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.
245 If you choose to create a new VNF, you will see a pop-up box like this.
249 Enter the VNF Type (and optional VNFC Type) and click next. (The optional VNFC check box is explained later)
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.
256 You must populate the VNF field if uploading the existing file does not
259 Populate reference data describing the VNF and action to be onboarded
260 ---------------------------------------------------------------------
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.
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
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
292 Note regarding VNFC Type
293 ~~~~~~~~~~~~~~~~~~~~~~~~
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.
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.
301 On the subsequent Reference screen, you must add the VNFC type(s).
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.
309 Choose the desired VNFC Type from the drop-down list of VNFC types.
313 In the VNFC section, you must re-enter the VNFC type to match what you previously selected.
317 Populate OpenStack actions for a VM
318 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
320 You can also onboard OpenStack commands for the VM level components of
323 Under ‘Action’, select “OpenStack Actions” and then under ‘Protocol’
326 You must populate the ‘VNF type’ if it is not already populated.
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:
337 APPC will import the data from the excel and display the results.
341 The Template and Parameter Definition tabs do not apply to OpenStack
344 **REFERENCE DATA SCREEN HELP**
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”. |
379 | | For fixed value type, enter any alpha-numeric text “1”, “test” etc. |
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 +--------------------------+------------------------------------------------------------------------------------------------------------------+
388 This table shows which actions and protocols are currently available for
389 on-boarding with the Beijing release.
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 | **Evacuate** | | | | | YES | |
417 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
418 | **HealthCheck** | | YES | YES | YES | | |
419 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
420 | **Lock** | | | | | | NA |
421 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
422 | **Migrate** | | | | | YES | |
423 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
424 | **QuiesceTraffic** | | YES | YES | | | |
425 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
426 | **Rebuild** | | | | | YES | |
427 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
428 | **Restart** | | | | | YES | |
429 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
430 | **ResumeTraffic** | | YES | YES | | | |
431 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
432 | **Snapshot** | | | | | YES | |
433 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
434 | **Start** | | | | | YES | |
435 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
436 | **Start Application** | | YES | YES | | | |
437 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
438 | **Stop** | | | | | YES | |
439 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
440 | **Stop Application** | | YES | YES | | | |
441 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
442 | **Sync** | YES | YES | YES | YES | | |
443 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
444 | **Unlock** | | | | | | NA |
445 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
446 | **UpgradeBackout** | | YES | YES | | | |
447 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
448 | **UpgradeBackup** | | YES | YES | | | |
449 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
450 | **UpgradePostCheck** | | YES | YES | | | |
451 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
452 | **UpgradePreCheck** | | YES | YES | | | |
453 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
454 | **UpgradeSoftware** | | YES | YES | | | |
455 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
459 Create a template from a “golden” configuration file
460 ----------------------------------------------------
462 There are several ways to create a template in APPC CDT:
464 - Start from golden instance config file; manually add parameters
465 (described in this section)
467 - Start with a template file, manually add more parameters. (described
468 in section Synchronizing a Template)
470 - Start with config file; create updated template by **merging**
471 name-value pairs. (described in Create a file containing name-value pairs for parameters section)
473 Start with a working configuration for a “golden instance” of the VNF
474 (xml if Netconf) or the payload to be downloaded to the Chef or Ansible
477 Open the XML or JSON file in Notepad ++ and verify that the format is
478 schema compliant. If the xml file is for a post-instantiation
479 configuration, then modify the config to include only statements that
480 are to be added (merged) with any configuration that is on the VNF
481 instance after instantiation. For example, remove statements that might
482 change root passwords, etc.
484 Optionally, add Velocity statements to the file, if desired, to handle
485 special constructs such as variable lists, template defined constants,
486 conditional statements, etc.
488 Here are links with more information about the Velocity java-based
491 http://velocity.apache.org/engine/2.0/vtl-reference.html
493 http://velocity.apache.org/engine/2.0/user-guide.html
495 This screen shows a sample Golden Configuration file that has been
496 uploaded to APP-C CDT.
500 Next, designate instance-specific values as parameters, using this
503 1) Highlight the instance-specific value (such as “node0 ) with the cursor and then type “CTRL” and “4”
507 2) Type the name you want to use for this parameter into the pop-up window and click SUBMIT
511 3) The system will display your parameter name after the value you highlighted
515 4) Repeat for each instance-specific value that you wish to turn into a parameter.
517 *Summary of editing commands:*
519 - CTRL+4 to add a parameter (also saves previous unsaved parameter)
520 - CTRL+S to save a parameter
521 - CTRL+Z to undo the last edit
523 Notes on naming Parameters:
525 - Choose meaningful, unique parameter names for each parameter. If the
526 same parameter value appears in multiple places in the config, the
527 parameter name which is assigned to the first instance will be
528 automatically assigned to all instances. However, you may choose a
529 different parameter name for each instance of the parameter value
530 (except when using the MERGE function).
532 - Use only dash (-) or underline (\_) as separators between words in
535 - The name should not contain spaces or any other special characters.
537 - Do not use parameter names which are sub-strings of other parameter
538 names. For example, don’t use field1 and field12 as parameter names.
540 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.
542 Synchronizing a Template
543 ~~~~~~~~~~~~~~~~~~~~~~~~
545 Once you have named all the parameters (this example shows 3
546 parameters), click the “SYNCHRONIZE TEMPLATE PARAMETERS” button to automatically create a
547 parameter definition file and a parameter name-value file. The next
548 sections describe these files.
550 It may take a few seconds for the system to synchronize; when it is
551 complete, you will be taken to the Parameter Definition screen.
553 Remember to use the SAVE and/or DOWNLOAD buttons on the Reference Data
554 screen to preserve your work.
558 Modifying an Existing Template
559 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
561 In addition to creating new templates, you can also modify an existing
562 template by adding or removing parameter names.
564 To add a new parameter name, follow the steps in the Create a template from a "golden" configuration file section above.
565 SYNCHRONIZE TEMPLATE PARAMETERS to add the new parameter to the name/value and parameter
568 To remove an existing parameter name, remove the parameter name (i.e.,
569 ${name}) using the backspace key and replace with the static value. Then
570 SYNCHRONIZE TEMPLATE PARAMETERS to remove the parameter from the name/value and parameter
573 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.
575 Remember to use the SAVE and/or DOWNLOAD buttons on the Reference Data
576 screen to preserve your work.
578 Create a parameter definition file describing instance-specific parameters in the template
579 ------------------------------------------------------------------------------------------
581 Clicking the “SYNCHRONIZE TEMPLATE PARAMETERS” button after creating a template will automatically create/update a parameter definition file for
582 that template (and a parameter name-value file described in the next
583 section). Alternatively, you can upload an existing parameter definition
586 You can view or edit the definition fields for each parameter via the
587 Parameter Definition screen. Note that any edits to the parameter names
588 would be overwritten by a subsequent SYNCHRONIZE TEMPLATE PARAMETERS.
592 Select a Source for each parameter
593 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
595 There are three choices for the source:
597 1. **External Systems**. APPC will automatically obtain parameter values from
598 an external system (typically IP addresses for VNF’s). First, obtain a
599 “key file” for your VNF. Then use the
600 “Upload Key File” button on the Parameter Definition screen. APPC
601 will automatically populate key names and values used to retrieve data
602 from an external system.
605 2. **A&AI**. APPC will automatically obtain parameter values from
606 A&AI (typically VNF/VNFC/VM identifiers). After selecting “A&AI”,
607 select a rule type and APPC will automatically populate the key
608 names and values. For rule types that include a list, populate the
609 ‘Filter By Field’ and ‘Filter By Value’.
613 3. **Manual**. APPC will use a manually-created excel to populate
614 parameter values. Later section describes this User Input Spreadsheet.
616 Remember to use the SAVE and/or DOWNLOAD buttons on the Reference Data
617 screen to preserve your work.
619 Create a file containing name-value pairs for parameters
620 --------------------------------------------------------
622 Clicking the “SYNCHRONIZE TEMPLATE PARAMETERS” button after creating a template (see section
623 Synchronizing a Template) will automatically create/update a parameter name-value pair file
624 for that template (and a parameter definition file described in the
627 Navigate to the Template tab and “Param Values” subtab to view/edit
628 parameter name-value pairs.
630 If you make any edits, remember to use the SAVE and/or DOWNLOAD buttons
631 on the Reference Data screen to preserve your work.
635 Option: Using MERGE to automatically create a template from a parameter name-value pair file
636 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
638 APPC CDT also provides a way to create a template from an
639 existing parameter name-value pair file. This is useful when the
640 configuration of the VNF has changed. Rather than manually recreating
641 the template, you can use the MERGE function to automatically add
642 parameter names based on a valid name-value pairs file from a previous
645 First, navigate to the Template tab and “Param Values” subtab and click
650 Then navigate to the Template configuration screen. Upload a
651 configuration file that contains values you wish to turn into
656 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..
658 After using the MERGE FROM PARAM button to create a template, you can use the
659 SYNCHRONIZE TEMPLATE PARAMETERS button to create/update the parameter definition file and
662 Remember to use the SAVE and/or DOWNLOAD buttons on the Reference Data
663 screen to preserve your work.
668 Option: Synchronize with Name/Values
669 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
670 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 - Step 1: Create or upload template
675 - Step 2: SYNCHRONIZE TEMPLATE PARAMETERS. (APPC will update Parameter Definition file and Name-Value Pair file to match Template.)
677 - Step 3: Manually edit Name-Value Pair file (or upload a changed Name-Value Pair file)
679 - Step 4: SYNCHRONIZE WITH NAME VALUES. (see screen shot below)(APPC will update Parameter Definition file to match Name-Value Pair file.)
681 - Step 5: Examine Parameter Definitions to confirm they now match updated Name-Value Pair file.
687 Test the template in a lab using APPC CDT Test Function
688 =======================================================
690 The APPC CDT **TEST** action is used to initiate configuration
691 and other lifecycle commands
694 - A. Testing requires an instance of the target VNF to be reachable from your test environment.
695 - 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.
696 - C. You have created a user input spreadsheet for the VNF and action you wish to test.
698 **Steps to Test a template:**
699 - 1. Choose the TEST function on the APPC CDT home page
700 - 2. Upload the user input spreadsheet
701 - 3. Click on EXECUTE TEST
702 - 4. View test progress; poll for test status if necessary.
703 - 5. View Test Results
706 User Input Spreadsheet
707 ----------------------
709 The following steps are used to prepare a user input spreadsheet for the
710 VNF instance and action to be tested.
712 1. Start with this generic user input excel spreadsheet.
714 :download:`Generic 1802 User Input Spreadsheet v.02.xlsx` (compatible with excel 2013)
716 Update the user-input sections of the spreadsheet.
718 - a) Upload Data tab: choose action, populate VNF-ID
720 - 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).
722 The screen shots on the following pages show the user input sections highlighted in yellow.
724 2. Save the spreadsheet with a name for your VNF instance and action.
726 “Upload Data” tab – Select action to be tested and populate any action
727 identifiers such as vnf-id.
731 Action tab: This example is for the ConfigModify action, so the
732 “ConfigModify” tab is shown. Choose a protocol and enter required action
733 identifiers & request parameter values. Enter any payload parameter
734 names and values required for this associated template. (You may
735 copy/paste from a name-value pair file or other source).
739 Using APPC CDT TEST Function
740 ----------------------------
742 **Steps to use the “TEST” function of the APPC Design Tool**
744 1. Choose the TEST function on the APPC Design Tool home page
748 2. Upload the user input spreadsheet
749 3. Click on EXECUTE TEST
750 4. View test progress; poll for test status if necessary.
761 Note on populating southbound properties:
762 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
764 When a new vnf-type is created or a new action is added to an existing
765 vnf-type using the CDT tool and the Reference Data artifact is loaded to
766 APPC, an update is made to the APPC run-time southbound properties
767 file for the vnf-type. The southbound properties are needed for
768 connecting to a VNF instance or Ansible server. The southbound
769 properties contain the following information:
771 ``{vnf\_type}.{protocol}.{action}.user = {value}``
773 ``{vnf\_type}.{protocol}.{action}.port = {value}``
775 ``{vnf\_type}.{protocol}.{action}.password = {value}``
777 ``{vnf\_type}.{protocol}.{action}.url = {value}``
779 The user, port, and url values are contained in the Reference Data
780 artifact, if populated by the self-service user.
782 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 APP-C Design Tool - File Descriptions
786 =====================================
788 +--------------------------------------------------------------------------------------------------------------------------------------+-------------------+
789 | **File Description** | **File Format** |
790 +======================================================================================================================================+===================+
792 | **Pre-template Config file** –contains a ‘golden’ or working configuration (for Netconf) or JSON data block (for Chef or Ansible). | XML, JSON |
794 +--------------------------------------------------------------------------------------------------------------------------------------+-------------------+
796 | **Reference file** – describes a VNF in terms of its subtending VM’s and VNFC’s and the actions/protocols being onboarded. | XML, JSON |
798 +--------------------------------------------------------------------------------------------------------------------------------------+-------------------+
800 | **Template file** – a configuration file with parameters for instance-specific fields. | XML |
802 +--------------------------------------------------------------------------------------------------------------------------------------+-------------------+
804 | **Parameter Definition file** (aka pd\_Configure) contains **parameter definitions** associated with a template. | YAML |
806 +--------------------------------------------------------------------------------------------------------------------------------------+-------------------+
808 | **Name-Value file** (aka param\_Configure) contains name-value pairs for parameters associated with a template. | JSON |
810 +--------------------------------------------------------------------------------------------------------------------------------------+-------------------+
812 | **Key data file** – contains external system data to populate a PD configure file. | TXT |
814 +--------------------------------------------------------------------------------------------------------------------------------------+-------------------+
818 .. |image0| image:: media/image0.png
821 .. |image1| image:: media/image1.png
824 .. |image2| image:: media/image2.png
827 .. |image3| image:: media/image3.png
830 .. |image4| image:: media/image4.png
833 .. |image5| image:: media/image5.png
836 .. |image6| image:: media/image6.png
839 .. |image7| image:: media/image7.png
842 .. |image8| image:: media/image8.png
845 .. |image9| image:: media/image9.png
848 .. |image10| image:: media/image10.png
851 .. |image11| image:: media/image11.png
854 .. |image12| image:: media/image12.png
857 .. |image13| image:: media/image13.png
860 .. |image14| image:: media/image14.png
863 .. |image15| image:: media/image15.png
866 .. |image15a| image:: media/image15a.png
867 .. |image15b| image:: media/image15b.png
868 .. |image15c| image:: media/image15c.png
869 .. |image15d| image:: media/image15d.png
870 .. |image15e| image:: media/image15e.png
871 .. |image15f| image:: media/image15f.png
872 .. |image16| image:: media/image16.png
875 .. |imageA| image:: media/imageA.png
878 .. |image17| image:: media/image17.png
881 .. |image18| image:: media/image18.png
884 .. |image19| image:: media/image19.png
887 .. |image20| image:: media/image20.png
890 .. |image21| image:: media/image21.png
893 .. |image23| image:: media/image23.png
896 .. |image24| image:: media/image24.png
899 .. |image26| image:: media/image26.png
902 .. |image27| image:: media/image27.png
905 .. |image28| image:: media/image28.png
908 .. |image29| image:: media/image29.png
911 .. |image30| image:: media/image30.png
914 .. |image30a| image:: media/image30a.png
915 .. |image31| image:: media/image31.png
918 .. |image32| image:: media/image32.png
921 .. |image33| image:: media/image33.png
924 .. |image34| image:: media/image34.png
927 .. |image35| image:: media/image35.png
930 .. |image36| image:: media/image36.png