Upload a Customized Service Design
Uploading a customized service design is a beta feature in this release.
To create and customize a service design, you must contact Juniper
Networks Professional Services. The Juniper Networks Professional Services team
provides you with a customized service design file in the .tgz format.
Additionally, they will also provide you with common.tgz and
network-resource.tgz files with corresponding configurations that map
with the customized service design.
To upload the customized service design to the GUI (Orchestration > Service > Service Catalog), perform the following steps:
Log in to the Paragon Shell CLI as the root user.
Type
exitto exit Paragon Shell to the Linux root shell.Start a cMGD pod using the following command:
root@node:~# kubectl -n foghorn scale --replicas=1 deployments/cmgd deployment.apps/cmgd scaled
Launch the service orchestration cMGD CLI bash shell using the following command:
root@node:~# kubectl -n foghorn exec -it -c cmgd deployment/cmgd -- bash root@cmgd-6866d5d9c9-4bwsr>
You are now logged in to the service orchestration cMGD CLI bash shell.
Copy the customized service design
.tgz,common.tgz, andnetwork-resource.tgzfiles to the service orchestration cMGD CLI. For instance in this example, we have copied the customized service designCSD.tgz,common.tgzandnetwork-resource.tgzfiles to the/data-models/projectsfolder. Here,CSD.tgzis the customized service design file andcommon.tgzandnetwork-resource.tgzare the dependency files.Type
cliand press Enter to launch the CLI mode.View organizations available in Routing Director to add the customized service design.
root@cmgd-6866d5d9c9-4bwsr> show paragon orgs Org-Name Org-ID SD-test cd71dd08-72bb-4697-b516-655de87f69c6
Where:
Org-Nameis the name of the organization created in Routing Director.Org-IDis the unique auto-generated alphanumeric ID assigned to the organization.Enter the configuration mode.
root@cmgd-6866d5d9c9-4bwsr> configure Entering configuration mode [edit]
Configure the organization ID to set the context of all tasks required to add the customized service design.
root@cmgd-6866d5d9c9-4bwsr# set foghorn:core org-id cd71dd08-72bb-4697-b516-655de87f69c6 [edit]
Where:
cd71dd08-72bb-4697-b516-655de87f69c6is the unique Org-ID.Commit the changes and exit the configuration mode.
root@cmgd-6866d5d9c9-4bwsr# commit and-quit commit complete Exiting configuration mode
Add projects to the service catalog for all organizations. Projects contain a service design and its dependency files required to provision a service.
Add common files to the service catalog. Common files are reusable components required by multiple service designs.
root@cmgd-6866d5d9c9-4bwsr> request service catalog project add /data-models/projects/common.tgz
Where
common.tgzfile contains common files that includes standard YANG models, Jinja templates, third-party schemas, shared JQS, party files, standard ITEF templates, YANG models, and so on.Add network resource configuration files to the service catalog. The network resource file contains network resource service designs that acts as producers of shared resources and are consumed by service designs.
root@cmgd-6866d5d9c9-4bwsr> request service catalog project add /data-models/projects/network-resource.tgz
Where
network-resource.tgzfile contains definitions of network elements such as IP address pools, VLAN IDs, VPN route distinguishers, and so on.Add your customized service design
CSD.tgz,common.tgz, andnetwork-resource.tgzto the service catalog.root@cmgd-6866d5d9c9-4bwsr> request service catalog project add /data-models/projects/CSD.tgz
root@cmgd-6866d5d9c9-4bwsr> request service catalog project add /data-models/projects/common.tgz
root@cmgd-6866d5d9c9-4bwsr> request service catalog project add /data-models/projects/network-resource.tgz
Verify the projects that you added to the service catalog using the following command:
root@cmgd-6866d5d9c9-4bwsr> show service catalog projects Project Name Project ID common 1670dc07-c891-4031-a15c-2885939f75c7 DesignID: iana Version: 0.1.1 DesignID: ietf Version: 0.1.1 DesignID: ietf-draft Version: 0.1.1 DesignID: juniper Version: 0.1.1 network-resource d090c91c-3163-4b3d-ba43-cba9b824a0e9 DesignID: network-design Version: 0.1.9 DesignID: l2-addr Version: 0.1.5 DesignID: l3-addr Version: 0.2.6 DesignID: routing Version: 0.1.9 DesignID: topo Version: 0.6.25 DesignID: vpn-resources Version: 0.3.5 CSD e5c6a17f-7b24-4136-908a-145e80b9d898 DesignID: csd Version: 0.0.1 <Output Snipped>Where:
Project Namedisplays the names of projects that you added to the service catalog.Project IDdisplays the unique ID assigned to different projects available in the service catalog.(Optional) Log in to the Routing Director GUI and navigate to the Service Designs page (Orchestration > Service Catalog). The newly added service design version 0.0.1 must be listed in the Pending Version column.
Install all the files that you added to the service catalog using the following command:
root@cmgd-6866d5d9c9-4bwsr> request service project add common_1670dc07-c891-4031-a15c-2885939f75c7
root@cmgd-6866d5d9c9-4bwsr> request service project add network-resource_d090c91c-3163-4b3d-ba43-cba9b824a0e9
root@cmgd-6866d5d9c9-4bwsr> request service project add CSD_e5c6a17f-7b24-4136-908a-145e80b9d898
This command takes sometime to complete.
A warning message confirms a successful update. Restart the CLI to complete installation of the new version. Confirm Yes, when prompted.
root@cmgd-6866d5d9c9-4bwsr> request service project add CSD_e5c6a17f-7b24-4136-908a-145e80b9d898 root@cmgd-6866d5d9c9-4bwsr> WARNING: cli has been replaced by an updated version: CLI release 20240313.184005_ningarajs.r1408131 built by ningarajs on 2024-03-13 19:02:49 UTC Restart cli using the new version ? [yes,no] (yes) yes Restarting cli ... root@cmgd-6866d5d9c9-4bwsr>
Now the customized service design is installed and must be available in the GUI. Log in again to the Routing Director GUI and the newly installed service design version 0.0.1 must be listed as Default under the Version column on the Service Designs page (Orchestration > Service Catalog). For more information, see About the Service Designs Page.
You can create and provision a service based on the service design that you added. The Add drop-down on the Service Instances page (Orchestration > Service Instances) displays the name of the service design that you installed. Select the service design to create a corresponding service instance. For more information, see About the Service Instances Page.