Updated git submodules
[docs.git] / docs / getting-started-guide / project-release-notes / federation.rst
1 ==========\r
2 Federation\r
3 ==========\r
4 \r
5 Major Features\r
6 ==============\r
7 \r
8 federation-with-rabbit\r
9 ----------------------\r
10 \r
11 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=federation.git;a=blob;f=features/features-federation/src/main/features/features.xml\r
12 * **Feature Description:**  The federation service is a project that\r
13   facilitates the exchange of state between multiple OpenDaylight\r
14   deployments (henceforth 'sites'). These sites may be single node\r
15   deployments or cluster deployments. The 'federation-with-rabbit'\r
16   feature is a specific implementation of the federation service, based\r
17   on Rabbit MQ broker. Federation service currently only supports the\r
18   Rabbit MQ implementation.\r
19 * **Top Level:** Yes\r
20 * **User Facing:** Yes\r
21 * **Experimental:** Yes\r
22 * **CSIT Test:** No (tested via NetVirt CSIT)\r
23 \r
24 Documentation\r
25 =============\r
26 \r
27 Please provide the URL to each document at docs.opendaylight.org. If\r
28 the document is under review, provide a link to the change in Gerrit.\r
29 \r
30 * **Installation Guide(s):**\r
31 \r
32   * :doc:`../../submodules/federation/docs/install-guide/federation-install-guide`\r
33 \r
34 * **Developer Guide(s):**\r
35 \r
36   * :doc:`../../submodules/federation/docs/developer-guide/federation-developer-guide`\r
37 \r
38 Security Considerations\r
39 =======================\r
40 \r
41 * No dedicated port numbers are used.\r
42 * Securing of RabbitMQ is beyond the scope of this project but it is\r
43   suggested that standard RabbitMQ security procedures are applied.\r
44 \r
45 Quality Assurance\r
46 =================\r
47 \r
48 * This project was not independently tested. Rather it was tested\r
49   indirectly by means of the NetVirt Federation Plugin.\r
50 \r
51 Migration\r
52 ---------\r
53 \r
54 * Not applicable. Federation is a new project released in the Carbon\r
55   release for the first time.\r
56 \r
57 Compatibility\r
58 -------------\r
59 \r
60 * Not applicable. Federation is a new project released in the Carbon\r
61   release for the first time.\r
62 \r
63 Bugs Fixed\r
64 ----------\r
65 \r
66 * Not applicable. Federation is a new project released in the Carbon\r
67   release for the first time.\r
68 \r
69 Known Issues\r
70 ------------\r
71 \r
72 * There are no known issues with respect of the usage flow tested via\r
73   the NetVirt Federation Plugin\r
74 \r
75 End-of-life\r
76 ===========\r
77 \r
78 * Not applicable. Federation is a new project released in the Carbon\r
79   release for the first time.\r
80 \r
81 Standards\r
82 =========\r
83 \r
84 * Not applicable\r
85 \r
86 Release Mechanics\r
87 =================\r
88 \r
89 * https://wiki.opendaylight.org/view/Federation:Carbon_Release_Plan\r