Pan-Net Backbone Automation
Tool 1.0: User Guide
1 Table of Contents
Pan-Net Backbone Automation ... 1
Tool 1.0: User Guide ... 1
2 Introduction ... 3
2.1 Purpose ... 3
2.2 Process Description ... 3
2.3 PNBA High Level Architecture ... 3
2.3.1 Software packages used for PNBA environment ... 4
2.4 Audience ... 4
2.5 Assumptions ... 4
3 Usage Pre-requisites ... 4
3.1 PNBA environment setup ... 4
4 User Guide ... 4
4.1 Authentication and authorization ... 4
4.1.1 Adding a new group in PNBA portal ... 5
4.1.2 Adding a new user in PNBA portal ... 8
4.2 Configmanagement ... 10
4.2.1 Adding a new Natco in PNBA portal ... 10
4.2.2 Adding new Site properties in PNBA portal ... 11
4.3 Configmanagement ... 12
4.3.1 Create a new ‘Internet Generic VPN’ service. ... 12
Version Control: Date PNBA Version Description 03/22/18 1.0 Initial Version 2 Introduction 2.1 Purpose
This user guide defines the usage instructions for Pan-Net Backbone Automation (PNBA) Tool. It may be noted that this document is a working document and is kept in sync with the actual product as it evolves.
2.2 Process Description
The main feature for PNBA 1.0.0 is the support for Internet (“Generic VPN)” provisioning and deletion for Pan-Net Service Provisioning team.
First step is the input, which takes the input values from the Pan-Net Service Provisioning Engineer against a selected Natco and set of selected routers for the Natco and translates this internally to a router specific configuration file. In Step 2, an Approver from a pre-defined Approvers group checks and approves the changes. In Step 3, the Pan-Net Service Provisioning Engineer who had initiated the process proceeds and triggers a workflow which deploys the approved configuration to the router. In Step 4, the Pan-Net Service Provisioning Engineer can view the result of the deployment – success or failure, and the changes made on the routers.
2.3 PNBA High Level Architecture
The PNBA is a web based system that is used for Automated Configuration Management and provisioning of Services in both lab and production environment. The tool is developed on Viewflow framework and is integrated with Sqlite database for storage and Ansible for NETCONF connectivity towards the routers.
The PNBA application is released through Gitlab repository.
PNBA tool will have three different user categories – Admin user, non-Admin users and users in Approvers group each with different permissions. The non-Admin users will have permission to request addition/deletion of Service. The Admin user for the tool will have additional permissions to add/delete/modify configuration management inventory data and add/delete/modify users/groups. There will be a separate Approvers group consisting of users with permission to approve change requests.
2.3.1 Software packages used for PNBA environment ▪ Ansible (2.4.3.0) ▪ Django (2.0.1) ▪ Django-material (1.2.2) ▪ Django-viewflow (1.2.0) ▪ Jinja2 (2.10) ▪ Junos-eznc (2.1.7) ▪ Jxmlease (1.0.1) ▪ Python (3.6.0) ▪ Pyyaml (3.12) 2.4 Audience
This user guide is a guideline document for
▪ The Pan-Net Service Provisioning Engineer ▪ The Pan-Net Backbone Automation Tool Admin
2.5 Assumptions
Environment has been setup, PNBA tool installed and all components are up and running User has been given access to the portal by Admin user, Approver group has been created and Approvers has been assigned to Approvers group by Admin user.
3 Usage Pre-requisites
3.1 PNBA environment setup
Ansible 2.4.3.0 should be installed and Ansible environment setup script should be run before starting the PNBA tool.
4 User Guide
There is currently one level of authentication for the PNBA tool, through username and password stored in the database.
4.1 Authentication and authorization
PNBA 1.0.0 should have the below groups:
Groups Description
Admin Administrator rights. Access to configuration management and user management
Approvers Approvers for service provisioning
4.1.1 Adding a new group in PNBA portal
User belonging to ‘Admin’ group has permissions to add, delete and modify users in PNBA portal. To add a new group in PNBA portal:
1. Login to the portal as Admin user:
3. Click on ‘Add’ corresponding to ‘Groups’ under Authentication and Authorization tab.
4. Enter a group name. Select the appropriate permissions and add them to the group and click on ‘Save’. A group named ‘Approvers’ must be created before proceeding to service provisioning tasks. The
4.1.2 Adding a new user in PNBA portal
To add a new user in PNBA portal:
1. Login as Admin user. Click on ‘Add’ corresponding to ‘Users’ under Authentication and Authorization tab.
3. Fill in the user details.
4. Give appropriate permissions to the user and add the user to required groups and click Save. For a user for ‘Administrator’ group ‘Staff status’ must be checked for the user to have access to the admin page.
5. Group permissions will automatically be applicable if the user is added to a group. If required add additional specific permissions to the user. Click on ‘Save’.
4.2 Configmanagement
4.2.1 Adding a new Natco in PNBA portal
1. Login as a user with Admin user. Click on ‘Add’ corresponding to ‘Natco’ under ‘Configmanagement’ section.
2. Enter the details of the Natco. Click on ‘+’ signs to add R2 and DCR routers for the Natco. Enter details of the routers and optionally check the corresponding box to denote. Click on Save.
4.2.2 Adding new Site properties in PNBA portal
1. Login as a user with ‘Staff status’ and permissions for ‘Configmanagement’. Click on ‘Add’
corresponding to ‘Site properties under ‘Configmanagement’ section. This is the location to store all common properties for the site.
2. Enter common credentials for the routers. Click on Save.
4.3 Configmanagement
4.3.1 Create a new ‘Internet Generic VPN’ service.
1. Login as Pan-Net Service Provisioning Engineer. Click on Workflow and click on the ‘+’ button in the bottom right corner.
3. Enter a unique name for the L3VPN to be provisioned, and a description for the same. This name will later be used to identify the L3VPN and delete it. Choose a Natco from the dropdown. Click on ‘Start and continue’ to go to the next step or click on ‘Start’ to complete the current step and come back to the next step later.
4. Select one or more of the routers under the selected Natco to configure. Click on ‘Done and continue’ to go to the next step or ‘Done’ to complete the current step and come back to the next step later.
5. Fill out the forms for each of the router selected. Click on Done and continue to proceed to next form.
7. Check the configurations created for each router.
8. Select an approver from the Approvers group. The configuration will go to the selected user for approval. Click Done and continue to proceed.
9. The task will now be assigned to the Approver.
10. The Approver-user logs in. Pending approvals are visible. Click on the task Approve config to proceed.
12. Check the box ‘Approved’ and click on Done and continue to approve. To reject do not check the ‘Approved’ box and proceed
13. Check that the approval is done, and now the task is assigned to the user who had initiated the workflow once again.
14. Pan-Net Service Provisioning Engineer logs in once again. User can see the next task assigned to him. Click on Push config to proceed.
15. View the configuration about to be pushed one final time and click on Done and continue to proceed. This will establish a NETCONF connection to the routers and attempt to push the configuration files.
16. Check the result of deployment. ‘Success’ will be displayed along with the changes done if deployment passes. ‘Failed’ will be displayed along with the error messages if deployment fails.
17. Click on Done to end the workflow.
4.3.2 Delete an existing ‘Internet Generic VPN’ service.
1. Login as Pan-Net Service Provisioning Engineer. Click on Workflow and then ‘+’ in the bottom right corner to start the deletion process.
2. Click on Delete service.
4. View the configuration that will be deleted.
6. Check that the task has been assigned to Approver.
7. Approver logs in. The task is visible in the Workflow list. Click on Approve Delete to proceed.
9. View the configuration that will be deleted and check the ‘Approved’ box to approve. To reject uncheck the box. Click on Done and Continue to proceed.
10. Check that Approval is done and next task is assigned to the Engineer once again.
11. The Engineer user logs in again. Delete task is visible on his workflow list. Click on ‘Delete View Form Again’
12. View the configuration about to be deleted and click on Done and Continue to proceed.
13. Re confirm deletion. Click on Yes to delete.
