Migrate PacketCable user docs to rst 51/44351/2
authorColin Dixon <colin@colindixon.com>
Fri, 19 Aug 2016 01:15:26 +0000 (21:15 -0400)
committerColin Dixon <colin@colindixon.com>
Sun, 28 Aug 2016 17:49:02 +0000 (10:49 -0700)
Change-Id: I7b666f1c7a1cfadf6daf61bcea708208170f5d7e
Signed-off-by: Colin Dixon <colin@colindixon.com>
docs/user-guide/images/packetcable-postman.png [new file with mode: 0644]
docs/user-guide/packetcable-user-guide.rst [new file with mode: 0644]
manuals/user-guide/src/main/asciidoc/packetcable/packetcable-user.adoc

diff --git a/docs/user-guide/images/packetcable-postman.png b/docs/user-guide/images/packetcable-postman.png
new file mode 100644 (file)
index 0000000..61b30d6
Binary files /dev/null and b/docs/user-guide/images/packetcable-postman.png differ
diff --git a/docs/user-guide/packetcable-user-guide.rst b/docs/user-guide/packetcable-user-guide.rst
new file mode 100644 (file)
index 0000000..a89d424
--- /dev/null
@@ -0,0 +1,74 @@
+PacketCable User Guide
+======================
+
+Overview
+--------
+
+These components introduce a DOCSIS QoS Gates management using the PCMM
+protocol. The driver component is responsible for the PCMM/COPS/PDP
+functionality required to service requests from PacketCable Provider and
+FlowManager. Requests are transposed into PCMM Gate Control messages and
+transmitted via COPS to the CMTS. This plugin adheres to the
+PCMM/COPS/PDP functionality defined in the CableLabs specification.
+PacketCable solution is an MDSAL compliant component.
+
+PacketCable Components
+----------------------
+
+PacketCable is comprised of two OpenDaylight bundles:
+
++--------------------------------------+--------------------------------------+
+| Bundle                               | Description                          |
++======================================+======================================+
+| odl-packetcable-policy-server        | Plugin that provides PCMM model      |
+|                                      | implementation based on CMTS         |
+|                                      | structure and COPS protocol.         |
++--------------------------------------+--------------------------------------+
+| odl-packetcable-policy-model         | The Model provided provides a direct |
+|                                      | mapping to the underlying QoS Gates  |
+|                                      | of CMTS.                             |
++--------------------------------------+--------------------------------------+
+
+See the PacketCable `YANG
+Models <https://git.opendaylight.org/gerrit/gitweb?p=packetcable.git;a=tree;f=packetcable-policy-model/src/main/yang>`__.
+
+Installing PacketCable
+----------------------
+
+To install PacketCable, run the following ``feature:install`` command
+from the Karaf CLI
+
+::
+
+    feature:install odl-packetcable-policy-server-all odl-restconf odl-mdsal-apidocs
+
+Explore and exercise the PacketCable REST API
+---------------------------------------------
+
+To see the PacketCable APIs, browse to this URL:
+http://localhost:8181/apidoc/explorer/index.html
+
+Replace localhost with the IP address or hostname where OpenDaylight is
+running if you are not running OpenDaylight locally on your machine.
+
+.. note::
+
+    Prior to setting any PCMM gates, a CCAP must first be added.
+
+Postman
+-------
+
+`Install the Chrome
+extension <https://chrome.google.com/webstore/detail/postman-rest-client/fdmmgilgnpjigdojojpjoooidkmcomcm?hl=en>`__
+
+`Download and import sample packetcable
+collection <https://git.opendaylight.org/gerrit/gitweb?p=packetcable.git;a=tree;f=packetcable-policy-server/doc/restconf-samples>`__
+
+Postman Operations
+^^^^^^^^^^^^^^^^^^
+
+.. figure:: ./images/packetcable-postman.png
+   :alt: Postman Operations
+
+   Postman Operations
+
index fbab4369697b8279c2bd9b67c73a66d2845c8429..0e70ace6bb45cea6732c44853e88b59b10537a48 100644 (file)
@@ -1,52 +1,3 @@
 == PacketCable User Guide
 
-=== Overview
-
-These components introduce a DOCSIS QoS Gates management using
-the PCMM protocol. The driver component is responsible for the
-PCMM/COPS/PDP functionality required to service requests from
-PacketCable Provider and FlowManager. Requests are transposed into PCMM
-Gate Control messages and transmitted via COPS to the CMTS. This plugin
-adheres to the PCMM/COPS/PDP functionality defined in the CableLabs
-specification. PacketCable solution is an MDSAL compliant component.
-
-=== PacketCable Components
-
-PacketCable is comprised of two OpenDaylight bundles:
-
-[options="header"]
-|======
-|Bundle |Description
-|odl-packetcable-policy-server | Plugin that provides PCMM model implementation based on CMTS structure and COPS protocol.
-|odl-packetcable-policy-model  | The Model provided provides a direct mapping to the underlying QoS Gates of CMTS.
-|======
-
-See the PacketCable 
-https://git.opendaylight.org/gerrit/gitweb?p=packetcable.git;a=tree;f=packetcable-policy-model/src/main/yang[YANG
-Models].
-
-=== Installing PacketCable
-
-To install PacketCable, run the following `feature:install` command from the Karaf CLI
-
- feature:install odl-packetcable-policy-server-all odl-restconf odl-mdsal-apidocs
-
-=== Explore and exercise the PacketCable REST API
-
-To see the PacketCable APIs, browse to this URL:
-http://localhost:8181/apidoc/explorer/index.html
-
-Replace localhost with the IP address or hostname where OpenDaylight is running if you are not running OpenDaylight locally on your machine.
-
-NOTE: Prior to setting any PCMM gates, a CCAP must first be added. 
-
-=== Postman
-
-https://chrome.google.com/webstore/detail/postman-rest-client/fdmmgilgnpjigdojojpjoooidkmcomcm?hl=en[Install
-the Chrome extension]
-
-https://git.opendaylight.org/gerrit/gitweb?p=packetcable.git;a=tree;f=packetcable-policy-server/doc/restconf-samples[Download
-and import sample packetcable collection]
-
-.Postman Operations
-image::Screenshot5.png[width=500]
+This content has been migrated to: http://docs.opendaylight.org/en/stable-boron/user-guide/packetcable-user-guide.html