manuals/user-guide/src/main/asciidoc/packetcable/packetcable-user.adoc

   1 [[pcmm-user-guide-preliminary]]
   2 = PCMM User Guide (*Preliminary*)
   3
   4 [[system-overview]]
   5 == System Overview
   6
   7 These components introduce a DOCSIS QoS Service Flow management using
   8 the PCMM protocol. The driver component is responsible for the
   9 PCMM/COPS/PDP functionality required to service requests from
  10 PacketCable Provider and FlowManager. Requests are transposed into PCMM
  11 Gate Control messages and transmitted via COPS to the CMTS. This plugin
  12 adheres to the PCMM/COPS/PDP functionality defined in the CableLabs
  13 specification. PacketCable solution is an MDSAL compliant component.
  14
  15 image:Screenshot6.png[Screenshot6.png,title="Screenshot6.png"]
  16
  17 image:Odp_diagram_helium_v6.jpg[Odp_diagram_helium_v6.jpg,title="Odp_diagram_helium_v6.jpg"]
  18
  19 [[dependency-map]]
  20 == Dependency Map
  21
  22 image:ODL-Helium-dependency.png[ODL-Helium-dependency.png,title="ODL-Helium-dependency.png"]
  23
  24 [[packetcable-components]]
  25 == Packetcable Components
  26
  27 packetcable is comprised of three OpendayLight bundles
  28
  29 [cols=",",options="header",]
  30 |=======================================================================
  31 |Bundle |Description
  32 |packetcable-model |Contains the YANG information model for flows and
  33 nodes
  34
  35 |packetcable-provider |Provider hosts the model processing, RESTCONF,
  36 API implementation, and brokers requests to consumer
  37
  38 |packetcable-consumer |Consumer hosts packet codec and sends requests to
  39 driver
  40
  41 |packetcable-driver |The codec for transforming the model into the
  42 appropriate PCMM Gate message for flows and CMTS connections.
  43 |=======================================================================
  44
  45 See
  46 https://git.opendaylight.org/gerrit/gitweb?p=packetcable.git;a=tree;f=packetcable-model/src/main/yang[YANG
  47 Model]
  48
  49 [[features-to-install]]
  50 === Features to Install
  51
  52 ---------------------------------------------------------------------------------------------------------------------------
  53 opendaylight-user@root>feature:install odl-restconf odl-l2switch-switch odl-dlux-core odl-mdsal-apidocs odl-packetcable-all
  54 ---------------------------------------------------------------------------------------------------------------------------
  55
  56 [[accessing-user-interface-assets]]
  57 == Accessing User Interface Assets
  58
  59 [[management-ui]]
  60 === Management UI
  61
  62 [[install-node.js]]
  63 ==== Install Node.js
  64
  65 Use the following script install_nodejs.sh to guide you through Node.js
  66 installation on Ubuntu.
  67
  68 -------------------------------------------------
  69 #!/bin/sh
  70
  71 sudo apt-get install nodejs nodejs-legacy npm git
  72 sudo npm -g install grunt
  73 sudo npm -g install grunt-cli
  74 sudo npm -g install bower
  75 sudo npm -g install karma
  76 sudo npm -g install karma-cli
  77 -------------------------------------------------
  78
  79 NOTE: Not needed unless running standalone.
  80 https://wiki.opendaylight.org/view/OpenDaylight_dlux:Setup_and_Run[Setup
  81 dLux for Development]
  82
  83 http://localhost:8181/dlux/index.html
  84
  85 user: admin
  86
  87 password: admin
  88
  89 Sign in
  90
  91 image:Screenshot4.png[|Dlux Login,title="|Dlux Login"]
  92
  93 Manage Flows
  94
  95 image:Screenshot3.png[|Dlux Flows,title="|Dlux Flows"]
  96
  97 Manage Nodes
  98
  99 image:Screenshot2.png[|Dlux Nodes,title="|Dlux Nodes"]
 100
 101 [[explore-and-exercise-the-packetcable-rest-api]]
 102 === Explore and exercise the PacketCable REST API
 103
 104 http://localhost:8181/apidoc/explorer/index.html
 105
 106 link:#RESTCONF_API_Explorer[ See Explorer ]
 107
 108 [[Add CMTS]]
 109 == Adding a CMTS to OpenDaylight Inventory
 110
 111 Add a CMTS to Opendaylight Inventory
 112
 113 image:Screenshot1.png[Add CMTS using RESTCONF
 114 Explorer,title="Add CMTS using RESTCONF Explorer"]
 115
 116 [[postman]]
 117 === Postman
 118
 119 https://chrome.google.com/webstore/detail/postman-rest-client/fdmmgilgnpjigdojojpjoooidkmcomcm?hl=en[Configure
 120 the Chrome browser]
 121
 122 https://git.opendaylight.org/gerrit/gitweb?p=packetcable.git;a=tree;f=packetcable-client[Download
 123 and import sample packetcable collection]
 124
 125 image:Screenshot5.png[Postman,title="Postman"]
 126