docs/install-guide/federation-install-guide.rst

   1 #########################################
   2 federation-with-rabbit Installation Guide
   3 #########################################
   4
   5 Overview
   6 ========
   7
   8 The federation service is a project that facilitates the exchange of state between multiple
   9 OpenDaylight deployments. Detailed explanation can be found in the developers guide. It comes
  10 as part of the ODL installation package, but not activated by default.
  11
  12 Pre Requisites for Installing federation-with-rabbit
  13 ====================================================
  14
  15 Software Requirements
  16 ---------------------
  17 The federation service which is based on the Rabbit MQ implementation, expects a Rabbit MQ Broker to be installed on a machine that is reachable by the OpenDaylight. If the broker is installed on the same machine as the OpenDaylight, the default user and password can be used (guest/guest). If the broker is installed on a different machine, the broker will deny access for the default user, and a new user needs to created and given permissions.
  18
  19 The creation of the user should happen in the rabbit broker machine. For example:
  20
  21 sudo /usr/sbin/rabbitmqctl add_user newusername newuserpass
  22
  23 sudo rabbitmqctl set_permissions -p / newusername ".*" ".*" ".*"
  24
  25 Preparing for Installation
  26 ==========================
  27
  28 The federation service consists of a default configuration that should be modified in order to enable its functionality, and connect it to the correct rabbit broker. The YANG model that declares the configuration knobs and defaults is defined in federation-service.yang. The configuration that is used to override the defaults is federation-service-config.xml.
  29
  30 Verifying your Installation
  31 ===========================
  32
  33 FederationProducerMgr and FederationConsumerMgr logs prints seems valid and do not indicate an ERROR.