From: efiacor Date: Thu, 31 Mar 2022 16:20:13 +0000 (+0100) Subject: [DMAAP-DR] Doc updates for AAF and tlsEnabled X-Git-Tag: 2.1.11^0 X-Git-Url: https://gerrit.onap.org/r/gitweb?p=dmaap%2Fdatarouter.git;a=commitdiff_plain;h=e49f6d600a6bdc828a2cd8a8e04b1182586a5e19 [DMAAP-DR] Doc updates for AAF and tlsEnabled Signed-off-by: efiacor Change-Id: Id2c216b67ebcd341088842a1f1016d06b7ebf8a7 Issue-ID: DMAAP-1714 --- diff --git a/docs/apis/data-router-api.rst b/docs/apis/data-router-api.rst index 1604e62d..0b1c0cbe 100755 --- a/docs/apis/data-router-api.rst +++ b/docs/apis/data-router-api.rst @@ -44,12 +44,6 @@ Specifies HTTP Headers, such as Content-Type, that define the parameters of the The HTTP Body contains the feed content when creating a feed. -**HTTP Authorization** - -The user-id:password pair: - -* If AAF enabled: A valid AAF AppId to be authenticated and authorized by the AAF CADI framework. -* If Non AAF : When publishing or retracting a file, a valid `EID Object`_ with publish permissions. Create a Feed ------------- @@ -62,43 +56,35 @@ Create a Feed **Request Parameters:** -+----------------------+--------------------------------+------------+------------------+--------+--------+------------+----------+-------------------------------+ -| Field | Description | Param Type | Data Type | MaxLen | Set By | Updatable? | Required | Valid/Example Values | -+======================+================================+============+==================+========+========+============+==========+===============================+ -| name | Feed name | Body | String | <=20 | Client | N | Y | | -+----------------------+--------------------------------+------------+------------------+--------+--------+------------+----------+-------------------------------+ -| version | Feed version | Body | String | <=20 | Client | N | Y | v1.0.0 | -+----------------------+--------------------------------+------------+------------------+--------+--------+------------+----------+-------------------------------+ -| description | Feed description | Body | String | <=256 | Client | Y | N | | -+----------------------+--------------------------------+------------+------------------+--------+--------+------------+----------+-------------------------------+ -| business description | Business description | Body | String | <=256 | Client | Y | N | | -+----------------------+--------------------------------+------------+------------------+--------+--------+------------+----------+-------------------------------+ -| authorization | Information for authorizing | Body |`Auth Object`_ | | Client | Y | Y | | -| | publishing requests | | | | | | | | -+----------------------+--------------------------------+------------+------------------+--------+--------+------------+----------+-------------------------------+ -| suspend | Set to true if the feed is in | Body | Boolean | | Client | Y | N | * true | -| | the suspended state | | | | | | | * false (default) | -+----------------------+--------------------------------+------------+------------------+--------+--------+------------+----------+-------------------------------+ -| group-id | Auth group for feed management | Body | Integer | | Client | Y | N | 0 (default) | -+----------------------+--------------------------------+------------+------------------+--------+--------+------------+----------+-------------------------------+ -| aaf_instance | The instance passed to aaf | Body | String | <=256 | Client | N | N | legacy (default) | -| | during permission checks | | | | | | | | -+----------------------+--------------------------------+------------+------------------+--------+--------+------------+----------+-------------------------------+ -| Content-Type | To specify type of message | Header | String | | Client | N | Y | application/vnd.dmaap-dr.feed | -+----------------------+--------------------------------+------------+------------------+--------+--------+------------+----------+-------------------------------+ -| publisher | Publisher identity as passed | Header | String | <=8 | DR | N | Y | username | -| | in X-DMAAP-DR-ON-BEHALF-OF at | | | | | | | | -| | creation time | | | | | | | | -+----------------------+--------------------------------+------------+------------------+--------+--------+------------+----------+-------------------------------+ -| Authorization | The user / AppId to be | Header | String | | Client | N | Y if AAF | dcae@dcae.onap.org:{password} | -| | authorized by the AAF CADI | | | | | | enabled | | -| | framework | | | | | | | | -+----------------------+--------------------------------+------------+------------------+--------+--------+------------+----------+-------------------------------+ -| X-EXCLUDE-AAF | To determine if the feed to | Header | Boolean | | Client | N | Y if AAF | * true (for legacy feed) | -| | create is legacy or AAF | | | | | | enabled | * false (for AAF feed) | -+----------------------+--------------------------------+------------+------------------+--------+--------+------------+----------+-------------------------------+ -| Links | URLs related to this feed | Body |`Feed Links Obj`_ | | DR | N | N | | -+----------------------+--------------------------------+------------+------------------+--------+--------+------------+----------+-------------------------------+ ++-------------------------+--------------------------------+------------+------------------+--------+--------+------------+----------+-------------------------------+ +| Field | Description | Param Type | Data Type | MaxLen | Set By | Updatable? | Required | Valid/Example Values | ++=========================+================================+============+==================+========+========+============+==========+===============================+ +| name | Feed name | Body | String | <=20 | Client | N | Y | | ++-------------------------+--------------------------------+------------+------------------+--------+--------+------------+----------+-------------------------------+ +| version | Feed version | Body | String | <=20 | Client | N | Y | v1.0.0 | ++-------------------------+--------------------------------+------------+------------------+--------+--------+------------+----------+-------------------------------+ +| description | Feed description | Body | String | <=256 | Client | Y | N | | ++-------------------------+--------------------------------+------------+------------------+--------+--------+------------+----------+-------------------------------+ +| business description | Business description | Body | String | <=256 | Client | Y | N | | ++-------------------------+--------------------------------+------------+------------------+--------+--------+------------+----------+-------------------------------+ +| authorization | Information for authorizing | Body |`Auth Object`_ | | Client | Y | Y | | +| | publishing requests | | | | | | | | ++-------------------------+--------------------------------+------------+------------------+--------+--------+------------+----------+-------------------------------+ +| suspend | Set to true if the feed is in | Body | Boolean | | Client | Y | N | * true | +| | the suspended state | | | | | | | * false (default) | ++-------------------------+--------------------------------+------------+------------------+--------+--------+------------+----------+-------------------------------+ +| group-id | Auth group for feed management | Body | Integer | | Client | Y | N | 0 (default) | ++-------------------------+--------------------------------+------------+------------------+--------+--------+------------+----------+-------------------------------+ +| Content-Type | To specify type of message | Header | String | | Client | N | Y | application/vnd.dmaap-dr.feed | ++-------------------------+--------------------------------+------------+------------------+--------+--------+------------+----------+-------------------------------+ +| Authorization | The user / AppId to be | Header | String | | Client | N | Y | Basic | +| | authorized | | | | | | | | ++-------------------------+--------------------------------+------------+------------------+--------+--------+------------+----------+-------------------------------+ +| X-DMAAP-DR-ON-BEHALF-OF | Publisher identity as passed | Header | String | <=8 | DR | N | Y | username | +| | in X-DMAAP-DR-ON-BEHALF-OF at | | | | | | | | +| | creation time | | | | | | | | ++-------------------------+--------------------------------+------------+------------------+--------+--------+------------+----------+-------------------------------+ + **Response Codes** @@ -158,17 +144,12 @@ Create a Feed { "password": "dradmin", "id": "dradmin" - }, - { - "password": "demo123456!", - "id": "onap" } ] }, "name": "ONAP Data Feed", "business_description": "", - "aaf_instance": "legacy", - "publisher": "dradmin", + "publisher": "{user}", "links": { "subscribe": "https://dmaap-dr-prov/subscribe/1", "log": "https://dmaap-dr-prov/feedlog/1", @@ -191,35 +172,34 @@ Update a Feed **Request Parameters:** -+------------------------+---------------------------------+-------------+---------------+------------+-------------+ -| Field | Description | Param Type | Data Type | MaxLen | Required | -+========================+=================================+=============+===============+============+=============+ -| name | Feed name | Body | String | <=20 | Y | -+------------------------+---------------------------------+-------------+---------------+------------+-------------+ -| description | Feed description | Body | String | <=256 | N | -+------------------------+---------------------------------+-------------+---------------+------------+-------------+ -| business description | Business description | Body | String | <=256 | N | -+------------------------+---------------------------------+-------------+---------------+------------+-------------+ -| authorization | Information for authorizing | Body |`Auth Object`_ | | Y | -| | publishing requests | | | | | -+------------------------+---------------------------------+-------------+---------------+------------+-------------+ -| suspend | Set to true if the feed is in | Body | Boolean | | N | -| | the suspended state | | | | | -+------------------------+---------------------------------+-------------+---------------+------------+-------------+ -| group-id | Auth group for feed management | Body | Integer | | N | -| | | | | | | -+------------------------+---------------------------------+-------------+---------------+------------+-------------+ -| Content-type | To specify type of message | Header | String | | Y | -| | (feed,subscriber,publisher) | | | | | -+------------------------+---------------------------------+-------------+---------------+------------+-------------+ -| publisher | Publisher identity as passed | Header | String | <=8 | Y | -| | in X-DMAAP-DR-ON-BEHALF-OF at | | | | | -| | creation time | | | | | -+------------------------+---------------------------------+-------------+---------------+------------+-------------+ -| Authorization | The user / AppId to be | Header | String | | Y if AAF | -| | authorized by the AAF CADI | | | | enabled | -| | framework | | | | | -+------------------------+---------------------------------+-------------+---------------+------------+-------------+ ++-------------------------+---------------------------------+-------------+---------------+------------+-------------+ +| Field | Description | Param Type | Data Type | MaxLen | Required | ++=========================+=================================+=============+===============+============+=============+ +| name | Feed name | Body | String | <=20 | Y | ++-------------------------+---------------------------------+-------------+---------------+------------+-------------+ +| description | Feed description | Body | String | <=256 | N | ++-------------------------+---------------------------------+-------------+---------------+------------+-------------+ +| business description | Business description | Body | String | <=256 | N | ++-------------------------+---------------------------------+-------------+---------------+------------+-------------+ +| authorization | Information for authorizing | Body |`Auth Object`_ | | Y | +| | publishing requests | | | | | ++-------------------------+---------------------------------+-------------+---------------+------------+-------------+ +| suspend | Set to true if the feed is in | Body | Boolean | | N | +| | the suspended state | | | | | ++-------------------------+---------------------------------+-------------+---------------+------------+-------------+ +| group-id | Auth group for feed management | Body | Integer | | N | +| | | | | | | ++-------------------------+---------------------------------+-------------+---------------+------------+-------------+ +| Content-type | To specify type of message | Header | String | | Y | +| | (feed,subscriber,publisher) | | | | | ++-------------------------+---------------------------------+-------------+---------------+------------+-------------+ +| Authorization | The user / AppId to be | Header | String | | Y | +| | authorized | | | | | ++-------------------------+---------------------------------+-------------+---------------+------------+-------------+ +| X-DMAAP-DR-ON-BEHALF-OF | Publisher identity as passed | Header | String | <=8 | Y | +| | in X-DMAAP-DR-ON-BEHALF-OF at | | | | | +| | creation time | | | | | ++-------------------------+---------------------------------+-------------+---------------+------------+-------------+ **Response Codes** @@ -295,8 +275,7 @@ Update a Feed }, "name": "ONAP Data Feed1", "business_description": "Updated ONAP Feed", - "aaf_instance": "legacy", - "publisher": "dradmin", + "publisher": "{user}", "links": { "subscribe": "https://dmaap-dr-prov/subscribe/1", "log": "https://dmaap-dr-prov/feedlog/1", @@ -319,17 +298,16 @@ Get a Feed **Request Parameters:** -+------------------------+---------------------------------+-------------+---------------+------------+-------------+ -| Field | Description | Param Type | Data Type | MaxLen | Required | -+========================+=================================+=============+===============+============+=============+ -| publisher | Publisher identity as passed | Header | String | <=8 | Y | -| | in X-DMAAP-DR-ON-BEHALF-OF at | | | | | -| | creation time | | | | | -+------------------------+---------------------------------+-------------+---------------+------------+-------------+ -| Authorization | The user / AppId to be | Header | String | | Y if AAF | -| | authorized by the AAF CADI | | | | enabled | -| | framework | | | | | -+------------------------+---------------------------------+-------------+---------------+------------+-------------+ ++-------------------------+---------------------------------+-------------+---------------+------------+-------------+ +| Field | Description | Param Type | Data Type | MaxLen | Required | ++=========================+=================================+=============+===============+============+=============+ +| Authorization | The user / AppId to be | Header | String | | Y | +| | authorized | | | | | ++-------------------------+---------------------------------+-------------+---------------+------------+-------------+ +| X-DMAAP-DR-ON-BEHALF-OF | Publisher identity as passed | Header | String | <=8 | Y | +| | in X-DMAAP-DR-ON-BEHALF-OF at | | | | | +| | creation time | | | | | ++-------------------------+---------------------------------+-------------+---------------+------------+-------------+ **Response Codes** @@ -367,17 +345,12 @@ Get a Feed { "password": "dradmin", "id": "dradmin" - }, - { - "password": "demo123456!", - "id": "onap" } ] }, "name": "ONAP Data Feed", "business_description": "Updated ONAP Feed", - "aaf_instance": "legacy", - "publisher": "dradmin", + "publisher": "{user}", "links": { "subscribe": "https://dmaap-dr-prov/subscribe/1", "log": "https://dmaap-dr-prov/feedlog/1", @@ -399,17 +372,16 @@ Delete a Feed **Request Parameters:** -+------------------------+---------------------------------+-------------+---------------+------------+-------------+ -| Field | Description | Param Type | Data Type | MaxLen | Required | -+========================+=================================+=============+===============+============+=============+ -| publisher | Publisher identity as passed | Header | String | <=8 | Y | -| | in X-DMAAP-DR-ON-BEHALF-OF at | | | | | -| | creation time | | | | | -+------------------------+---------------------------------+-------------+---------------+------------+-------------+ -| Authorization | The user / AppId to be | Header | String | | Y if AAF | -| | authorized by the AAF CADI | | | | enabled | -| | framework | | | | | -+------------------------+---------------------------------+-------------+---------------+------------+-------------+ ++-------------------------+---------------------------------+-------------+---------------+------------+-------------+ +| Field | Description | Param Type | Data Type | MaxLen | Required | ++=========================+=================================+=============+===============+============+=============+ +| Authorization | The user / AppId to be | Header | String | | Y | +| | authorized | | | | | ++-------------------------+---------------------------------+-------------+---------------+------------+-------------+ +| X-DMAAP-DR-ON-BEHALF-OF | Publisher identity as passed | Header | String | <=8 | Y | +| | in X-DMAAP-DR-ON-BEHALF-OF at | | | | | +| | creation time | | | | | ++-------------------------+---------------------------------+-------------+---------------+------------+-------------+ **Response Codes** @@ -438,51 +410,40 @@ Subscribe to Feed **Request Parameters:** -+-----------------+---------------------------------+---------------+-----------------+--------+--------+------------+----------+--------------------------------------+ -| Field | Description | Param Type | Data Type | MaxLen | Set By | Updatable? | Required | Valid/Example Values | -+=================+=================================+===============+=================+========+========+============+==========+======================================+ -| feedId | ID for the feed you are | Path | String | | Client | N | Y | 1 | -| | subscribing to | | | | | | | | -+-----------------+---------------------------------+---------------+-----------------+--------+--------+------------+----------+--------------------------------------+ -| delivery | Address and credentials for | Body | `Del Object`_ | | Client | Y | Y | | -| | delivery | | | | | | | | -+-----------------+---------------------------------+---------------+-----------------+--------+--------+------------+----------+--------------------------------------+ -| follow_redirect | Set to true if feed redirection | Body | Boolean | | Client | Y | N | * true | -| | is expected | | | | | | | * false (default) | -+-----------------+---------------------------------+---------------+-----------------+--------+--------+------------+----------+--------------------------------------+ -| metadata_only | Set to true if subscription is | Body | Boolean | | Client | Y | Y | * true | -| | to receive per-file metadata | | | | | | | * false | -+-----------------+---------------------------------+---------------+-----------------+--------+--------+------------+----------+--------------------------------------+ -| suspend | Set to true if the subscription | Body | Boolean | | Client | Y | N | * true | -| | is in the suspended state | | | | | | | * false (default) | -+-----------------+---------------------------------+---------------+-----------------+--------+--------+------------+----------+--------------------------------------+ -| decompress | Set to true if the data is to | Body | Boolean | | Client | Y | N | * true | -| | be decompressed for subscriber | | | | | | | * false (default) | -+-----------------+---------------------------------+---------------+-----------------+--------+--------+------------+----------+--------------------------------------+ -| group-id | Auth group for sub management | Body | Integer | | Client | Y | Y | 22 | -| | | | | | | | | | -+-----------------+---------------------------------+---------------+-----------------+--------+--------+------------+----------+--------------------------------------+ -| aaf_instance | The instance passed to aaf | Body | String | <=256 | Client | N | N | * legacy (default) | -| | during permission checks | | | | | | | | -| | | | | | | | | | -+-----------------+---------------------------------+---------------+-----------------+--------+--------+------------+----------+--------------------------------------+ -| Content-type | To specify type of message | Header | String | | Client | N | Y | application/vnd.dmaap-dr.subscription| -| | (feed,subscriber,publisher) | | | | | | | | -+-----------------+---------------------------------+---------------+-----------------+--------+--------+------------+----------+--------------------------------------+ -| subscriber | Subscriber identity as passed | Header | String | <=8 | DR | N | Y | username | -| | in X-DMAAP-DR-ON-BEHALF-OF at | | | | | | | | -| | creation time | | | | | | | | -+-----------------+---------------------------------+---------------+-----------------+--------+--------+------------+----------+--------------------------------------+ -| Authorization | The user / AppId to be | Header | String | | Client | N | Y if AAF | dcae@dcae.onap.org:{password} | -| | authorized by the AAF CADI | | | | | | enabled | | -| | framework | | | | | | | | -+-----------------+---------------------------------+---------------+-----------------+--------+--------+------------+----------+--------------------------------------+ -| X-EXCLUDE-AAF | To determine if the feed to | Header | Boolean | | Client | N | Y if AAF | * true (for legacy feed) | -| | create is legacy or AAF | | | | | | enabled | * false (for AAF feed) | -+-----------------+---------------------------------+---------------+-----------------+--------+--------+------------+----------+--------------------------------------+ -| Links | URLs related to this | Body |`Sub Links Obj`_ | | DR | N | N | | -| | subscription | | | | | | | | -+-----------------+---------------------------------+---------------+-----------------+--------+--------+------------+----------+--------------------------------------+ ++-------------------------+---------------------------------+---------------+-----------------+--------+--------+------------+----------+--------------------------------------+ +| Field | Description | Param Type | Data Type | MaxLen | Set By | Updatable? | Required | Valid/Example Values | ++=========================+=================================+===============+=================+========+========+============+==========+======================================+ +| feedId | ID for the feed you are | Path | String | | Client | N | Y | 1 | +| | subscribing to | | | | | | | | ++-------------------------+---------------------------------+---------------+-----------------+--------+--------+------------+----------+--------------------------------------+ +| delivery | Address and credentials for | Body | `Del Object`_ | | Client | Y | Y | | +| | delivery | | | | | | | | ++-------------------------+---------------------------------+---------------+-----------------+--------+--------+------------+----------+--------------------------------------+ +| follow_redirect | Set to true if feed redirection | Body | Boolean | | Client | Y | N | * true | +| | is expected | | | | | | | * false (default) | ++-------------------------+---------------------------------+---------------+-----------------+--------+--------+------------+----------+--------------------------------------+ +| metadata_only | Set to true if subscription is | Body | Boolean | | Client | Y | Y | * true | +| | to receive per-file metadata | | | | | | | * false | ++-------------------------+---------------------------------+---------------+-----------------+--------+--------+------------+----------+--------------------------------------+ +| suspend | Set to true if the subscription | Body | Boolean | | Client | Y | N | * true | +| | is in the suspended state | | | | | | | * false (default) | ++-------------------------+---------------------------------+---------------+-----------------+--------+--------+------------+----------+--------------------------------------+ +| decompress | Set to true if the data is to | Body | Boolean | | Client | Y | N | * true | +| | be decompressed for subscriber | | | | | | | * false (default) | ++-------------------------+---------------------------------+---------------+-----------------+--------+--------+------------+----------+--------------------------------------+ +| group-id | Auth group for sub management | Body | Integer | | Client | Y | Y | 22 | +| | | | | | | | | | ++-------------------------+---------------------------------+---------------+-----------------+--------+--------+------------+----------+--------------------------------------+ +| Content-type | To specify type of message | Header | String | | Client | N | Y | application/vnd.dmaap-dr.subscription| +| | (feed,subscriber,publisher) | | | | | | | | ++-------------------------+---------------------------------+---------------+-----------------+--------+--------+------------+----------+--------------------------------------+ +| Authorization | The user / AppId to be | Header | String | | Client | N | Y | Basic | +| | authorized | | | | | | | | ++-------------------------+---------------------------------+---------------+-----------------+--------+--------+------------+----------+--------------------------------------+ +| X-DMAAP-DR-ON-BEHALF-OF | Publisher identity as passed | Header | String | <=8 | DR | N | Y | username | +| | in X-DMAAP-DR-ON-BEHALF-OF at | | | | | | | | +| | creation time | | | | | | | | ++-------------------------+---------------------------------+---------------+-----------------+--------+--------+------------+----------+--------------------------------------+ **Response Codes** @@ -535,12 +496,11 @@ Subscribe to Feed "user": "LOGIN", "url": "http://dmaap-dr-subscriber:7070/" }, - "subscriber": "onap", + "subscriber": "{user}", "groupid": 1, "metadataOnly": false, "follow_redirect": true, "decompress": true, - "aaf_instance": "legacy", "links": { "feed": "https://dmaap-dr-prov/feed/1", "log": "https://dmaap-dr-prov/sublog/1", @@ -563,44 +523,40 @@ Update subscription **Request Parameters:** -+-----------------+---------------------------------+--------------+---------------+--------+-------------+ -| Field | Description | Param Type | Data Type | MaxLen | Required | -+=================+=================================+==============+===============+========+=============+ -| subId | ID for the subscription you are | Path | String | | Y | -| | updating | | | | | -+-----------------+---------------------------------+--------------+---------------+--------+-------------+ -| delivery | Address and credentials for | Body | `Del Object`_ | | Y | -| | delivery | | | | | -+-----------------+---------------------------------+--------------+---------------+--------+-------------+ -| follow_redirect | Set to true if feed redirection | Body | Boolean | | N | -| | is expected | | | | | -+-----------------+---------------------------------+--------------+---------------+--------+-------------+ -| metadata_only | Set to true if subscription is | Body | Boolean | | Y | -| | to receive per-file metadata | | | | | -+-----------------+---------------------------------+--------------+---------------+--------+-------------+ -| suspend | Set to true if the subscription | Body | Boolean | | N | -| | is in the suspended state | | | | | -+-----------------+---------------------------------+--------------+---------------+--------+-------------+ -| decompress | Set to true if the data is to | Body | Boolean | | N | -| | be decompressed for subscriber | | | | | -+-----------------+---------------------------------+--------------+---------------+--------+-------------+ -| group-id | Auth group for sub management | Body | Integer | | Y | -| | | | | | | -+-----------------+---------------------------------+--------------+---------------+--------+-------------+ -| Content-type | To specify type of message | Header | String | | Y | -| | (feed,subscriber,publisher) | | | | | -+-----------------+---------------------------------+--------------+---------------+--------+-------------+ -| subscriber | Subscriber identity as passed | Header | String | <=8 | Y | -| | in X-DMAAP-DR-ON-BEHALF-OF at | | | | | -| | creation time | | | | | -+-----------------+---------------------------------+--------------+---------------+--------+-------------+ -| Authorization | The user / AppId to be | Header | String | | Y if AAF | -| | authorized by the AAF CADI | | | | enabled | -| | framework | | | | | -+-----------------+---------------------------------+--------------+---------------+--------+-------------+ -| X-EXCLUDE-AAF | To determine if the feed to | Header | Boolean | | Y if AAF | -| | create is legacy or AAF | | | | enabled | -+-----------------+---------------------------------+--------------+---------------+--------+-------------+ ++-------------------------+---------------------------------+--------------+---------------+--------+-------------+ +| Field | Description | Param Type | Data Type | MaxLen | Required | ++=========================+=================================+==============+===============+========+=============+ +| subId | ID for the subscription you are | Path | String | | Y | +| | updating | | | | | ++-------------------------+---------------------------------+--------------+---------------+--------+-------------+ +| delivery | Address and credentials for | Body | `Del Object`_ | | Y | +| | delivery | | | | | ++-------------------------+---------------------------------+--------------+---------------+--------+-------------+ +| follow_redirect | Set to true if feed redirection | Body | Boolean | | N | +| | is expected | | | | | ++-------------------------+---------------------------------+--------------+---------------+--------+-------------+ +| metadata_only | Set to true if subscription is | Body | Boolean | | Y | +| | to receive per-file metadata | | | | | ++-------------------------+---------------------------------+--------------+---------------+--------+-------------+ +| suspend | Set to true if the subscription | Body | Boolean | | N | +| | is in the suspended state | | | | | ++-------------------------+---------------------------------+--------------+---------------+--------+-------------+ +| decompress | Set to true if the data is to | Body | Boolean | | N | +| | be decompressed for subscriber | | | | | ++-------------------------+---------------------------------+--------------+---------------+--------+-------------+ +| group-id | Auth group for sub management | Body | Integer | | Y | +| | | | | | | ++-------------------------+---------------------------------+--------------+---------------+--------+-------------+ +| Content-type | To specify type of message | Header | String | | Y | +| | (feed,subscriber,publisher) | | | | | ++-------------------------+---------------------------------+--------------+---------------+--------+-------------+ +| Authorization | The user / AppId to be | Header | String | | Y | +| | authorized | | | | | ++-------------------------+---------------------------------+--------------+---------------+--------+-------------+ +| X-DMAAP-DR-ON-BEHALF-OF | Publisher identity as passed | Header | String | <=8 | Y | +| | in X-DMAAP-DR-ON-BEHALF-OF at | | | | | +| | creation time | | | | | ++-------------------------+---------------------------------+--------------+---------------+--------+-------------+ **Response Codes** @@ -652,12 +608,11 @@ Update subscription "user": "NEW_LOGIN", "url": "http://dmaap-dr-subscriber:7070/" }, - "subscriber": "onap", + "subscriber": "{user}", "groupid": 67, "metadataOnly": true, "follow_redirect": false, "decompress": false, - "aaf_instance": "legacy", "links": { "feed": "https://dmaap-dr-prov/feed/1", "log": "https://dmaap-dr-prov/sublog/1", @@ -680,17 +635,17 @@ Get a Subscription **Request Parameters:** -+-----------------+---------------------------------+--------------+---------------+--------+-------------+ -| Field | Description | Param Type | Data Type | MaxLen | Required | -+=================+=================================+==============+===============+========+=============+ -| subscriber | Subscriber identity as passed | Header | String | <=8 | Y | -| | in X-DMAAP-DR-ON-BEHALF-OF at | | | | | -| | creation time | | | | | -+-----------------+---------------------------------+--------------+---------------+--------+-------------+ -| Authorization | The user / AppId to be | Header | String | | Y if AAF | -| | authorized by the AAF CADI | | | | enabled | -| | framework | | | | | -+-----------------+---------------------------------+--------------+---------------+--------+-------------+ ++-------------------------+---------------------------------+-------------+---------------+------------+-------------+ +| Field | Description | Param Type | Data Type | MaxLen | Required | ++=========================+=================================+=============+===============+============+=============+ +| Authorization | The user / AppId to be | Header | String | | Y | +| | authorized | | | | | ++-------------------------+---------------------------------+-------------+---------------+------------+-------------+ +| X-DMAAP-DR-ON-BEHALF-OF | Subscriber identity as passed | Header | String | <=8 | Y | +| | in X-DMAAP-DR-ON-BEHALF-OF at | | | | | +| | creation time | | | | | ++-------------------------+---------------------------------+-------------+---------------+------------+-------------+ + **Response Codes** @@ -721,13 +676,12 @@ Get a Subscription "user": "NEW_LOGIN", "url": "http://dmaap-dr-subscriber:7070/" }, - "subscriber": "onap", + "subscriber": "{user}", "groupid": 67, "metadataOnly": true, "privilegedSubscriber": false, "follow_redirect": false, "decompress": false, - "aaf_instance": "legacy", "links": { "feed": "https://dmaap-dr-prov/feed/2", "log": "https://dmaap-dr-prov/sublog/6", @@ -749,17 +703,16 @@ Delete a subscription **Request Parameters:** -+-----------------+---------------------------------+--------------+---------------+--------+-------------+ -| Field | Description | Param Type | Data Type | MaxLen | Required | -+=================+=================================+==============+===============+========+=============+ -| subscriber | Subscriber identity as passed | Header | String | <=8 | Y | -| | in X-DMAAP-DR-ON-BEHALF-OF at | | | | | -| | creation time | | | | | -+-----------------+---------------------------------+--------------+---------------+--------+-------------+ -| Authorization | The user / AppId to be | Header | String | | Y if AAF | -| | authorized by the AAF CADI | | | | enabled | -| | framework | | | | | -+-----------------+---------------------------------+--------------+---------------+--------+-------------+ ++-------------------------+---------------------------------+-------------+---------------+------------+-------------+ +| Field | Description | Param Type | Data Type | MaxLen | Required | ++=========================+=================================+=============+===============+============+=============+ +| Authorization | The user / AppId to be | Header | String | | Y | +| | authorized | | | | | ++-------------------------+---------------------------------+-------------+---------------+------------+-------------+ +| X-DMAAP-DR-ON-BEHALF-OF | Subscriber identity as passed | Header | String | <=8 | Y | +| | in X-DMAAP-DR-ON-BEHALF-OF at | | | | | +| | creation time | | | | | ++-------------------------+---------------------------------+-------------+---------------+------------+-------------+ **Response Codes** @@ -809,10 +762,8 @@ Publish to Feed | | * Lowercase boolean | | | | | | | | * null | | | | | | +------------------------+---------------------------------+------------------+------------+--------------+-------------+-------------------------------------------+ -| Authorization | An `EID Object`_ with publish | Header | String | | Y | * (legacy Feed) dradmin:dradmin | -| | permissions. | | | | | * (AAF Feed) dcae@dcae.onap.org:{password}| -| | If AAF CADI is enabled, use a | | | | | | -| | valid AAF user/AppId instead. | | | | | | +| Authorization | An `EID Object`_ with publish | Header | String | | Y | * dradmin:dradmin | +| | permissions. | | | | | | +------------------------+---------------------------------+------------------+------------+--------------+-------------+-------------------------------------------+ **Response Codes** @@ -846,10 +797,8 @@ Delete/Retract a Published file +-----------------+---------------------------------+--------------+---------------+------------+-------------------------------------------+ | Field | Description | Param Type | Data Type | Required | Valid/Example Values | +=================+=================================+==============+===============+============+===========================================+ -| Authorization | An `EID Object`_ with publish | Header | String | Y | * (legacy Feed) dradmin:dradmin | -| | permissions. | | | | * (AAF Feed) dcae@dcae.onap.org:{password}| -| | If AAF CADI is enabled, use a | | | | | -| | valid AAF user/AppId instead. | | | | | +| Authorization | An `EID Object`_ with publish | Header | String | Y | * dradmin:dradmin | +| | permissions. | | | | | +-----------------+---------------------------------+--------------+---------------+------------+-------------------------------------------+ | feedId | ID of the feed that was | Path | String | Y | | | | publishing to | | | | | diff --git a/docs/apis/drAPI1.json b/docs/apis/drAPI1.json index 67392a2b..7809ca4d 100644 --- a/docs/apis/drAPI1.json +++ b/docs/apis/drAPI1.json @@ -766,10 +766,6 @@ "type": "string", "example": "" }, - "aaf_instance": { - "type": "string", - "example": "legacy" - }, "publisher": { "type": "string", "example": "dradmin" diff --git a/docs/architecture.rst b/docs/architecture.rst index cae6bca0..7310573b 100644 --- a/docs/architecture.rst +++ b/docs/architecture.rst @@ -10,13 +10,6 @@ Capabilities The DMaaP Data Router (DR) provisioning API is an HTTPS-based, REST-like API for creating and managing DR feeds and subscriptions, which provides a pub/sub architectural model for the transfer of data. -The DR API also supports `AAF CADI authorization `_. - -To use this feature, the API client must provide a valid AAF AppID / MechID with each request. -To enable this feature, see the :ref:`configuration` section. - -.. note:: In future releases, AAF CADI auth will be enabled by default. - Usage Scenarios --------------- Typically, DR pub clients request the provisioning of a new DR feed. diff --git a/docs/configuration.rst b/docs/configuration.rst index f7fa4bcf..b55d0730 100644 --- a/docs/configuration.rst +++ b/docs/configuration.rst @@ -6,38 +6,37 @@ Configuration ============= -Configuration properties for both Data Router Provisioning server and Data Router Node server should remain as default values. +Most configuration properties for both Data Router Provisioning server and Data Router Node server +should remain as default values. -The only exception to this, is when enabling the AAF CADI framework to authorize the DR provisioning requests. +An exception to this is when a user wants to run over HTTP (non TLS). -.. note:: The AAF CADI filtering feature is disabled by default. When AAF CADI auth is enabled, all DR API calls must provide an AAF AppID to access the relevant API endpoint. +For DR Provisioning server config, edit the following props in the provserver.properties file. -To enable DR AAF CADI authorization, the following steps are required: +.. code-block:: bash -DR CADI Prerequisites: - * AAF deployment + org.onap.dmaap.datarouter.provserver.tlsenabled = false -Update the following properties at deployment time. +and ensure aaf cadi is disabled also +.. code-block:: bash -**DMaaP DR Prov AAF properties** + org.onap.dmaap.datarouter.provserver.cadi.enabled = false -:: - # AAF config - org.onap.dmaap.datarouter.provserver.cadi.enabled = true +For DR Node server config, edit the following props in the node.properties file to target http. - # AAF URL to connect to AAF server - org.onap.dmaap.datarouter.provserver.cadi.aaf.url = https://:8095 - - -**DMaaP DR Node AAF properties** - -:: - - # AAF URL to connect to AAF server - AafUrl = https://:8095 - - # AAF CADI enabled flag - CadiEnabled = true +.. code-block:: bash + # URL to retrieve dynamic configuration + ProvisioningURL = http://dmaap-dr-prov:8080/internal/prov + # + # URL to upload PUB/DEL/EXP logs + LogUploadURL = http://dmaap-dr-prov:8080/internal/logs + ... + # + # AAF CADI enabled flag + CadiEnabled = false + # + # Enable to run over http or https (default true|https) + TlsEnabled = false diff --git a/docs/images/dr_bc_prov.png b/docs/images/dr_bc_prov.png index 9e2f7e47..932c6556 100644 Binary files a/docs/images/dr_bc_prov.png and b/docs/images/dr_bc_prov.png differ diff --git a/docs/images/dr_pub_flow.png b/docs/images/dr_pub_flow.png index 83af9bd2..e3fc0364 100644 Binary files a/docs/images/dr_pub_flow.png and b/docs/images/dr_pub_flow.png differ diff --git a/pom.xml b/pom.xml index 5d1c178c..ec0aedfc 100755 --- a/pom.xml +++ b/pom.xml @@ -36,7 +36,7 @@ - 2.1.10-SNAPSHOT + 2.1.11-SNAPSHOT UTF-8 11 11 diff --git a/version.properties b/version.properties index cd2abb72..d0a38284 100644 --- a/version.properties +++ b/version.properties @@ -27,7 +27,7 @@ major=2 minor=1 -patch=10 +patch=11 base_version=${major}.${minor}.${patch}