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 Gates 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 // .OpenDaylight Architecture
  16 // image:Screenshot6.png[width=500]
  17
  18 // [[dependency-map]]
  19 // === Dependency Map
  20
  21 // .OpenDaylight Dependencies
  22 // image:ODL-Helium-dependency.png[width=500]
  23
  24 [[packetcable-components-qos]]
  25 === Packetcable Components (PCMM QoS Gates)
  26
  27 packetcable is comprised of three OpenDaylight bundles
  28
  29 [options="header"]
  30 |=======================================================================
  31 |Bundle |Description
  32 |packetcable-policy-server |Plugin that provides PCMM model implementation based on CMTS structure and COPS protocol.
  33
  34 |packetcable-policy-model |The Model provided provides a direct mapping to the underlying QoS Gates of CMTS.
  35
  36
  37 |packetcable-driver |The codec for transforming the model into the
  38 appropriate PCMM Gate message for flows and CMTS connections.
  39 |=======================================================================
  40
  41 See
  42 https://git.opendaylight.org/gerrit/gitweb?p=packetcable.git;a=tree;f=packetcable-model/src/main/yang[YANG
  43 Model]
  44
  45 [[features-to-install]]
  46 ==== Features to Install
  47
  48 ---------------------------------------------------------------------------------------------------------------------------
  49 opendaylight-user@root>feature:install odl-restconf odl-l2switch-switch odl-dlux-core odl-mdsal-apidocs odl-packetcable-policy-all
  50 ---------------------------------------------------------------------------------------------------------------------------
  51
  52 [[explore-and-exercise-the-packetcable-rest-api]]
  53 ==== Explore and exercise the PacketCable REST API
  54
  55 http://localhost:8181/apidoc/explorer/index.html
  56
  57 [[Add CMTS]]
  58 === Adding a CMTS to OpenDaylight Inventory
  59
  60 The RESTConf URLs makes it possible to add a CMTS to OpenDaylight and have it connected.
  61
  62 Add a CMTS to OpenDaylight Inventory
  63 image:Screenshot1.png[width=500,title="Add a CMTS to OpenDaylight Inventory"]
  64
  65 [[postman]]
  66 ==== Postman
  67
  68 https://chrome.google.com/webstore/detail/postman-rest-client/fdmmgilgnpjigdojojpjoooidkmcomcm?hl=en[Configure
  69 the Chrome browser]
  70
  71 https://git.opendaylight.org/gerrit/gitweb?p=packetcable.git;a=tree;f=packetcable-client[Download
  72 and import sample packetcable collection]
  73
  74
  75 image:Screenshot5.png[width=500,title="Postman Operations"]
  76