This document is the user guide for the standalone version of the Cisco Crosswork Workflow Manager Solutions Golden Configuration package.

This document describes how to configure and use Crosswork Workflow Manager Solutions Golden Configuration. This document is intended for Cisco Advanced Services developers, network engineers, and system engineers who configure and deliver Crosswork Workflow Manager Solutions functionalities to Cisco customers.

This documentation requires the reader to have a good understanding of Cisco Crosswork and Cisco NSO and its use, as described in the Cisco documentation. For more information on NSO products, go to: https://developer.cisco.com/docs/nso/.

The Golden Configuration workflow follows these basic phases:

• Device Configuration: This phase presents the device in the basic configuration.

• Integrate with GC template: In this phase you integrate the device with the configured GC template.

• Create a GC application: In this phase you create an application with customized variables and values used in the GC template.

• Apply the configured device: In this phase you need to load and merge both the template and the application into NSO.

• Verify functionality in the network: The GC application plan displays the status of the template application to the device.

For the Golden Configuration (GC) installation to function properly, these prerequisites need to be present and functioning.

• Jinja2 version 3.1.2

• MarkupSafe version 2.1.2

In addition to these prerequisites, Network Service Orchestrator (NSO) must fit these criteria:

• NSO version 6.1.9 (recommended) must be up and running.

• Make sure that the devices to be configured must be onboarded to NSO.

• The goldenconfig package must be loaded on NSO.

• The required Network Element Drivers (NED) are loaded on NSO.

Note: To use CWM, you must also have additional functionality. See Crosswork Workflow Manager (CWM) Workflows and Deployment.

Templates are rendered using the Jinja2 template engine features to customize the configuration templates with conditionals and advanced features, such as looping, to meet system requirements. The templates provide the flexibility needed when working with a wide variety of network devices.

When you apply a template to a device, you can set the template to Merge (default) or Replace the existing configuration. The Merge setting merges the new configuration along with the existing configuration on the device. The Replace setting replaces the entire existing configuration.

Note: Templates can be applied on only a single device, but not on device groups.

Note: Variables must not be named using the reserved keywords service and/or device. These keywords are auto populated with the current service/device node data.

You configure applications with values that correspond to the variables used in devices. You set the variables in the template either while configuring the variables during template creation (template level) or while creating the application that you associate with the template (application level).

Note: The Golden Configuration application consists of templates with variables and applications with values for the templates.

Note: The application level variable configurations override the template level variable configurations.

After you create a template, you apply that template to a device. This is a sample template applied to a Cisco IOS XR device along with the application payload.

Template Payload

 
    <devices xmlns="http://tail-f.com/ns/ncs">
    <template>
    <name>xr-bgp-template</name>
    <ned-id>
    <id xmlns:cisco-iosxr-cli-7.52="http://tail-f.com/ns/ned-id/cisco-iosxr-cli-7.52">cisco-iosxr-cli-7.52:cisco-iosxr-cli-7.52</id>
    <config>
    <route-policy xmlns="http://tail-f.com/ned/cisco-ios-xr">
    <name>PASS_ALL</name>
    <value>pass</value>
    </route-policy>
    <router xmlns="http://tail-f.com/ned/cisco-ios-xr">
    <bgp>
    <bgp-instance>
    <id>300</id>
    <instance>1</instance>
    <bgp>
    <router-id>4.4.4.4</router-id>
    </bgp>
    <address-family>
    <ipv4>
    <unicast/>
    </ipv4>
    </address-family>
    <neighbor>
    <id>{$NEIGHBOR_IP}</id>
    <remote-as>600</remote-as>
    </neighbor>
    </bgp-instance>
    </bgp>
    </router>
    </config>
    </ned-id>
    </template>
    </devices>

Application Payload

    <golden-config xmlns="http://example.com/golden-config">
    <application>
    <name>dt-bgp-app</name>
    <device>ncs540</device>
    <device-template>xr-bgp-template</device-template>
    <variable>
    <name>NEIGHBOR_IP</name>
    <value>10.10.1.5</value>
    </variable>
    </application>
    </golden-config>

    <config xmlns="http://tail-f.com/ns/config/1.0">
    <golden-config xmlns="http://example.com/golden-config">
    <template>
    <name>xr-native-int</name>
    <version>
    <id>1</id>
    <type>native</type>
    <config>
    interface TenGigE 0/0/0/1
    ipv4 address {{ ADDR }} {{ MASK }}
    </config>
    </version>
    </template>
    </golden-config>
    </config>

This is an example of the Golden Config application payload using the native template.

        <config xmlns="http://tail-f.com/ns/config/1.0">
        <golden-config xmlns="http://example.com/golden-config">
        <application>
        <name>native-xr-app</name>
        <device>ncs540</device>
        <jinja-template>
        <template>xr-native-int</template>
        <version>1</version>
        </jinja-template>
        <variable>
        <name>ADDR</name>
        <value><ip_address></value>
        </variable>
        <variable>
        <name>MASK</name>
        <value><ip_address></value>
        </variable>
        </application>
        </golden-config>
        </config>
    

Use this action to receive a list of templates and their associated versions. The action has an input and output shown here.

Input

leaf-list tag

Output

List of templates
Associated version

Use this sample command script to get a template.

admin@ncs% request golden-config actions get-template tag [ bgp c-style ] template {
name bgp-cstyle
version [ 1 2 ]
}

Use this action to receive a list of applications, their associated devices, and the versions of each application.

Input

leaf jinja-template
leaf version
leaf device template
    

Output

List of applications
Associated device
Associated version

Sample command script to get an application.

admin@ncs% request golden-config actions get-application jinja-template
bgp-cstyle version 1
application {
name xr-bgp
device xr0
version 1
}

Use this action to view the differences that occur due to an update and to obtain the list of updated applications.

Input

leaf jinja-template
leaf version
leaf device-template
leaf application
dry-run/outformat

Output

list of applications
dry-run diff

Sample command script to get an application.

    admin@ncs% request golden-config actions update-application application
    xr-bgp jinja-template bgp-cstyle version 1 dry-run
    result The following application(s) can be re-deployed when
    dry-run input
    is not opted for this action.
    application [ xr-bgp ]
    cli {
    local-node {
    data devices {
    device xr0 {
    config {
    router {
    bgp {
    bgp-no-instance 200 {
    vrf testXR {
    neighbor 10.10.1.2 {
    - remote-as 20;
    + remote-as 40;
    }
    }
    }
    }
    }
    }
    }
    }
    }
    }
    }
    

Result

admin@ncs% request golden-config actions update-application application
xr-bgp jinja-template bgp-cstyle version 1
result The following application(s) are re-deployed.
application [ xr-bgp ]

To use CWM for Golden Configuration (GC) workflows, you need to have this functionality:

• NED packages, goldenconfig package, and required devices loaded in NSO.

• An NSO secret (password) used for REST call authentication with NSO.

• Create and deploy the NSO adapter in CWM.

• Create the NSO as a resource in CWM.

• Golden-config templates must be loaded in the NSO.

When the prerequisites are applied, you can then add the following workflows to CWM and run the required input to use Golden Configuration by CWM.

• create-application.sw.json

• delete-application.sw.json

• remediation-sw.json

This is a sample template workflow.

    admin@ncs% load merge terminal
    <config xmlns="http://tail-f.com/ns/config/1.0">
    <golden-config xmlns="http://example.com/golden-config">
    <template>
    <name>t2</name>
    <version>
    <id>2</id>
    <mode>merge</mode>
    <type>c-style</type>
    <config>ipv4 access-list acl-1
    40 deny tcp any any gt 200
    !
    10 permit icmp any any
    </config>
    <variable>
    <name>mask</name>
    <value><ip_address></value>
    </variable>
    </version>
    </template>
    </golden-config>
    </config>
    Type control + d to leave the terminal session
    [ok][2099-03-22 23:00:02]
    [edit]
    admin@ncs% commit Commit complete.
    [ok][2099-03-22 23:00:04]
    [edit]
    admin@ncs% show golden-config template t2
    version 2 {
    type c-style;
    mode merge;
    config "ipv4 access-list acl-1\n40 deny tcp any any gt 200\n!\n10 permit icmp any any\n ";
    variable mask {
    value <ip_address>;
    }
    }
    [ok][2024-03-22 23:00:17]
    [edit]