Merge "Release Notes for Packetcable Carbon release"
[docs.git] / docs / getting-started-guide / project-release-notes / packetcable.rst
1 ===========
2 PacketCable
3 ===========
4
5 Major Features
6 ==============
7
8 odl-packetcable-policy-server
9 -----------------------------
10
11 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=packetcable.git;a=blob;f=features-packetcable-policy/features-packetcable-policy/src/main/features/features.xml;hb=refs/heads/stable/carbon
12 * **Feature Description:** Plugin that provides PCMM model implementation based
13   on CMTS structure and COPS protocol and provides the implementation of
14   `RFC 2748 <https://tools.ietf.org/html/rfc2748>`_.
15 * **Top Level:** Yes
16 * **User Facing:** Yes
17 * **Experimental:** No
18 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/packetcable/job/packetcable-csit-1node-pcmm-all-carbon/
19
20 Documentation
21 =============
22
23 * **User Guide(s):**
24
25   * :ref:`packetcable-user-guide`
26
27 * **Developer Guide(s):**
28
29   * :ref:`packetcable-dev-guide`
30
31 Security Considerations
32 =======================
33
34 * Do you have any external interfaces other than RESTCONF? No.
35
36 * The PacketCable project talks to southbound devices using the COPS protocol.
37   Securing this communication is outslide the scope of this project.
38
39
40 Quality Assurance
41 =================
42
43 * `Link to Sonar Report <https://jenkins.opendaylight.org/releng/view/packetcable/job/packetcable-sonar>`_ ( Test coverage percent - 53.21% )
44 * Link to CSIT Jobs:
45
46   * https://jenkins.opendaylight.org/releng/view/packetcable/job/packetcable-csit-1node-pcmm-only-carbon
47   * https://jenkins.opendaylight.org/releng/view/packetcable/job/packetcable-csit-1node-pcmm-all-carbon
48
49 * Other manual testing and QA information - While the CSIT jobs run the
50   PacketCable plugin against a simple "emulated" instance of a CMTS network
51   device, the code is frequently tested during the development cycle against
52   actual CMTS devices.
53 * Testing methodology. There is substantial unit testing associated with the
54   project build process and CSIT testing is executed against an "emulated" CMTS
55   device.  All product APIs are validated during the development cycle but CSIT
56   testing has not been upgraded to cover some of the most recent feature
57   additions that are incorporated in the Carbon release.
58
59 Migration
60 ---------
61
62 * Is is possible migrate from the previous release?  Yes
63 * Migration from PacketCable Boron version to Carbon version can be
64   accomplished by replacement of the PacketCable plugin components.
65
66   * Any data stored in COPS models will need to be manually copied over.
67
68 * All previous API calls will work with the new release.
69
70 Compatibility
71 -------------
72
73 * Is this release compatible with the previous release?  Yes
74 * Any API changes?  No
75 * Any configuration changes?  No
76
77 Bugs Fixed
78 ----------
79
80 * List of Bugzilla bugs fixed since the previous release
81 * `6302 <https://bugs.opendaylight.org/show_bug.cgi?id=6302>`_
82 * `6762 <https://bugs.opendaylight.org/show_bug.cgi?id=6762>`_
83 * `6763 <https://bugs.opendaylight.org/show_bug.cgi?id=6763>`_
84 * `7108 <https://bugs.opendaylight.org/show_bug.cgi?id=7108>`_
85 * `7109 <https://bugs.opendaylight.org/show_bug.cgi?id=7109>`_
86 * `7110 <https://bugs.opendaylight.org/show_bug.cgi?id=7110>`_
87 * `7111 <https://bugs.opendaylight.org/show_bug.cgi?id=7111>`_
88 * `7112 <https://bugs.opendaylight.org/show_bug.cgi?id=7112>`_
89 * `7113 <https://bugs.opendaylight.org/show_bug.cgi?id=7113>`_
90 * `7114 <https://bugs.opendaylight.org/show_bug.cgi?id=7114>`_
91 * `7115 <https://bugs.opendaylight.org/show_bug.cgi?id=7115>`_
92 * `7636 <https://bugs.opendaylight.org/show_bug.cgi?id=7636>`_
93
94 Known Issues
95 ------------
96
97 * There are no known issues with the Carbon release of PacketCable
98
99 End-of-life
100 ===========
101
102 * No PacketCable features or APIs are EOLed, deprecated, or removed in this
103   release
104
105 Standards
106 =========
107
108 * CableLabs "PacketCable 1.5 Specification: MTA Device Provisioning"
109   PKT-SP-PROV1.5-I04-090624
110   The Packetcable plug-in implements a subset of the provisioning operations
111   defined in this specification.
112
113 Release Mechanics
114 =================
115
116 * `Link to release plan <https://wiki.opendaylight.org/view/PacketCablePCMM:Release_Plan_Carbon>`_
117 * There were no major shifts in release schedule from the release plan