docs/user-guide/packetcable-user-guide.rst

   1 PacketCable User Guide
   2 ======================
   3
   4 Overview
   5 --------
   6
   7 These components introduce a DOCSIS QoS Gates management using the PCMM
   8 protocol. The driver component is responsible for the PCMM/COPS/PDP
   9 functionality required to service requests from PacketCable Provider and
  10 FlowManager. Requests are transposed into PCMM Gate Control messages and
  11 transmitted via COPS to the CMTS. This plugin adheres to the
  12 PCMM/COPS/PDP functionality defined in the CableLabs specification.
  13 PacketCable solution is an MDSAL compliant component.
  14
  15 PacketCable Components
  16 ----------------------
  17
  18 PacketCable is comprised of two OpenDaylight bundles:
  19
  20 +--------------------------------------+--------------------------------------+
  21 | Bundle                               | Description                          |
  22 +======================================+======================================+
  23 | odl-packetcable-policy-server        | Plugin that provides PCMM model      |
  24 |                                      | implementation based on CMTS         |
  25 |                                      | structure and COPS protocol.         |
  26 +--------------------------------------+--------------------------------------+
  27 | odl-packetcable-policy-model         | The Model provided provides a direct |
  28 |                                      | mapping to the underlying QoS Gates  |
  29 |                                      | of CMTS.                             |
  30 +--------------------------------------+--------------------------------------+
  31
  32 See the PacketCable `YANG
  33 Models <https://git.opendaylight.org/gerrit/gitweb?p=packetcable.git;a=tree;f=packetcable-policy-model/src/main/yang>`__.
  34
  35 Installing PacketCable
  36 ----------------------
  37
  38 To install PacketCable, run the following ``feature:install`` command
  39 from the Karaf CLI
  40
  41 ::
  42
  43     feature:install odl-packetcable-policy-server-all odl-restconf odl-mdsal-apidocs
  44
  45 Explore and exercise the PacketCable REST API
  46 ---------------------------------------------
  47
  48 To see the PacketCable APIs, browse to this URL:
  49 http://localhost:8181/apidoc/explorer/index.html
  50
  51 Replace localhost with the IP address or hostname where OpenDaylight is
  52 running if you are not running OpenDaylight locally on your machine.
  53
  54 .. note::
  55
  56     Prior to setting any PCMM gates, a CCAP must first be added.
  57
  58 Postman
  59 -------
  60
  61 `Install the Chrome
  62 extension <https://chrome.google.com/webstore/detail/postman-rest-client/fdmmgilgnpjigdojojpjoooidkmcomcm?hl=en>`__
  63
  64 `Download and import sample packetcable
  65 collection <https://git.opendaylight.org/gerrit/gitweb?p=packetcable.git;a=tree;f=packetcable-policy-server/doc/restconf-samples>`__
  66
  67 Postman Operations
  68 ^^^^^^^^^^^^^^^^^^
  69
  70 .. figure:: ./images/packetcable-postman.png
  71    :alt: Postman Operations
  72
  73    Postman Operations
  74