summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/Filter/Filter.rst591
-rw-r--r--docs/Filter/images/image1.pngbin107880 -> 0 bytes
-rw-r--r--docs/Filter/images/image2.pngbin159561 -> 0 bytes
-rw-r--r--docs/Installation/Installation.rst24
-rw-r--r--docs/administration/administration.rst14
-rw-r--r--docs/architecture/architecture.rst28
-rw-r--r--docs/configuration/configuration.rst10
-rw-r--r--docs/consumedapis/consumedapis.rst8
-rw-r--r--docs/delivery/delivery.rst34
-rw-r--r--docs/humaninterfaces/humaninterfaces.rst9
-rw-r--r--docs/index.rst18
-rw-r--r--docs/logging/logging.rst52
-rw-r--r--docs/message-router/image1.pngbin38995 -> 0 bytes
-rw-r--r--docs/offeredapis/offeredapis.rst (renamed from docs/message-router/message-router.rst)24
-rw-r--r--docs/release-notes/release-notes.rst (renamed from docs/release-notes.rst)48
15 files changed, 222 insertions, 638 deletions
diff --git a/docs/Filter/Filter.rst b/docs/Filter/Filter.rst
deleted file mode 100644
index 38d8dde..0000000
--- a/docs/Filter/Filter.rst
+++ /dev/null
@@ -1,591 +0,0 @@
-=======
-Filter
-=======
-
-A filter examine an event and decides if it matches or doesn't. Filters
-are mainly used in rules to decide if the processing entries should be
-executed on the given event. They're also used for settings, and systems
-like the Graph Correlator re-use Highland Park's filter mechanism to
-specify which alarms fit in a correlation. Some publishers may produce
-topics with a lot of volume and a subscriber may want only a portion of
-those messages. The subscriber can certainly filter messages after
-receiving them, but it may be substantially more efficient to ask the
-API server to filter the messages before sending them to the
-subscriber.The standard library includes a number of simple filters. The
-Equals filter, for example, compares a field's value with some other
-value and returns true if the values match. The standard library also
-includes filter classes called And, Or, and Not, so you can compose more
-complex filters. For example, written in the standard JSON config
-format:
-
-+-----------------------------------------+
-| "filter":{ |
-| "class":"And", |
-| "filters": |
-| [ |
-| { "class":"Equals", "foo":"abc" }, |
-| { "class":"Assigned", "field":"bar" } |
-| ] |
-| } |
-+-----------------------------------------+
-
-- This filter matches events in which the field "foo" has value "abc"
- and the field "bar" is assigned to some value (as opposed to not being
- present on the event). Filters are used by the consumers to filter out
- data and consume only specific set of data which matches the
- conditions mentioned in filter. Filters can be passed as a query
- parameter by the consumer in consume request as mentioned below:
- **http://localhost:8080/DMaaP/dmaaprest/events/DMaaP/consumergroup/mHOeNFY4XiWx4CBa?filter=\\{"class":"Equals",
- "field":"email", "value":"test@abc.com" }**
-- Filters can be applied only on data in JSON format i.e. if applied,
- filters will automatically ignore any non-json data. While consuming,
- request CONTENT\_TYPE is not relevant to filter.
-
-All the supported filter can be found below.
-
-Types of Filters
-----------------
-
-- DMaaP Message Router supports all the filters which were supported by
- DMaaP Message Router and are mentioned below:-
-- **All Alarms:**
- - Match all alarms.
-- **And:**
- - Create a set of filters. This filter matches when all of them matches.
-
-+-------------+--------------------+------------+---------------------+
-| **Field** | **Description** | **Type** | **Notes** |
-+=============+====================+============+=====================+
-| filters | Combined Filters | LIST | A list of filters |
-+-------------+--------------------+------------+---------------------+
-| | | | |
-+-------------+--------------------+------------+---------------------+
-
-- **Assigned:**
- - Choose a field from the event to check for assignment. This filter
- matches when the field is assigned.
-
-+-------------------+--------------------------------------------------------+------------+-----------------+
-| **Field** | **Description** | **Type** | **Notes** |
-+===================+========================================================+============+=================+
-| field | The field to check for on the event. | STRING | A field name |
-+-------------------+--------------------------------------------------------+------------+-----------------+
-| emptyIsAssigned | If true, an empty value is considered an assignment. | BOOLEAN | True or False |
-+-------------------+--------------------------------------------------------+------------+-----------------+
-
-- **Contains:**
- - Check if a search string contains another string.
-
-+-------------+---------------------------------------------------+------------+--------------+
-| **Field** | **Description** | **Type** | **Notes** |
-+=============+===================================================+============+==============+
-| String | The value to search. Supports ${} notation. | STRING | Any string |
-+-------------+---------------------------------------------------+------------+--------------+
-| Value | The value to search for. Supports ${} notation. | STRING | Any string |
-+-------------+---------------------------------------------------+------------+--------------+
-| | | | |
-+-------------+---------------------------------------------------+------------+--------------+
-
-- **EndsWith**:
- - Check if a search string ends with another string.
-
-+-------------+---------------------------------------------------+------------+--------------+
-| **Field** | **Description** | **Type** | **Notes** |
-+=============+===================================================+============+==============+
-| string | The value to search. Supports ${} notation. | STRING | Any string |
-+-------------+---------------------------------------------------+------------+--------------+
-| value | The value to search for. Supports ${} notation. | STRING | Any string |
-+-------------+---------------------------------------------------+------------+--------------+
-
-- **Equals:**
-
- - Choose a field from the event and a value to check for equality.
-
-+-------------+----------------------------------------------+------------+--------------+
-| **Field** | **Description** | **Type** | **Notes** |
-+=============+==============================================+============+==============+
-| field | The field to check. Supports ${} notation. | STRING | Any string |
-+-------------+----------------------------------------------+------------+--------------+
-| value | The value to match. Supports ${} notation. | STRING | Any string |
-+-------------+----------------------------------------------+------------+--------------+
-
-- **FlatironObjectExists**
-
- - Matches when the given object exists in the given Flatiron instance.
-
-+-------------+---------------------------------------------+------------+--------------+
-| **Field** | **Description** | **Type** | **Notes** |
-+=============+=============================================+============+==============+
-| oid | The OID of the object to look for. | STRING | Any string |
-+-------------+---------------------------------------------+------------+--------------+
-| flatiron | The name of the Flatiron client instance. | STRING | Any string |
-+-------------+---------------------------------------------+------------+--------------+
-
-- **IsAging**
- - Choose a field to test. This filter matches if the expression is
- numeric.
-
-+-------------+---------------------------------------------+------------+--------------+
-| **Field** | **Description** | **Type** | **Notes** |
-+=============+=============================================+============+==============+
-| field | The field to test. Supports ${} notation. | STRING | Any string |
-+-------------+---------------------------------------------+------------+--------------+
-
-- **IsNumeric**
- - Choose a field to test. This filter matches if the expression is
- numeric.
-
-+-------------+---------------------------------------------+------------+--------------+
-| **Field** | **Description** | **Type** | **Notes** |
-+=============+=============================================+============+==============+
-| field | The field to test. Supports ${} notation. | STRING | Any string |
-+-------------+---------------------------------------------+------------+--------------+
-
-- **MathCondition**
- - Choose a field from the event and a value for logical math conditions.
-
-+-------------+-------------------------------------------------+------------+-----------------------------------+
-| **Field** | **Description** | **Type** | **Notes** |
-+=============+=================================================+============+===================================+
-| Field | The field to check. Supports ${} notation. | STRING | Any string |
-+-------------+-------------------------------------------------+------------+-----------------------------------+
-| Value | The value to consider. Supports ${} notation. | STRING | Any string |
-+-------------+-------------------------------------------------+------------+-----------------------------------+
-| operator | The operation. | STRING | One of { "<=", ">=", ">", "<" } |
-+-------------+-------------------------------------------------+------------+-----------------------------------+
-| | | | |
-+-------------+-------------------------------------------------+------------+-----------------------------------+
-
-- **NoAlarms**
- - Don't match any alarms.
-- **Not**
- - Negate the configured filter.
-
-+-------------+-------------------------+------------+-------------+
-| **Field** | **Description** | **Type** | **Notes** |
-+=============+=========================+============+=============+
-| filter | The filter to negate. | FILTER | A filter |
-+-------------+-------------------------+------------+-------------+
-
-- **NotEqual**
- - Choose a field from the event and a value to check for inequality.
-
-+-------------+----------------------------------------------+------------+--------------+
-| **Field** | **Description** | **Type** | **Notes** |
-+=============+==============================================+============+==============+
-| field | The field to check. Supports ${} notation. | STRING | Any string |
-+-------------+----------------------------------------------+------------+--------------+
-| value | The value to match. Supports ${} notation. | STRING | Any string |
-+-------------+----------------------------------------------+------------+--------------+
-
-- **NotOneOf**
- - Match when the specified field does not have a value from the given list.
-
-+-------------+---------------------------------------------+------------+---------------------+
-| **Field** | **Description** | **Type** | **Notes** |
-+=============+=============================================+============+=====================+
-| field | The field to test. Supports ${} notation. | STRING | Any string |
-+-------------+---------------------------------------------+------------+---------------------+
-| values | The matching values. | LIST | A list of strings |
-+-------------+---------------------------------------------+------------+---------------------+
-
-- **OneOf**
- - Match when the specified field has a value from the given list.
-
-+-------------+---------------------------------------------+------------+---------------------+
-| **Field** | **Description** | **Type** | **Notes** |
-+=============+=============================================+============+=====================+
-| field | The field to test. Supports ${} notation. | STRING | Any string |
-+-------------+---------------------------------------------+------------+---------------------+
-| values | The matching values. | LIST | A list of strings |
-+-------------+---------------------------------------------+------------+---------------------+
-
-- **Or**
- - Create a set of filters. This filter matches when any one of them
- matches.
-
-+-------------+--------------------+------------+---------------------+
-| **Field** | **Description** | **Type** | **Notes** |
-+=============+====================+============+=====================+
-| filters | Combined Filters | LIST | A list of filters |
-+-------------+--------------------+------------+---------------------+
-
-- **RegEx**
- - Choose a field from the event to match against the regular expression
- you provide.
-
-+-------------+---------------------------------------------------------+------------+--------------+
-| **Field** | **Description** | **Type** | **Notes** |
-+=============+=========================================================+============+==============+
-| field | The text to check for a match. Supports ${} notation. | STRING | Any string |
-+-------------+---------------------------------------------------------+------------+--------------+
-| value | The regular expression (pattern) to match. | STRING | Any string |
-+-------------+---------------------------------------------------------+------------+--------------+
-
-- **StartsWith**
- - Check if a search string starts with another string.
-
-+-------------+---------------------------------------------------+------------+--------------+
-| **Field** | **Description** | **Type** | **Notes** |
-+=============+===================================================+============+==============+
-| string | The value to search. Supports ${} notation. | STRING | Any string |
-+-------------+---------------------------------------------------+------------+--------------+
-| Value | The value to search for. Supports ${} notation. | STRING | Any string |
-+-------------+---------------------------------------------------+------------+--------------+
-
-- **Unassigned**
- - Choose a field from the event to check for assignment. This filter
- matches when the field is not assigned.
-
-+-------------------+--------------------------------------------------------+------------+-----------------+
-| **Field** | **Description** | **Type** | **Notes** |
-+===================+========================================================+============+=================+
-| field | The field to check for on the event. | STRING | A field name |
-+-------------------+--------------------------------------------------------+------------+-----------------+
-| emptyIsAssigned | If true, an empty value is considered an assignment. | BOOLEAN | True or False |
-+-------------------+--------------------------------------------------------+------------+-----------------+
-
-- **WithinSecondsFrom**
- - This filter matches when the specified epoch time value is within the
- given number of seconds from the baseline time value. Both time values
- are assumed to be in seconds. If a value is in milliseconds, set
- baselineTimeInMillis and/or eventTimeInMillis to true.
-
-+------------------------+------------------------------------------------------------+------------+-----------------+
-| **Field** | **Description** | **Type** | **Notes** |
-+========================+============================================================+============+=================+
-| field | The time value to test. Supports ${} | STRING | A field name |
-+------------------------+------------------------------------------------------------+------------+-----------------+
-| eventTimeInMillis | Whether to convert the event value from milliseconds. | BOOLEAN | True or False |
-+------------------------+------------------------------------------------------------+------------+-----------------+
-| seconds | The number of seconds. | NUMBER | A number |
-+------------------------+------------------------------------------------------------+------------+-----------------+
-| baselineTimeInMillis | Whether to convert the baseline value from milliseconds. | BOOLEAN | True or False |
-+------------------------+------------------------------------------------------------+------------+-----------------+
-| baseline | The baseline time value. Supports ${}. | STRING | Any string |
-+------------------------+------------------------------------------------------------+------------+-----------------+
-
-- **WithinTimeFromNow**
- - This filter matches when the named field has an epoch time value
- within the given number of seconds from the current time. The event's
- time value is assumed to be in seconds. If it's in milliseconds, set
- eventTimeInMillis to true.
-
-+---------------------+---------------------------------------------------------+------------+-----------------+
-| **Field** | **Description** | **Type** | **Notes** |
-+=====================+=========================================================+============+=================+
-| field | The field to check on the event. | STRING | A field name |
-+---------------------+---------------------------------------------------------+------------+-----------------+
-| eventTimeInMillis | Whether to convert the event value from milliseconds. | BOOLEAN | True or False |
-+---------------------+---------------------------------------------------------+------------+-----------------+
-| seconds | The number of seconds. | NUMBER | A number |
-+---------------------+---------------------------------------------------------+------------+-----------------+
-
-- **Limit:**
-
- - Limit is the integer value and DMaaP Message Router will consumes
- only that set of message which are specified in limit.
-
- .. code:: bash
-
- Suppose if we set limit=2, then only 2 sets of data will be consumed.
- *Get \ **<<topicName>>/group/2?limit=4***
- Let us suppose if
- **No of data available** = 4
- **Set limit** = 6
- i.e. limit>no of data
- In this scenario all 4 sets of data will be consumed.
-
-- If limit is not passed with the url then by default limit is set to
- 4096.
-
- .. code:: bash
-
- i.e. 4096 sets of data will be consumed.
- **Timeout and Long Poll:**
-
-- Timeout is the integer value which will be treated by DMaaP Message
- Router as time in millisecond.
-
-
-
-- Get
-
-+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| `***http://localhost/DMaaP/dmaaprest/events/<<topicName>>/group/2?timeout=20000*** <http://localhost/DMaaP/dmaaprest/events/%3c%3ctopicName%3e%3e/group/2?timeout=20000>`__ |
-+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-
-- If there is no data available to be consumed, then DMaaP Message
- Router will poll for the particular period of time specified in
- timeout this mechanism is known as Long Poll.
-
-- If timeout is not passed with url then DMaaP Message Router will set
- the value of timeout =10000
-
-- i.e. if no set of data are available then DMaaP Message Router will
- poll for 10000 ms.
-
-***Meta:***
-
-- Meta is a Boolean value.
-
-- DMaaP Message Router reads the value of meta from
- MRConfiguration.properties file at the time of startup.
-
-- If the value of meta is not null and if value of meta is one of these
- values true, yes, on, 1, y, checked then DMaaP Message Router will
- take meta flag as true, else it will be false.
-
-- If meta is set to true then consumer will get the value of message
- offset along with message.
-
- |image1|
-
- .. |image1| image:: images/image1.png
-
-- **Pretty**:
-
-- Pretty is a Boolean value.
-
-- DMaaP Message Router reads the value of pretty from
- MRConfiguration.properties file at the time of startup.
-
-- If the value of pretty is not null and if value of pretty is one of
- these values true, yes, on, 1, y, checked then DMaaP Message Router
- will take pretty flag as true, else it will be false.
-
-- If pretty is set to true then different sets of messages will be
- printed in next line separated by comma (,).
-
- |image2|
-
- .. |image2| image:: images/image2.png
-
-- **Filter**
-
- - A filter examine an event and decides if it matches or doesn't.
- - Filters are mainly used in rules to decide if the processing entries
- should be executed on the given event. They're also used for settings,
- and systems like the Graph Correlator re-use Highland Park's filter
- mechanism to specify which alarms fit in a correlation.
- - The standard library includes a number of simple filters. The Equals
- filter, for example, compares a field's value with some other value
- and returns true if the values match.
- - The standard library also includes filter classes called And, Or, and
- Not, so you can compose more complex filters. For example, written in
- the standard JSON config format:
-
- +-----------------------------------------+
- | "filter":{ |
- | "class":"And", |
- | "filters": |
- | [ |
- | { "class":"Equals", "foo":"abc" }, |
- | { "class":"Assigned", "field":"bar" } |
- | ] |
- | } |
- +-----------------------------------------+
-
- - This filter matches events in which the field "foo" has value "abc" and
- the field "bar" is assigned to some value (as opposed to not being
- present on the event).
- - Filters are used by the consumers to filter out data and consume only
- specific set of data which matches the conditions mentioned in filter.
- - Filters can be passed as a query parameter by the consumer in consume
- request as mentioned below:
- - **http://localhost:8080/DMaaP/dmaaprest/events/DMaaP/consumergroup/mHOeNFY4XiWx4CBa?filter=\\{"class":"Equals","field":"email", "value":"`test@abc.com <mailto:test@att.com>`__" }**
- - Filters can be applied only on data in JSON format i.e. if applied, filters will automatically ignore any non-json data.
- - While consuming, request CONTENT\_TYPE is not relevant to filter.
-
- The MR API allows a subscriber pass a Highland Park filter as part of
- the GET request. This will filter the stream of messages sent back to
- the subscriber, but for this to work, there are some requirements:
-
- - The message payload must be JSON
-
- - Only a filter built from Highland Park's Standard Library may be
- used. (The Cambria API server doesn't have access to plugged in
- filters.)
-
- - The filter must be encoded properly in the URL path.
-
-Server-side filtering can also be setup in the Java client as illustrated below
-
-**Filtering Consumer**
-
-You can also provide a Highland Park filter to your consumer instance,
-and this filter is passed on to the server in the GET request. One way
-to create the filter is programmatically. In your code, instantiate a
-filter from the Highland Park Standard Library Then create a String
-representation of the filter using the FilterIo.write utility. This
-String can then be passed to the Cambria client instance for use on the
-server.
-
-Remember, only Highland Park standard library filter components can be
-used -- no plug-ins are available in the Cambria server context.
-
- .. code:: bash
-
- package org.onap.sa.highlandPark.integration;
-
- import java.io.IOException;
-
- import java.util.UUID;
-
- import org.onap.nsa.cambria.client.CambriaClientFactory;
-
- import org.onap.nsa.cambria.client.CambriaConsumer;
-
- import org.onap.sa.highlandPark.processor.HpEvent;
-
- import org.onap.sa.highlandPark.stdlib.filters.FilterIo;
-
- import org.onap.sa.highlandPark.stdlib.filters.OneOf;
-
- public class ExampleFilteringConsumer
-
- {
-
- public static void main ( String[] args ) throws IOException,
- InterruptedException
-
- {
-
- // Cambria clients take a set of 1 or more servers to use in round-robin
- fashion.
-
- // If a server becomes unreachable, another in the group is used.
-
- final String
- serverGroup="ueb01hydc.it.att.com,ueb02hydc.it.att.com,ueb03hydc.it.att.com";
-
- // choose a topic
-
- final String topic = "TEST-TOPIC";
-
- // Cambria clients can run in a cooperative group to handle high-volume
- topics.
-
- // Here, we create a random group name, which means this client is not
- re-startable.
-
- final String consumerGroup = UUID.randomUUID ().toString ();
-
- final String consumerId = "0";
-
- // Cambria clients can sit in a tight loop on the client side, using a
- long-poll
-
- // to wait for messages, and a limit to tell the server the most to send
- at a time.
-
- final int longPollMs = 30\*1000;
-
- final int limit = -1;
-
- // The Cambria server can filter the returned message stream using
- filters from the
-
- // Highland Park system. Here, we create a simple filter to test for the
- AlarmID
-
- // value being one of the Mobility power alarms.
-
- final OneOf oneOf = new OneOf ( "AlarmId", kPowerAlarms );
-
- // create the consumer
-
- final CambriaConsumer cc = CambriaClientFactory.createConsumer (
- serverGroup, topic,
-
- consumerGroup, consumerId, longPollMs, limit, FilterIo.write ( oneOf )
- );
-
- // now loop reading messages. Note that cc.fetch() will wait in its HTTP
- receive
-
- // method for up to 30 seconds (longPollMs) when nothing's available at
- the server.
-
- long count = 0;
-
- while ( true )
-
- {
-
- for ( String msg : cc.fetch () )
-
- {
-
- System.out.println ( "" + (++count) + ": " + msg );
-
- }
-
- }
-
- }
-
- private static final String[] kPowerAlarms =
-
- {
-
- "HUB COMMERCIAL POWER FAIL\_FWD",
-
- "HUB COMMERCIAL POWER FAIL",
-
- "RBS COMMERCIAL POWER FAIL - Fixed\_FWD",
-
- "RBS COMMERCIAL POWER FAIL\_FWD",
-
- "RBS COMMERCIAL POWER FAIL - No Generator\_FWD",
-
- "RBS COMMERCIAL POWER FAIL - Portable\_FWD",
-
- "RBS COMMERCIAL POWER FAIL - Shared\_FWD",
-
- "RBS COMMERCIAL POWER FAIL - Yes\_FWD",
-
- "RBS COMMERCIAL POWER FAIL - YES\_FWD",
-
- "RBS COMMERCIAL POWER FAIL - Fixed",
-
- "RBS COMMERCIAL POWER FAIL - No Generator",
-
- "RBS COMMERCIAL POWER FAIL - Portable",
-
- "RBS COMMERCIAL POWER FAIL - Shared",
-
- "RBS COMMERCIAL POWER FAIL - YES",
-
- "RBS COMMERCIAL POWER FAIL - Yes",
-
- "RBS COMMERCIAL POWER FAIL",
-
- "HUB COMMERCIAL POWER FAIL - Fixed",
-
- "HUB COMMERCIAL POWER FAIL - No Generator",
-
- "HUB COMMERCIAL POWER FAIL - Portable",
-
- "HUB COMMERCIAL POWER FAIL - Shared",
-
- "HUB COMMERCIAL POWER FAIL - Fixed\_FWD",
-
- "HUB COMMERCIAL POWER FAIL - No Generator\_FWD",
-
- "HUB COMMERCIAL POWER FAIL - Portable\_FWD",
-
- "HUB COMMERCIAL POWER FAIL - Shared\_FWD",
-
- };
-
- }
-
-
-
-**Filter Builder**
-
- MR server-side filtering allows a consumer to filter the stream of
- messages returned from the GET call. The following link provide details
- of building some of the filter to illustrate Filter Builder. It is not
- meant to cover and provide examples of every filter
diff --git a/docs/Filter/images/image1.png b/docs/Filter/images/image1.png
deleted file mode 100644
index d424f15..0000000
--- a/docs/Filter/images/image1.png
+++ /dev/null
Binary files differ
diff --git a/docs/Filter/images/image2.png b/docs/Filter/images/image2.png
deleted file mode 100644
index faddcfe..0000000
--- a/docs/Filter/images/image2.png
+++ /dev/null
Binary files differ
diff --git a/docs/Installation/Installation.rst b/docs/Installation/Installation.rst
index 5232bd4..6912562 100644
--- a/docs/Installation/Installation.rst
+++ b/docs/Installation/Installation.rst
@@ -1,7 +1,15 @@
-=================================
-DMAAP MESSAGE ROUTER INSTALLATION
-=================================
-This document describes how to install and access DMaaP Message Router.
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Installation
+============
+
+Environment
+-----------
+Message Router is developed using Kafka, Zookeeper and Java. AJSC framework is used to create the REST service and Docker was used to package the service.
+
+Steps
+-----
Message Router has 3 docker containers. Dmaap\_container,
kafka\_contaienr and zookeeper\_container. Zookeeper runs on 172.18.0.3,
kafka runs on 172.18.0.2 and dmaap on 172.18.0.4.
@@ -17,9 +25,9 @@ kafka runs on 172.18.0.2 and dmaap on 172.18.0.4.
3) In /var/tmp/MsgRtrApi.properties, change value of below variables as
shown below:
- config.zk.servers=172.18.0.3
+ config.zk.servers=172.18.0.3(Change as per where ZooKeepeer is deployed)
- kafka.metadata.broker.list=172.18.0.2:9092
+ kafka.metadata.broker.list=172.18.0.2:9092(Change as per where Kafka is deployed)
4) Install docker and docker-compose
@@ -52,6 +60,4 @@ Testing
http://172.18.0.4:3904/events/TestTopic1/CG1/C1?timeout=1000
Note: You will only receive messages which have been published after
- you have subscribed to a topic.
-
-
+ you have subscribed to a topic. \ No newline at end of file
diff --git a/docs/administration/administration.rst b/docs/administration/administration.rst
new file mode 100644
index 0000000..7c082a3
--- /dev/null
+++ b/docs/administration/administration.rst
@@ -0,0 +1,14 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Administration
+==============
+
+
+Processes
+---------
+NA
+
+Actions
+-------
+NA \ No newline at end of file
diff --git a/docs/architecture/architecture.rst b/docs/architecture/architecture.rst
new file mode 100644
index 0000000..60f8467
--- /dev/null
+++ b/docs/architecture/architecture.rst
@@ -0,0 +1,28 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Architecture
+============
+
+.. note::
+ * This section is used to describe a software component from a high level
+ view of capability, common usage scenarios, and interactions with other
+ components required in the usage scenarios.
+
+ * The architecture section is typically: provided in a platform-component
+ and sdk collections; and referenced from developer and user guides.
+
+ * This note must be removed after content has been added.
+
+
+Capabilities
+------------
+Message Router is a RESTful web service used for any needed action with Kaka
+
+Usage Scenarios
+---------------
+Message Router endpoints are used to create/view/delete a topic in Kafka. Clients can use the Message Router endpoints to publish a message to a topic and subscribe to a topic
+
+Interactions
+------------
+Message Service REST service uses the message service API to interact with the ZooKeeper/Kafka \ No newline at end of file
diff --git a/docs/configuration/configuration.rst b/docs/configuration/configuration.rst
new file mode 100644
index 0000000..9816005
--- /dev/null
+++ b/docs/configuration/configuration.rst
@@ -0,0 +1,10 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Configuration
+=============
+
+Deploy the ZooKeeper and Kafka and update the following 2 properties in MsgRtrApi.properties
+
+config.zk.servers=<<zookeeper_host>>
+kafka.metadata.broker.list=<<kafka_host>:<<kafka_port>> \ No newline at end of file
diff --git a/docs/consumedapis/consumedapis.rst b/docs/consumedapis/consumedapis.rst
new file mode 100644
index 0000000..321b461
--- /dev/null
+++ b/docs/consumedapis/consumedapis.rst
@@ -0,0 +1,8 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Consumed APIs
+=============
+
+Message Router do not consume any API
+
diff --git a/docs/delivery/delivery.rst b/docs/delivery/delivery.rst
new file mode 100644
index 0000000..b815e1c
--- /dev/null
+++ b/docs/delivery/delivery.rst
@@ -0,0 +1,34 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Delivery
+========
+
+Message Router is comprised of Message Router service and Message Router API. Message Router uses Kafka and ZooKeeper
+
+.. blockdiag::
+
+
+ blockdiag layers {
+ orientation = portrait
+ MR_SERVIVE -> MR_API;
+ MR_SERVIVE -> KAFKA;
+ MR_SERVIVE -> ZOOKEEPER;
+ group l1 {
+ color = blue;
+ label = "MR container";
+ MR_SERVIVE; MR_API;
+ }
+ group l2 {
+ color = yellow;
+ label = "Kafka Container";
+ KAFKA;
+ }
+ group l3 {
+ color = orange;
+ label = "ZooKeeper Container";
+ ZOOKEEPER;
+ }
+
+ }
+
diff --git a/docs/humaninterfaces/humaninterfaces.rst b/docs/humaninterfaces/humaninterfaces.rst
new file mode 100644
index 0000000..73fbe84
--- /dev/null
+++ b/docs/humaninterfaces/humaninterfaces.rst
@@ -0,0 +1,9 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Human Interfaces
+================
+
+Message Router does not have human interfaces
+
+
diff --git a/docs/index.rst b/docs/index.rst
index 4eda778..98872aa 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,17 +1,23 @@
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
-.. Copyright © 2017 AT&T Intellectual Property. All rights reserved.
-Message Router (MR)
+dmaap/messagerouter(MR)
====================
.. toctree::
- :maxdepth: 2
+ :maxdepth: 1
- message-router/message-router
- Installation/Installation
- Filter/Filter
+ architecture/architecture.rst
+ offeredapis/offeredapis.rst
+ consumedapis/consumedapis.rst
+ delivery/delivery.rst
+ logging/logging.rst
+ installation/installation.rst
+ configuration/configuration.rst
+ administration/administration.rst
+ humaninterfaces/humaninterfaces.rst
+ release-notes/release-notes.rst
diff --git a/docs/logging/logging.rst b/docs/logging/logging.rst
new file mode 100644
index 0000000..0ddf365
--- /dev/null
+++ b/docs/logging/logging.rst
@@ -0,0 +1,52 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Logging
+=======
+
+.. note::
+ * This section is used to describe the informational or diagnostic messages emitted from
+ a software component and the methods or collecting them.
+
+ * This section is typically: provided for a platform-component and sdk; and
+ referenced in developer and user guides
+
+ * This note must be removed after content has been added.
+
+
+Where to Access Information
+---------------------------
+CLAMP uses logback framework to generate logs and all the logs are emitted to the console.
+
+Error / Warning Messages
+------------------------
+Following are the error codes
+
+RESOURCE_NOT_FOUND=3001
+SERVER_UNAVAILABLE=3002
+METHOD_NOT_ALLOWED=3003
+GENERIC_INTERNAL_ERROR=1004
+MSG_SIZE_EXCEEDS_BATCH_LIMIT=5001
+UNABLE_TO_PUBLISH=5002
+INCORRECT_BATCHING_FORMAT=5003
+MSG_SIZE_EXCEEDS_MSG_LIMIT=5004
+INCORRECT_JSON=5005
+CONN_TIMEOUT=5006
+PARTIAL_PUBLISH_MSGS=5007
+CONSUME_MSG_ERROR=5008
+PUBLISH_MSG_ERROR=5009
+RETRIEVE_TRANSACTIONS=5010
+RETRIEVE_TRANSACTIONS_DETAILS=5011
+TOO_MANY_REQUESTS=5012
+RATE_LIMIT_EXCEED=301
+GET_TOPICS_FAIL=6001
+GET_TOPICS_DETAILS_FAIL=6002
+CREATE_TOPIC_FAIL=6003
+DELETE_TOPIC_FAIL=6004
+GET_PUBLISHERS_BY_TOPIC=6005
+GET_CONSUMERS_BY_TOPIC=6006
+GET_CONSUMER_CACHE=6011
+DROP_CONSUMER_CACHE=6012
+GET_METRICS_ERROR=6013
+TOPIC_NOT_IN_AAF=6017
+
diff --git a/docs/message-router/image1.png b/docs/message-router/image1.png
deleted file mode 100644
index 100973d..0000000
--- a/docs/message-router/image1.png
+++ /dev/null
Binary files differ
diff --git a/docs/message-router/message-router.rst b/docs/offeredapis/offeredapis.rst
index 6d08b16..f56c0de 100644
--- a/docs/message-router/message-router.rst
+++ b/docs/offeredapis/offeredapis.rst
@@ -1,18 +1,8 @@
-============================================
-Message Router (MR) API Guide
-============================================
-Architecture
--------------
-
-In DMaaP Message Router, Restful web service is exposed to client to perform any needed action with Kafka. After getting the request it calls the Message router service layer which is created using AJSC ( AT&T Java Service Container) . AJSC finally calls Kafka services and response is sent back.
-
- |image0|
-
- .. |image0| image:: image1.png
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
-
-HTTP Service APIs
-------------------
+Offered APIs
+------------
DMaaP Message Router utilizes an HTTP REST API to service all Publish
and Consume transactions. HTTP and REST standards are followed so
@@ -31,11 +21,9 @@ of the specific transactions described in this section.
HTTP URL
========
-http[s]://Username:Password@serverBaseURL{/routing}{resourcePath}
-
-- The Username:Password utilizes HTTP Basic Authentication and HTTPS/TLS to securely transmit the authorization and authentication credentials that AAF needs to validate the client's access to the requested resource.
+http[s]://serverBaseURL{/routing}{resourcePath}
-- The serverBaseURL points to DMaaP Message Router host/port that will service the request. Optionally DME2 service end points for Message Router can be used.
+- The serverBaseURL points to DMaaP Message Router host/port that will service the request.
- The resourcePath specifies the specific service, or Topic, that the client is attempting to reach
diff --git a/docs/release-notes.rst b/docs/release-notes/release-notes.rst
index f0bbf40..085652f 100644
--- a/docs/release-notes.rst
+++ b/docs/release-notes/release-notes.rst
@@ -1,18 +1,45 @@
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
-DMAAP Release Notes
-===================
-Version: 1.0.1
+Release Notes
+=============
+
+
+
+Version: 1.1.4
--------------
-:Release Date: 2017-11-16
+:Release Date: 2018-04-18
**New Features**
+This release fixes the packaging and security issues.
+
+**Bug Fixes**
+ NA
+**Known Issues**
+ NA
+
+**Security Issues**
+ This release fixes the security vulnerabilities due to the opensourced libraries used in the project
+
+
+**Upgrade Notes**
+ NA
+
+**Deprecation Notes**
+
+Version: 1.0.1
+
+Release Date: 2017-11-16
+
+
+New Features:
+
- Pub/sub messaging metaphor to broaden data processing opportunities
- A single solution for most event distribution needs to support a range of environments
- Standardized topic names
@@ -23,22 +50,15 @@ Version: 1.0.1
-**Bug Fixes**
+Bug Fixes
- `DMAAP-165 <https://jira.onap.org/browse/DMAAP-165>`_ Correct documentation rst file errors and warnings
- `DMAAP-160 <https://jira.onap.org/browse/DMAAP-160>`_ DMaaP periodically loses connection to Kafka
- `DMAAP-157 <https://jira.onap.org/browse/DMAAP-157>`_ SDC service models distribution fails
- `DMAAP-151 <https://jira.onap.org/browse/DMAAP-151>`_ Fix docker image bug
- `DMAAP-1 <https://jira.onap.org/browse/DMAAP-1>`_ MSO DB is not populated with the models from SDC
-**Known Issues**
+Known Issues
- `DMAAP-164 <https://jira.onap.org/browse/DMAAP-164>`_ The dependency from kafka for zookeeper created issues when the vm is restarted
-
-**Security Issues**
- N/A
+Other
-**Upgrade Notes**
- N/A
-**Deprecation Notes**
- N/A
-**Other**