docs/release-notes/projects/federation.rst

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