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** 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** 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 5. **Test** the template in your test environment using the **TEST** function of APPC CDT
152 - Use the **Save to APP-C** button in the CDT GUI to save the
153 artifacts for your VNF to APPC.
155 - Prepare a “user input” excel file on your PC and upload it to the
156 **TEST** function in the APPC CDT.
158 - Use the **TEST** function in the APPC CDT to execute the on-boarded action on the VNF. Verify the VNF works as expected.
160 **NOTE** The **TEST** function is currently being developed as part of Beijing release and screen shots in this document are not yet updated to show this new function yet.
162 The screen shots in following sections illustrate how to use the APPC CDT GUI for each step.
164 Artifacts used for Onboarding:
165 ------------------------------
167 For a given VNF, each action must be on-boarded separately. Actions can
168 be on-boarded in any order; it is not required that “Configure” be the first action onboarded.
170 You will create 1 Reference Data file for each VNF, and a set of up to 3
171 files for each action you are onboarding:
174 2. Parameter definition file (pd\_configure)
175 3. Parameter name-value pair file (param\_configure)
177 For example, onboarding the “vABC” VNF for 2 actions (Configure and
178 ConfigModify) may result in these 7 files:
180 1. reference\_AllAction\_vABC\_0.0.1V
181 2. template\_Configure\_vABC\_0.0.1V
182 3. pd\_Configure\_vABC\_0.0.1V
183 4. param\_Configure\_vABC\_0.0.1V
184 5. template\_ConfigModify\_vABC\_0.0.1V
185 6. pd\_ConfigModify\_vABC\_0.0.1V
186 7. param\_ConfigModify\_vABC\_0.0.1V
188 A **Template** is required for the Ansible, Chef and Netconf protocols.
190 The **Parameter Definition** and **Parameter Name-Value Pair** artifacts
191 are typically used with the Configure and ConfigModify templates and are
192 optional for templates of other actions.
194 OpenStack and REST protocols do not use a template or parameter
195 definitions or name-value pairs.
197 Using the APPC Design Tool for VNF Onboarding
198 =============================================
200 Go to the APPC CDT GUI in the test environment using a Firefox browser.
202 http://<server>:8080/config-design-tool/index.html#/home
206 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.
212 If you have not used APPC CDT previously, you will be asked to
213 enter your user id. Your work will be stored under this user id. There
214 is no password required at this time.
216 Note: If multiple self-service users will be working on a set of VNF’s,
217 it is suggested that you enter a group\_name rather than your user\_id.
218 This group name would be used by all users in the group so that all
219 users can view/edit the same set of artifacts.
221 If you have previously used APPC CDT, you user id will
222 automatically be selected.
226 The “My VNFs” GUI displays a list of the vnf-type/vnfc-types which are
227 stored under your userid in the APPC database. You can choose either
228 “Create New VNF” or “View/Edit” for one of your existing VNF’s.
232 If you have not created any VNF artifacts in the current release of the
233 APPC CDT, you will see a screen like this; click “Create new
236 VNF artifacts created using earlier versions of the APPC CDT
237 can be uploaded and then edited/saved, as shown on later screens. You
238 should not have to re-create these VNF artifacts.
242 If you choose to create a new VNF, you will see a pop-up box like this.
246 Enter the VNF Type (and optional VNFC Type) and click next.
248 Alternatively, you can leave the VNF type blank and choose “PROCEED
249 ANYWAY” if you want to proceed to the Reference Data screen where you
250 can populate the VNF reference data by uploading an existing Reference
251 File or by manually entering it.
253 You must populate the VNF field if uploading the existing file does not
256 Populate reference data describing the VNF and action to be onboarded
257 ---------------------------------------------------------------------
269 Note 1: When downloading your work to APPC; the system will download
270 only the artifacts that have been updated in the current session. You
271 may not see all 4 artifacts unless you visit/edit the reference,
272 template, parameter and parameter definition screens.
274 Note 2: When downloading files, the system will display a pop-up window
275 for each file, but the windows are all placed on top of each other. You
276 can drag the pop-up windows if you want to see them all at the same
281 Populate OpenStack actions for a VM
282 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
284 You can also onboard OpenStack commands for the VM level components of
287 Under ‘Action’, select “OpenStack Actions” and then under ‘Protocol’
290 You must populate the ‘VNF type’ if it is not already populated.
294 Next, upload an excel file of VM capabilities for your VNF. The excel
295 must list OpenStack actions in the first column, and then have a column
296 for each VM type (i.e., VNFC Function Code) showing which actions are
297 applicable for that VM type, as shown Excel sample below:
301 APPC will import the data from the excel and display the results.
305 The Template and Parameter Definition tabs do not apply to OpenStack
308 REFERENCE DATA SCREEN HELP
310 +--------------------------+------------------------------------------------------------------------------------------------------------------+
311 | **Field/Object** | **Description** |
312 +==========================+==================================================================================================================+
313 | **VNF Reference Data** |
314 +--------------------------+------------------------------------------------------------------------------------------------------------------+
315 | Action | The action to be executed on the VNF, e.g., “CONFIGURE” (see table below). |
316 +--------------------------+------------------------------------------------------------------------------------------------------------------+
317 | VNF Type | The name of the VNF, e.g. vDBE. |
318 +--------------------------+------------------------------------------------------------------------------------------------------------------+
319 | VNFC Type | NA when describing a VNF; When describing a VNFC, enter the VNFC name e.g.,MSC, SSC, MMC, etc. |
320 +--------------------------+------------------------------------------------------------------------------------------------------------------+
321 | Device Protocol | Choose desired protocol e.g., NETCONF-XML (see table below). |
322 +--------------------------+------------------------------------------------------------------------------------------------------------------+
323 | Template | Will there be a template created for this VNF and action? Yes/No. |
324 +--------------------------+------------------------------------------------------------------------------------------------------------------+
325 | User Name | Enter the user name used to configure the VNF e.g., “admin” or “root”. |
326 +--------------------------+------------------------------------------------------------------------------------------------------------------+
327 | Port Number | Enter the port number used to configure the VNF, e.g., 22. |
328 +--------------------------+------------------------------------------------------------------------------------------------------------------+
329 | Context URL | Enter the context portion of the REST URL (Currently used only for the HealthCheck action with REST protocol). |
330 +--------------------------+------------------------------------------------------------------------------------------------------------------+
331 | **VNFC information** |
332 +--------------------------+------------------------------------------------------------------------------------------------------------------+
333 | VNFC Type | Enter the VNFC name e.g. MSC, SSC, MMC, etc. |
334 +--------------------------+------------------------------------------------------------------------------------------------------------------+
335 | VNFC Function Code | Enter the standard 3 character value for the VNFC. |
336 +--------------------------+------------------------------------------------------------------------------------------------------------------+
337 | IP Address V4 OAM VIP | Select Y to store the O&AM VIP address with the VNFC record; otherwise select N. |
338 +--------------------------+------------------------------------------------------------------------------------------------------------------+
339 | Group Notation Type | Select the naming scheme for VNFC/VM instances (first-vnfc-name, fixed value, relative value) |
340 +--------------------------+------------------------------------------------------------------------------------------------------------------+
341 | Group Notation Value | For first-vnfc-name type, enter text such as “pair” or “group”. |
343 | | For fixed value type, enter any alpha-numeric text “1”, “test” etc. |
345 | | For relative value type, enter a number “1”, “2”, “4”, etc |
346 +--------------------------+------------------------------------------------------------------------------------------------------------------+
347 | Number of VM’s | Enter the # of VM’s for this VNFC. |
348 +--------------------------+------------------------------------------------------------------------------------------------------------------+
352 This table shows which actions and protocols are currently available for
353 on-boarding with the Beijing release.
355 +----------------------------------------+--------------+---------------+------------+------------+----------------+
356 | **Action** | **Netconf/ | **Ansible** | **Chef** | **REST** | **OpenStack |
357 | | Restconf** | | | | (VM Level)** |
358 +========================================+==============+===============+============+============+================+
359 | **AttachVolume** | | | | | YES |
360 +----------------------------------------+--------------+---------------+------------+------------+----------------+
361 | **Configure** | YES | YES | YES | | |
362 +----------------------------------------+--------------+---------------+------------+------------+----------------+
363 | **Config Modify** | YES | YES | YES | | |
364 +----------------------------------------+--------------+---------------+------------+------------+----------------+
365 | **Config Backup** | | YES | YES | | |
366 +----------------------------------------+--------------+---------------+------------+------------+----------------+
367 | **Config Restore** | | YES | YES | | |
368 +----------------------------------------+--------------+---------------+------------+------------+----------------+
369 | **ConfigScaleOut** | YES | YES | YES | | |
370 +----------------------------------------+--------------+---------------+------------+------------+----------------+
371 | **DetachVolume** | | | | | YES |
372 +----------------------------------------+--------------+---------------+------------+------------+----------------+
373 | **Evacuate** | | | | | YES |
374 +----------------------------------------+--------------+---------------+------------+------------+----------------+
375 | **GetRunning Config\*** | YES | YES | YES | | |
376 +----------------------------------------+--------------+---------------+------------+------------+----------------+
377 | **HealthCheck** | | YES | YES | YES | |
378 +----------------------------------------+--------------+---------------+------------+------------+----------------+
379 | **Migrate** | | | | | YES |
380 +----------------------------------------+--------------+---------------+------------+------------+----------------+
381 | **QuiesceTraffic** | | YES | YES | | |
382 +----------------------------------------+--------------+---------------+------------+------------+----------------+
383 | **Rebuild** | | | | | YES |
384 +----------------------------------------+--------------+---------------+------------+------------+----------------+
385 | **Restart** | | | | | YES |
386 +----------------------------------------+--------------+---------------+------------+------------+----------------+
387 | **ResumeTraffic** | | YES | YES | | |
388 +----------------------------------------+--------------+---------------+------------+------------+----------------+
389 | **Snapshot** | | | | | YES |
390 +----------------------------------------+--------------+---------------+------------+------------+----------------+
391 | **Start** | | | | | YES |
392 +----------------------------------------+--------------+---------------+------------+------------+----------------+
393 | **Start Application** | | YES | YES | | |
394 +----------------------------------------+--------------+---------------+------------+------------+----------------+
395 | **Stop** | | | | | YES |
396 +----------------------------------------+--------------+---------------+------------+------------+----------------+
397 | **Stop Application** | | YES | YES | | |
398 +----------------------------------------+--------------+---------------+------------+------------+----------------+
399 | **UpgradeBackout** | | YES | YES | | |
400 +----------------------------------------+--------------+---------------+------------+------------+----------------+
401 | **UpgradeBackup** | | YES | YES | | |
402 +----------------------------------------+--------------+---------------+------------+------------+----------------+
403 | **UpgradePostCheck** | | YES | YES | | |
404 +----------------------------------------+--------------+---------------+------------+------------+----------------+
405 | **UpgradePreCheck** | | YES | YES | | |
406 +----------------------------------------+--------------+---------------+------------+------------+----------------+
407 | **UpgradeSoftware** | | YES | YES | | |
408 +----------------------------------------+--------------+---------------+------------+------------+----------------+
410 \* GetRunningConfig is used internally by APP-C and is not callable by clients via the APP-C API.
414 Create a template from a “golden” configuration file
415 ----------------------------------------------------
417 There are several ways to create a template in APPC CDT:
419 - Start from golden instance config file; manually add parameters
420 (described in this section)
422 - Start with a template file, manually add more parameters. (described
423 in section Synchronizing a Template)
425 - Start with config file; create updated template by **merging**
426 name-value pairs. (described in Create a file containing name-value pairs for parameters section)
428 Start with a working configuration for a “golden instance” of the VNF
429 (xml if Netconf) or the payload to be downloaded to the Chef or Ansible
432 Open the XML or JSON file in Notepad ++ and verify that the format is
433 schema compliant. If the xml file is for a post-instantiation
434 configuration, then modify the config to include only statements that
435 are to be added (merged) with any configuration that is on the VNF
436 instance after instantiation. For example, remove statements that might
437 change root passwords, etc.
439 Optionally, add Velocity statements to the file, if desired, to handle
440 special constructs such as variable lists, template defined constants,
441 conditional statements, etc.
443 Here are links with more information about the Velocity java-based
446 http://velocity.apache.org/engine/2.0/vtl-reference.html
448 http://velocity.apache.org/engine/2.0/user-guide.html
450 This screen shows a sample Golden Configuration file that has been
451 uploaded to APP-C CDT.
455 Next, designate instance-specific values as parameters, using this
458 1) Highlight the instance-specific value with the cursor
462 2) Type “CTRL” and “4” to insert a parameter name.
466 3) Type the parameter name in the parentheses
470 4) Type “CTRL” and “S” to save the parameter.
474 Repeat for each instance-specific value that you wish to turn into a
477 *Summary of editing commands:*
479 - CTRL+4 to add a parameter (also saves previous unsaved parameter)
480 - CTRL+S to save a parameter
481 - CTRL+Z to undo the last edit
483 Notes on naming Parameters:
485 - Choose meaningful, unique parameter names for each parameter. If the
486 same parameter value appears in multiple places in the config, the
487 parameter name which is assigned to the first instance will be
488 automatically assigned to all instances. However, you may choose a
489 different parameter name for each instance of the parameter value
490 (except when using the MERGE function).
492 - Use only dash (-) or underline (\_) as separators between words in
495 - The name should not contain spaces or any other special characters.
497 - Do not use parameter names which are sub-strings of other parameter
498 names. For example, don’t use field1 and field12 as parameter names.
501 Synchronizing a Template
502 ~~~~~~~~~~~~~~~~~~~~~~~~
504 Once you have named all the parameters (this example shows 2
505 parameters), click the “SYNCHRONIZE” button to automatically create a
506 parameter definition file and a parameter name-value file. The next
507 sections describe these files.
509 It may take a few seconds for the system to SYNCHRONIZE; when it is
510 complete, you will be taken to the Parameter Definition screen.
512 Remember to use the SAVE and/or DOWNLOAD buttons on the Reference Data
513 screen to preserve your work.
517 Modifying an Existing Template
518 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
520 In addition to creating new templates, you can also modify an existing
521 template by adding or removing parameter names.
523 To add a new parameter name, follow the steps in the Create a template from a "golden" configuration file section above.
524 SYNCHRONIZE to add the new parameter to the name/value and parameter
527 To remove an existing parameter name, remove the parameter name (i.e.,
528 ${name}) using the backspace key and replace with the static value. Then
529 SYNCHRONIZE to remove the parameter from the name/value and parameter
532 Remember to use the SAVE and/or DOWNLOAD buttons on the Reference Data
533 screen to preserve your work.
535 Create a parameter definition file describing instance-specific parameters in the template
536 ------------------------------------------------------------------------------------------
538 Clicking the “SYNCHRONIZE” button after creating a template will automatically create/update a parameter definition file for
539 that template (and a parameter name-value file described in the next
540 section). Alternatively, you can upload an existing parameter definition
543 You can view or edit the definition fields for each parameter via the
544 Parameter Definition screen. Note that any edits to the parameter names
545 would be overwritten by a subsequent SYNCHRONIZE with the template.
549 Select a Source for each parameter
550 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
552 There are three choices for the source:
554 1. External Systems (e.g., INSTAR). APPC will automatically obtain parameter values from
555 an external system (typically IP addresses for VNF’s). First, obtain a
556 “key file” for your VNF. Then use the
557 “Upload Key File” button on the Parameter Definition screen. APPC
558 will automatically populate key names and values used to retrieve data
559 from an external system.
562 2. ***A&AI***. APPC will automatically obtain parameter values from
563 A&AI (typically VNF/VNFC/VM identifiers). After selecting “A&AI”,
564 select a rule type and APPC will automatically populate the key
565 names and values. For rule types that include a list, populate the
566 ‘Filter By Field’ and ‘Filter By Value’.
570 3. ***Manual.*** APPC will use a manually-created excel to populate
571 parameter values. Later section describes this User Input Spreadsheet.
573 Remember to use the SAVE and/or DOWNLOAD buttons on the Reference Data
574 screen to preserve your work.
576 Create a file containing name-value pairs for parameters
577 --------------------------------------------------------
579 Clicking the “SYNCHRONIZE” button after creating a template (see section
580 Synchronizing a Template) will automatically create/update a parameter name-value pair file
581 for that template (and a parameter definition file described in the
584 Navigate to the Template tab and “Param Values” subtab to view/edit
585 parameter name-value pairs.
587 If you make any edits, remember to use the SAVE and/or DOWNLOAD buttons
588 on the Reference Data screen to preserve your work.
592 Option: Using MERGE to automatically create a template from a parameter name-value pair file
593 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
595 The APPC Design Tool also provides a way to create a template from an
596 existing parameter name-value pair file. This is useful when the
597 configuration of the VNF has changed. Rather than manually recreating
598 the template, you can use the MERGE function to automatically add
599 parameter names based on a valid name-value pairs file from a previous
602 First, navigate to the Template tab and “Param Values” subtab and click
607 Then navigate to the Template configuration screen. Upload a
608 configuration file that contains values you wish to turn into
613 Next, click “MERGE”. APPC will automatically add parameters to the
614 configuration file using the name-value pairs. Wherever APPC finds a
615 matching value, it will add the corresponding parameter name.
617 After using the MERGE button to create a template, you can use the
618 SYNCHRONIZE button to create/update the parameter definition file and
621 Remember to use the SAVE and/or DOWNLOAD buttons on the Reference Data
622 screen to preserve your work.
626 Test the template in a lab using APPC CDT Test Function
627 =======================================================================
629 User Input Spreadsheet
630 ----------------------
632 The following steps are used to prepare a user input spreadsheet for the
633 VNF instance and action to be tested.
635 1. Start with this generic 1802 user input excel spreadsheet.
637 :download:`Generic 1802 User Input Spreadsheet v.02.xlsx` (compatible with excel 2013)
639 2. Update the user-input sections of the spreadsheet.
641 a) Upload Data tab: choose action, populate VNF-ID
643 b) >Action< tab: Select the tab for the action being tested. Choose a
644 protocol and enter required action identifiers & request parameter
645 values. Enter any payload parameter names and values required for
646 this associated template. (copy/paste from a name-value pair file or
649 The screen shots on the following pages show the user input sections
650 highlighted in yellow.
652 1. Save the spreadsheet with a name for your VNF instance and action.
654 “Upload Data” tab – Select action to be tested and populate any action
655 identifiers such as vnf-id.
659 Action tab: This example is for the ConfigModify action, so the
660 “ConfigModify” tab is shown. Choose a protocol and enter required action
661 identifiers & request parameter values. Enter any payload parameter
662 names and values required for this associated template. (You may
663 copy/paste from a name-value pair file or other source).
667 Using APPC CDT TEST action to test a VNF configuration template
668 -----------------------------------------------------------------
670 The APPC CDT **TEST** action is used to initiate configuration
671 and other lifecycle commands.
674 - Testing requires an instance of the target VNF to be reachable from your test environment.
675 - 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.
676 - You have created a user input spreadsheet for the VNF and action you wish to test.
678 **Steps to use the “TEST” function of the APPC Design Tool**
680 1. Choose the TEST function on the APPC Design Tool home page
684 2. Upload the user input spreadsheet
685 3. Click on EXECUTE TEST
686 4. View test progress; poll for test status if necessary.
697 Note on populating southbound properties:
698 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
700 When a new vnf-type is created or a new action is added to an existing
701 vnf-type using the CDT tool and the Reference Data artifact is loaded to
702 APPC, an update is made to the APPC run-time southbound properties
703 file for the vnf-type. The southbound properties are needed for
704 connecting to a VNF instance or Ansible server. The southbound
705 properties contain the following information:
707 ``{vnf\_type}.{protocol}.{action}.user = {value}``
709 ``{vnf\_type}.{protocol}.{action}.port = {value}``
711 ``{vnf\_type}.{protocol}.{action}.password = {value}``
713 ``{vnf\_type}.{protocol}.{action}.url = {value}``
715 The user, port, and url values are contained in the Reference Data
716 artifact, if populated by the self-service user. The password value is
717 updated by T2 production support using a GUI tool provided. <TO DO: CHECK ON THIS>
719 The current process which creates the southbound properties from the
720 Reference Data only updates the southbound properties file only a single
721 node in the APPC cluster.
724 APP-C Design Tool - File Descriptions
725 =====================================
727 +--------------------------------------------------------------------------------------------------------------------------------------+-------------------+------------------------------------------------------+
728 | **File Description** | **File Format** | **File name / example** |
729 +======================================================================================================================================+===================+======================================================+
731 | **Pre-template Config file** –contains a ‘golden’ or working configuration (for Netconf) or JSON data block (for Chef or Ansible). | XML, JSON | :download:`simple xml config.txt` |
733 +--------------------------------------------------------------------------------------------------------------------------------------+-------------------+------------------------------------------------------+
735 | **Reference file** [5]_– describes a VNF in terms of its subtending VM’s and VNFC’s and the actions/protocols being onboarded. | XML, JSON | :download:`reference_AllAction_vPQR_0.0.1V.json` |
737 +--------------------------------------------------------------------------------------------------------------------------------------+-------------------+------------------------------------------------------+
739 | **Template file** – a configuration file with parameters for instance-specific fields. | XML | :download:`template_Configure_vABC_0.0.1.txt` |
741 +--------------------------------------------------------------------------------------------------------------------------------------+-------------------+------------------------------------------------------+
743 | **Parameter Definition file** (aka pd\_Configure) contains **parameter definitions** associated with a template. | YAML | :download:`pd_Configure_vABC_0.0.1V.yaml.txt` |
745 +--------------------------------------------------------------------------------------------------------------------------------------+-------------------+------------------------------------------------------+
747 | **Name-Value file** (aka param\_Configure) contains name-value pairs for parameters associated with a template. | JSON | :download:`param_Configure_vABC_0.0.1V.txt` |
749 +--------------------------------------------------------------------------------------------------------------------------------------+-------------------+------------------------------------------------------+
751 | **Key data file** – contains external system data to populate a PD configure file. | TXT | <TO DO: Need sample file> |
753 +--------------------------------------------------------------------------------------------------------------------------------------+-------------------+------------------------------------------------------+
755 Note: Do not alter file names because APPC CDT requires a specific file naming format. Note that for yaml files, Sphinx is not able to handle correctly, so we had to add .txt to allow the download. Please remember to remove .txt from pd_Configure_vABC_0.0.1V.yaml.txt when you download it.
757 .. |image0| image:: media/image0.png
760 .. |image1| image:: media/image1.png
763 .. |image2| image:: media/image2.png
766 .. |image3| image:: media/image3.png
769 .. |image4| image:: media/image4.png
772 .. |image5| image:: media/image5.png
775 .. |image6| image:: media/image6.png
778 .. |image7| image:: media/image7.png
781 .. |image8| image:: media/image8.png
784 .. |image9| image:: media/image9.png
787 .. |image10| image:: media/image10.png
790 .. |image11| image:: media/image11.png
793 .. |image12| image:: media/image12.png
796 .. |image13| image:: media/image13.png
799 .. |image14| image:: media/image14.png
802 .. |image15| image:: media/image15.png
805 .. |image16| image:: media/image16.png
808 .. |imageA| image:: media/imageA.png
811 .. |image17| image:: media/image17.png
814 .. |image18| image:: media/image18.png
817 .. |image19| image:: media/image19.png
820 .. |image20| image:: media/image20.png
823 .. |image21| image:: media/image21.png
826 .. |image22| image:: media/image22.png
829 .. |image23| image:: media/image23.png
832 .. |image24| image:: media/image24.png
835 .. |image26| image:: media/image26.png
838 .. |image27| image:: media/image27.png
841 .. |image28| image:: media/image28.png
844 .. |image29| image:: media/image29.png
847 .. |image30| image:: media/image30.png
850 .. |image31| image:: media/image31.png
853 .. |image32| image:: media/image32.png
856 .. |image33| image:: media/image33.png
859 .. |image34| image:: media/image34.png
862 .. |image35| image:: media/image35.png
865 .. |image36| image:: media/image36.png