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 | **DistributeTraffic** | | YES | YES | | | |
417 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
418 | **DistributeTrafficCheck** | | YES | YES | | | |
419 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
420 | **Evacuate** | | | | | YES | |
421 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
422 | **HealthCheck** | | YES | YES | YES | | |
423 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
424 | **Lock** | | | | | | NA |
425 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
426 | **Migrate** | | | | | YES | |
427 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
428 | **QuiesceTraffic** | | YES | YES | | | |
429 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
430 | **Rebuild** | | | | | YES | |
431 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
432 | **Restart** | | | | | YES | |
433 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
434 | **ResumeTraffic** | | YES | YES | | | |
435 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
436 | **Snapshot** | | | | | YES | |
437 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
438 | **Start** | | | | | YES | |
439 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
440 | **Start Application** | | YES | YES | | | |
441 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
442 | **Stop** | | | | | YES | |
443 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
444 | **Stop Application** | | YES | YES | | | |
445 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
446 | **Sync** | YES | YES | YES | YES | | |
447 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
448 | **Unlock** | | | | | | NA |
449 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
450 | **UpgradeBackout** | | YES | YES | | | |
451 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
452 | **UpgradeBackup** | | YES | YES | | | |
453 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
454 | **UpgradePostCheck** | | YES | YES | | | |
455 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
456 | **UpgradePreCheck** | | YES | YES | | | |
457 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
458 | **UpgradeSoftware** | | YES | YES | | | |
459 +----------------------------------------+---------------+---------------+------------+------------+----------------+---------------+
463 Create a template from a “golden” configuration file
464 ----------------------------------------------------
466 There are several ways to create a template in APPC CDT:
468 - Start from golden instance config file; manually add parameters
469 (described in this section)
471 - Start with a template file, manually add more parameters. (described
472 in section Synchronizing a Template)
474 - Start with config file; create updated template by **merging**
475 name-value pairs. (described in Create a file containing name-value pairs for parameters section)
477 Start with a working configuration for a “golden instance” of the VNF
478 (xml if Netconf) or the payload to be downloaded to the Chef or Ansible
481 Open the XML or JSON file in Notepad ++ and verify that the format is
482 schema compliant. If the xml file is for a post-instantiation
483 configuration, then modify the config to include only statements that
484 are to be added (merged) with any configuration that is on the VNF
485 instance after instantiation. For example, remove statements that might
486 change root passwords, etc.
488 Optionally, add Velocity statements to the file, if desired, to handle
489 special constructs such as variable lists, template defined constants,
490 conditional statements, etc.
492 Here are links with more information about the Velocity java-based
495 http://velocity.apache.org/engine/2.0/vtl-reference.html
497 http://velocity.apache.org/engine/2.0/user-guide.html
499 This screen shows a sample Golden Configuration file that has been
500 uploaded to APP-C CDT.
504 Next, designate instance-specific values as parameters, using this
507 1) Highlight the instance-specific value (such as “node0 ) with the cursor and then type “CTRL” and “4”
511 2) Type the name you want to use for this parameter into the pop-up window and click SUBMIT
515 3) The system will display your parameter name after the value you highlighted
519 4) Repeat for each instance-specific value that you wish to turn into a parameter.
521 *Summary of editing commands:*
523 - CTRL+4 to add a parameter (also saves previous unsaved parameter)
524 - CTRL+S to save a parameter
525 - CTRL+Z to undo the last edit
527 Notes on naming Parameters:
529 - Choose meaningful, unique parameter names for each parameter. If the
530 same parameter value appears in multiple places in the config, the
531 parameter name which is assigned to the first instance will be
532 automatically assigned to all instances. However, you may choose a
533 different parameter name for each instance of the parameter value
534 (except when using the MERGE function).
536 - Use only dash (-) or underline (\_) as separators between words in
539 - The name should not contain spaces or any other special characters.
541 - Do not use parameter names which are sub-strings of other parameter
542 names. For example, don’t use field1 and field12 as parameter names.
544 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.
546 Synchronizing a Template
547 ~~~~~~~~~~~~~~~~~~~~~~~~
549 Once you have named all the parameters (this example shows 3
550 parameters), click the “SYNCHRONIZE TEMPLATE PARAMETERS” button to automatically create a
551 parameter definition file and a parameter name-value file. The next
552 sections describe these files.
554 It may take a few seconds for the system to synchronize; when it is
555 complete, you will be taken to the Parameter Definition screen.
557 Remember to use the SAVE and/or DOWNLOAD buttons on the Reference Data
558 screen to preserve your work.
562 Modifying an Existing Template
563 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
565 In addition to creating new templates, you can also modify an existing
566 template by adding or removing parameter names.
568 To add a new parameter name, follow the steps in the Create a template from a "golden" configuration file section above.
569 SYNCHRONIZE TEMPLATE PARAMETERS to add the new parameter to the name/value and parameter
572 To remove an existing parameter name, remove the parameter name (i.e.,
573 ${name}) using the backspace key and replace with the static value. Then
574 SYNCHRONIZE TEMPLATE PARAMETERS to remove the parameter from the name/value and parameter
577 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.
579 Remember to use the SAVE and/or DOWNLOAD buttons on the Reference Data
580 screen to preserve your work.
582 Create a parameter definition file describing instance-specific parameters in the template
583 ------------------------------------------------------------------------------------------
585 Clicking the “SYNCHRONIZE TEMPLATE PARAMETERS” button after creating a template will automatically create/update a parameter definition file for
586 that template (and a parameter name-value file described in the next
587 section). Alternatively, you can upload an existing parameter definition
590 You can view or edit the definition fields for each parameter via the
591 Parameter Definition screen. Note that any edits to the parameter names
592 would be overwritten by a subsequent SYNCHRONIZE TEMPLATE PARAMETERS.
596 Select a Source for each parameter
597 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
599 There are three choices for the source:
601 1. **External Systems**. APPC will automatically obtain parameter values from
602 an external system (typically IP addresses for VNF’s). First, obtain a
603 “key file” for your VNF. Then use the
604 “Upload Key File” button on the Parameter Definition screen. APPC
605 will automatically populate key names and values used to retrieve data
606 from an external system.
609 2. **A&AI**. APPC will automatically obtain parameter values from
610 A&AI (typically VNF/VNFC/VM identifiers). After selecting “A&AI”,
611 select a rule type and APPC will automatically populate the key
612 names and values. For rule types that include a list, populate the
613 ‘Filter By Field’ and ‘Filter By Value’.
617 3. **Manual**. APPC will use a manually-created excel to populate
618 parameter values. Later section describes this User Input Spreadsheet.
620 Remember to use the SAVE and/or DOWNLOAD buttons on the Reference Data
621 screen to preserve your work.
623 Create a file containing name-value pairs for parameters
624 --------------------------------------------------------
626 Clicking the “SYNCHRONIZE TEMPLATE PARAMETERS” button after creating a template (see section
627 Synchronizing a Template) will automatically create/update a parameter name-value pair file
628 for that template (and a parameter definition file described in the
631 Navigate to the Template tab and “Param Values” subtab to view/edit
632 parameter name-value pairs.
634 If you make any edits, remember to use the SAVE and/or DOWNLOAD buttons
635 on the Reference Data screen to preserve your work.
639 Option: Using MERGE to automatically create a template from a parameter name-value pair file
640 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
642 APPC CDT also provides a way to create a template from an
643 existing parameter name-value pair file. This is useful when the
644 configuration of the VNF has changed. Rather than manually recreating
645 the template, you can use the MERGE function to automatically add
646 parameter names based on a valid name-value pairs file from a previous
649 First, navigate to the Template tab and “Param Values” subtab and click
654 Then navigate to the Template configuration screen. Upload a
655 configuration file that contains values you wish to turn into
660 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..
662 After using the MERGE FROM PARAM button to create a template, you can use the
663 SYNCHRONIZE TEMPLATE PARAMETERS button to create/update the parameter definition file and
666 Remember to use the SAVE and/or DOWNLOAD buttons on the Reference Data
667 screen to preserve your work.
672 Option: Synchronize with Name/Values
673 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
674 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.
677 - Step 1: Create or upload template
679 - Step 2: SYNCHRONIZE TEMPLATE PARAMETERS. (APPC will update Parameter Definition file and Name-Value Pair file to match Template.)
681 - Step 3: Manually edit Name-Value Pair file (or upload a changed Name-Value Pair file)
683 - Step 4: SYNCHRONIZE WITH NAME VALUES. (see screen shot below)(APPC will update Parameter Definition file to match Name-Value Pair file.)
685 - Step 5: Examine Parameter Definitions to confirm they now match updated Name-Value Pair file.
691 Test the template in a lab using APPC CDT Test Function
692 =======================================================
694 The APPC CDT **TEST** action is used to initiate configuration
695 and other lifecycle commands
698 - A. Testing requires an instance of the target VNF to be reachable from your test environment.
699 - 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.
700 - C. You have created a user input spreadsheet for the VNF and action you wish to test.
702 **Steps to Test a template:**
703 - 1. Choose the TEST function on the APPC CDT home page
704 - 2. Upload the user input spreadsheet
705 - 3. Click on EXECUTE TEST
706 - 4. View test progress; poll for test status if necessary.
707 - 5. View Test Results
710 User Input Spreadsheet
711 ----------------------
713 The following steps are used to prepare a user input spreadsheet for the
714 VNF instance and action to be tested.
716 1. Start with this generic user input excel spreadsheet.
718 :download:`Generic 1802 User Input Spreadsheet v.02.xlsx` (compatible with excel 2013)
720 Update the user-input sections of the spreadsheet.
722 - a) Upload Data tab: choose action, populate VNF-ID
724 - 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).
726 The screen shots on the following pages show the user input sections highlighted in yellow.
728 2. Save the spreadsheet with a name for your VNF instance and action.
730 “Upload Data” tab – Select action to be tested and populate any action
731 identifiers such as vnf-id.
735 Action tab: This example is for the ConfigModify action, so the
736 “ConfigModify” tab is shown. Choose a protocol and enter required action
737 identifiers & request parameter values. Enter any payload parameter
738 names and values required for this associated template. (You may
739 copy/paste from a name-value pair file or other source).
743 Using APPC CDT TEST Function
744 ----------------------------
746 **Steps to use the “TEST” function of the APPC Design Tool**
748 1. Choose the TEST function on the APPC Design Tool home page
752 2. Upload the user input spreadsheet
753 3. Click on EXECUTE TEST
754 4. View test progress; poll for test status if necessary.
765 Note on populating southbound properties:
766 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
768 When a new vnf-type is created or a new action is added to an existing
769 vnf-type using the CDT tool and the Reference Data artifact is loaded to
770 APPC, an update is made to the APPC run-time southbound properties
771 file for the vnf-type. The southbound properties are needed for
772 connecting to a VNF instance or Ansible server. The southbound
773 properties contain the following information:
775 ``{vnf\_type}.{protocol}.{action}.user = {value}``
777 ``{vnf\_type}.{protocol}.{action}.port = {value}``
779 ``{vnf\_type}.{protocol}.{action}.password = {value}``
781 ``{vnf\_type}.{protocol}.{action}.url = {value}``
783 The user, port, and url values are contained in the Reference Data
784 artifact, if populated by the self-service user.
786 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..
789 APP-C Design Tool - File Descriptions
790 =====================================
792 +--------------------------------------------------------------------------------------------------------------------------------------+-------------------+
793 | **File Description** | **File Format** |
794 +======================================================================================================================================+===================+
796 | **Pre-template Config file** –contains a ‘golden’ or working configuration (for Netconf) or JSON data block (for Chef or Ansible). | XML, JSON |
798 +--------------------------------------------------------------------------------------------------------------------------------------+-------------------+
800 | **Reference file** – describes a VNF in terms of its subtending VM’s and VNFC’s and the actions/protocols being onboarded. | XML, JSON |
802 +--------------------------------------------------------------------------------------------------------------------------------------+-------------------+
804 | **Template file** – a configuration file with parameters for instance-specific fields. | XML |
806 +--------------------------------------------------------------------------------------------------------------------------------------+-------------------+
808 | **Parameter Definition file** (aka pd\_Configure) contains **parameter definitions** associated with a template. | YAML |
810 +--------------------------------------------------------------------------------------------------------------------------------------+-------------------+
812 | **Name-Value file** (aka param\_Configure) contains name-value pairs for parameters associated with a template. | JSON |
814 +--------------------------------------------------------------------------------------------------------------------------------------+-------------------+
816 | **Key data file** – contains external system data to populate a PD configure file. | TXT |
818 +--------------------------------------------------------------------------------------------------------------------------------------+-------------------+
820 The ADMIN Configuration GUI
821 ===========================
823 The Design Tool provide a user interface to onboard configuration
824 servers that App-C interacts with. Initially the Admin Configuration GUI
825 supports only Ansible servers. The Admin GUI is accessible to users
826 providing the following functionality.
828 - Display all existing configuration server profiles on the default
831 - Adding new server profiles
833 - Editing existing server profiles
835 - Sort user profiles on the display list
839 On Design Tool’s Home screen has the ADMIN menu item along with the
840 others. If the user has the privilege to access the Admin GUI, the ADMIN
841 menu item is enabled.
848 The Admin default screen displays the existing configuration server
855 - Configuration Server URL
857 This is the URL of the Ansible server. App-C uses this information to
858 establish connectivity to the Ansible server. Network routes and
859 firewall configuration should be completed prior to App-C
860 communicating with the server.
862 - Cloud-owner/Cloud-Region/Tenant
864 During runtime, App-C selects an Ansible server to configure a VNF by
865 matching on the VNF’s Tenant-ID. A Tenant-ID is unique with a
866 Cloud-Owner and Cloud-Region. This information must be the same as
871 This a free text field for entering information identifying the
876 The user ID last modified this profile.
880 The timestamp of this profile was last modified.
882 **Button functionality**:
886 To create a new configuration server profile
890 To view or edit an existing server profile
894 Download load Admin Artifact to PC
898 Save Admin Artifact to App-C database
902 Clicking on the triangles symbol next to a column heading would sort
903 the profiles by that column. Subsequent clicking would toggle the
904 sorting between ascending and descending order.
906 |image39|\ Creating a New Servers Profile
907 -----------------------------------------
909 The Server Profiles screen allows user to add server profiles. During
910 server profile creation, the Modifier and Date Modified parameters are
917 - Configuration Server URL
919 Enter the URL of the Ansible server or server cluster.
921 Example: http://ansible.appc.onap.org:5000
923 - Cloud-owner/Cloud-Region/Tenant
925 For each Ansible server, there must be at least one tenant entry. A
926 cloud-owner, cloud-region-id, and tenant-id combination determines a
931 Enter any information into this Description field.
933 - Creator and Date Created fields are pre-populated and not user
936 - Modifier and Date Modified are empty on the new profile screen
938 **Button functionality**:
940 ADD button: add the entered Cloud-owner, Cloud-Region-ID, and Tenant-ID
943 CANCEL Button: discard the changes and return to Admin home screen.
945 RETURN button: return back to the Admin home screen. Data is not saved
946 database as this point.
948 |image41|\ Note: Remember to use the “SAVE ALL TO APPC” button on the
949 Admin home screen to preserve your work.
951 Editing an Existing Server Profile
952 ----------------------------------
954 The Configuration Server screen allows user to edit existing Ansible
955 profiles. CDT retrieves the server’s profile from database for
960 - Configuration Server URL
962 URL of the Ansible server or server cluster.
964 Example: http://ansible.appc.onap.org:5000
966 Cloud-owner, Cloud-Region-ID, Tenant ID
968 For each Ansible server, there must be at least one tenant entry. A
969 cloud-owner, cloud-region-id, and tenant-id combination determines a
974 Enter any information into this Description field.
976 - Creator, Date Created, Modifier, and Date Modified fields are
977 pre-populated and not user editable.
979 **Button functionality**:
981 ADD button: add the entered Cloud-owner, Cloud-Region-ID, and Tenant-ID
984 REMOVE button: removes a tenant entry
986 CANCEL Button: discard the changes and return to Admin home screen.
988 RETURN button: return back to the Admin home screen. Data is not saved
989 database as this point.
991 |image41|\ Note: Remember to use the “SAVE ALL TO APPC” button on the
992 Admin home screen to preserve your work.
996 Sorting Server Profiles
997 -----------------------
999 Design Tool provides a sorting capability similar to the VNF profile
1002 - User can select columns to be sorted by clicking on the triangle
1003 symbols next to the column headings.
1005 - Repeated clicking on an arrow symbol toggles the sorting orders
1006 between ascending and descending.
1009 .. |image0| image:: media/image0.png
1012 .. |image1| image:: media/image1.png
1015 .. |image2| image:: media/image2.png
1018 .. |image3| image:: media/image3.png
1021 .. |image4| image:: media/image4.png
1024 .. |image5| image:: media/image5.png
1027 .. |image6| image:: media/image6.png
1030 .. |image7| image:: media/image7.png
1033 .. |image8| image:: media/image8.png
1036 .. |image9| image:: media/image9.png
1039 .. |image10| image:: media/image10.png
1042 .. |image11| image:: media/image11.png
1045 .. |image12| image:: media/image12.png
1048 .. |image13| image:: media/image13.png
1051 .. |image14| image:: media/image14.png
1054 .. |image15| image:: media/image15.png
1057 .. |image15a| image:: media/image15a.png
1058 .. |image15b| image:: media/image15b.png
1059 .. |image15c| image:: media/image15c.png
1060 .. |image15d| image:: media/image15d.png
1061 .. |image15e| image:: media/image15e.png
1062 .. |image15f| image:: media/image15f.png
1063 .. |image16| image:: media/image16.png
1066 .. |imageA| image:: media/imageA.png
1069 .. |image17| image:: media/image17.png
1072 .. |image18| image:: media/image18.png
1075 .. |image19| image:: media/image19.png
1078 .. |image20| image:: media/image20.png
1081 .. |image21| image:: media/image21.png
1084 .. |image23| image:: media/image23.png
1087 .. |image24| image:: media/image24.png
1090 .. |image26| image:: media/image26.png
1093 .. |image27| image:: media/image27.png
1096 .. |image28| image:: media/image28.png
1099 .. |image29| image:: media/image29.png
1102 .. |image30| image:: media/image30.png
1105 .. |image30a| image:: media/image30a.png
1106 .. |image31| image:: media/image31.png
1109 .. |image32| image:: media/image32.png
1112 .. |image33| image:: media/image33.png
1115 .. |image34| image:: media/image34.png
1118 .. |image35| image:: media/image35.png
1121 .. |image36| image:: media/image36.png
1124 .. |image37| image:: media/image37.png
1127 .. |image38| image:: media/image38.png
1130 .. |image39| image:: media/image39.png
1131 .. |image40| image:: media/image40.png
1134 .. |image41| image:: media/image41.png
1137 .. |image42| image:: media/image42.png