Honeycomb/VBD release notes.
[docs.git] / docs / getting-started-guide / project-release-notes / alto.rst
1 =============================================
2 Application-Layer Traffic Optimization (ALTO)
3 =============================================
4
5 odl-alto-release
6 ----------------
7
8 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=alto.git;a=blob;f=alto-release-features/features-alto/src/main/features/features.xml
9 * **Feature Description:**  This is a summary feature containing the default
10   functionalities provided by ALTO project.
11 * **Top Level:** Yes
12 * **User Facing:** Yes
13 * **Experimental:** Yes
14 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/alto/job/alto-csit-1node-setup-all-carbon/
15
16 Documentation
17 =============
18
19 * **User Guide(s):**
20
21   * :ref:`ALTO User Guide <alto-user-guide>`
22
23 * **Developer Guide(s):**
24
25   * :ref:`ALTO Developer Guide <alto-developer-guide>`
26
27 Security Considerations
28 =======================
29
30 Besides RESTCONF, ALTO also uses customized Jetty interfaces because YANG model
31 is not compatible with formats specified in RFC 7285.
32
33 The customized interfaces use port 8080 and are NOT protected by the AAA
34 project. All resources exposed by customized interfaces are read-only.
35
36 Quality Assurance
37 =================
38
39 * `Link to Sonar Report <https://sonar.opendaylight.org/overview?id=50636>`_ 22.0%
40 * `Link to CSIT Jobs <https://jenkins.opendaylight.org/releng/view/alto/job/alto-csit-1node-setup-all-carbon/>`_
41 * The tests are using the OpenDaylight CSIT infrastructure.
42
43   * How extensive was it? Not very extensive since the tests are customized to
44     test certain functionalities.
45   * What should be expected to work? The core modules (northbound and
46     resourcepool) and also some basic components (simple-ird)
47   * What has not be tested as much? Some basic components (simple-ecs and spce)
48     and extended components (multicost, incremental update and RSA service).
49
50 Migration
51 ---------
52
53 Migration with data from Boron to Carbon isn't supported.
54
55 Compatibility
56 -------------
57
58 This release is not compatible with the previous release from the developer's
59 point of view because we have changed the namespaces for most YANG models, which
60 involves both API changes and configuration changes (blueprint configuration
61 files).
62
63 Java projects using the ALTO classes generated by yangtools MUST change the
64 packages for the classes because of the namespace migration. The incompatibility
65 can be fixed using regex replacement.
66
67 Projects using RESTCONF or the customized ALTO service do not need to migrate.
68
69 Since ALTO is migrating services to Blueprint, services depending on ALTO may
70 also need to migrate to Blueprint instead of using CONFIG subsystem.
71
72 Bugs Fixed
73 ----------
74
75 No bug is fixed in this release.
76
77 Known Issues
78 ------------
79
80 * `Bug 5753 <https://bugs.opendaylight.org/show_bug.cgi?id=5753>`_
81
82 Both Jersey 1.0 and 2.0 are imported in karaf.
83
84 This seems like a general bug which resides in several projects.
85
86 End-of-life
87 ===========
88
89 * Namespaces:
90
91   * urn:opendaylight:alto:core
92   * urn:opendaylight:alto:basic
93
94 * Packages:
95
96   * org.opendaylight.yang.gen.v1.urn.opendaylight.alto.core.*
97   * org.opendaylight.yang.gen.v1.urn.opendaylight.alto.basic.*
98
99 Standards
100 =========
101
102 * ALTO protocols are not compatible with YANG model
103 * Message types for RFC 7285 have been implemented
104 * ALTO project provides several basic services in RFC 7285
105 * Work-in-progress Internet drafts for multi-cost, incremental updates and RSA
106   service are also scheduled but not fully implemented.
107
108 Release Mechanics
109 =================
110
111 * `Link to release plan <https://wiki.opendaylight.org/view/ALTO:Carbon_Release_Plan>`_
112 * Major shifts:
113
114   * Unable to finish the extensions (multi-cost, incremental update and RSA service)
115   * Unable to reach the goal of improving code quality