Bump config to Scandium
[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/features4-packetcable-policy/pom.xml;h=0945b9287711a1ce9a7bd6cc0b457607a3cd6248;hb=refs/heads/stable/nitrogen
12 * **Feature Description:** Plugin that provides a PCMM model implementation
13   based on CMTS structure and COPS protocol.  It implements
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-nitrogen/
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 interfaces to southbound devices using the
37   COPS protocol.  Securing communication on this interface is outslide
38   the scope of this project.
39
40
41 Quality Assurance
42 =================
43
44 * `Link to Sonar Report <https://jenkins.opendaylight.org/releng/view/packetcable/job/packetcable-sonar>`_ ( Test coverage percent - 53.41% )
45
46 * Link to CSIT Job:
47 * https://jenkins.opendaylight.org/releng/view/packetcable/job/packetcable-csit-1node-pcmm-all-nitrogen/
48
49 * Other manual testing and QA information - The CSIT job runs the
50   PacketCable plugin in a simple cable access controller emulation
51   environment. The code is manually tested during the development
52   cycle with an actual (controller).
53
54 * Testing methodology. There is substantial unit testing executed in
55   the project build process; CSIT testing is executed in an "emulated"
56   cable access network environment.  All product APIs are validated
57   during the development cycle.  CSIT testing would benefit from an
58   upgrade to cover some of the post-Carbon feature additions.
59
60 Migration
61 ---------
62
63 * Is it possible to migrate from the previous release?  Yes
64   Migration from PacketCable Carbon version to the Nitrogen version is
65   accomplished by replacement of the PacketCable plugin components.
66
67 * Any data stored in COPS models will need to be manually replicated.
68
69 * All previous API calls will work with the new release.
70
71 Compatibility
72 -------------
73
74 * Is this release compatible with the previous release?  Yes
75 * Any API changes?  No
76 * Any configuration changes?  No
77
78 Bugs Fixed
79 ----------
80
81 * List of Bugzilla bugs fixed since the previous release
82   NONE
83 * The only functional change for the Nitrogen release of Packetcable
84   is the upgrade from Karaf3 to Karaf4.
85
86  Known Issues
87 -------------
88
89 * There are no known issues with the Carbon release of PacketCable
90
91 End-of-life
92 ===========
93
94 * No PacketCable features or APIs are EOLed, deprecated, or removed
95   in this release
96
97 Standards
98 =========
99
100 * The Packetcable plug-in implements a subset of the provisioning operations
101   defined in these specifications.
102
103 * CableLabs "PacketCable 1.5 Specification: MTA Device Provisioning"
104   PKT-SP-PROV1.5-I04-090624
105
106 * COPS protocol
107   RFC 2748 <https://tools.ietf.org/html/rfc2748>
108
109 Release Mechanics
110 =================
111
112 * Link to Packetcable Nitrogen release plan:
113   <https://wiki.opendaylight.org/view/PacketCablePCMM:Release_Plan_Nitrogen>
114 * There were no major shifts in release schedule from the release plan