summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorJimmy Forsyth <jf2512@att.com>2019-06-07 09:47:07 -0400
committerJimmy Forsyth <jf2512@att.com>2019-06-07 12:22:59 -0400
commitb31816bbe73439bab7546e1412981106ab0c4bf8 (patch)
tree04b8ec04b83b6136a8d076775b79de6af876ceb6 /docs
parentc21c6aac0b93f8a368b155b8426a4a4f6d8127fd (diff)
Add instructions for AAF role for sparky
Move nodes API block to proper location Issue-ID: AAI-2411 Signed-off-by: Jimmy Forsyth <jf2512@att.com> Change-Id: If21e610366c765a251fe4fb78ded7ca90bcfa142
Diffstat (limited to 'docs')
-rw-r--r--docs/AAI REST API Documentation/AAIRESTAPI.rst29
-rw-r--r--docs/AAI REST API Documentation/AAIRESTAPI_DUBLIN.rst29
-rw-r--r--docs/release-notes.rst27
3 files changed, 55 insertions, 30 deletions
diff --git a/docs/AAI REST API Documentation/AAIRESTAPI.rst b/docs/AAI REST API Documentation/AAIRESTAPI.rst
index 5cd758bb..04cd6c08 100644
--- a/docs/AAI REST API Documentation/AAIRESTAPI.rst
+++ b/docs/AAI REST API Documentation/AAIRESTAPI.rst
@@ -1062,6 +1062,21 @@ The Bulk API allows clients to make multiple requests in a single
transaction. Please look for additional details on the following wiki
page: `Bulk API <bulkApi.html>`_
+Nodes API
+---------
+
+In working with A&AI's standard REST API, you may have noticed that
+certain API paths have a hierarchy to them and require a client to
+know multiple object keys to preform GETs. For example: the vserver
+object is under tenant, which is itself under cloud-region. If you
+wanted to look up a vserver by name, you would still need to know the
+tenant-id and cloud-region-id (and cloud-owner) in order to
+successfully perform that GET. The nodes API allows for more freedom
+in querying A&AI, allowing clients to circumvent the need to know
+every key in the hierarchy.
+
+See `Nodes API <nodesApi.html>`_ for more information.
+
AAI Traversal APIs
==================
@@ -1082,20 +1097,6 @@ values.
Please reference `Nodes Query <nodesQuery.html>`_ for details on the
API and test queries.
-Nodes API
----------
-
-In working with A&AI's standard REST API, you may have noticed that
-certain API paths have a hierarchy to them and require a client to
-know multiple object keys to preform GETs. For example: the vserver
-object is under tenant, which is itself under cloud-region. If you
-wanted to look up a vserver by name, you would still need to know the
-tenant-id and cloud-region-id (and cloud-owner) in order to
-successfully perform that GET. The nodes API allows for more freedom
-in querying A&AI, allowing clients to circumvent the need to know
-every key in the hierarchy.
-
-See `Nodes API <nodesApi.html>`_ for more information.
Generic Queries
---------------
diff --git a/docs/AAI REST API Documentation/AAIRESTAPI_DUBLIN.rst b/docs/AAI REST API Documentation/AAIRESTAPI_DUBLIN.rst
index 5cd758bb..04cd6c08 100644
--- a/docs/AAI REST API Documentation/AAIRESTAPI_DUBLIN.rst
+++ b/docs/AAI REST API Documentation/AAIRESTAPI_DUBLIN.rst
@@ -1062,6 +1062,21 @@ The Bulk API allows clients to make multiple requests in a single
transaction. Please look for additional details on the following wiki
page: `Bulk API <bulkApi.html>`_
+Nodes API
+---------
+
+In working with A&AI's standard REST API, you may have noticed that
+certain API paths have a hierarchy to them and require a client to
+know multiple object keys to preform GETs. For example: the vserver
+object is under tenant, which is itself under cloud-region. If you
+wanted to look up a vserver by name, you would still need to know the
+tenant-id and cloud-region-id (and cloud-owner) in order to
+successfully perform that GET. The nodes API allows for more freedom
+in querying A&AI, allowing clients to circumvent the need to know
+every key in the hierarchy.
+
+See `Nodes API <nodesApi.html>`_ for more information.
+
AAI Traversal APIs
==================
@@ -1082,20 +1097,6 @@ values.
Please reference `Nodes Query <nodesQuery.html>`_ for details on the
API and test queries.
-Nodes API
----------
-
-In working with A&AI's standard REST API, you may have noticed that
-certain API paths have a hierarchy to them and require a client to
-know multiple object keys to preform GETs. For example: the vserver
-object is under tenant, which is itself under cloud-region. If you
-wanted to look up a vserver by name, you would still need to know the
-tenant-id and cloud-region-id (and cloud-owner) in order to
-successfully perform that GET. The nodes API allows for more freedom
-in querying A&AI, allowing clients to circumvent the need to know
-every key in the hierarchy.
-
-See `Nodes API <nodesApi.html>`_ for more information.
Generic Queries
---------------
diff --git a/docs/release-notes.rst b/docs/release-notes.rst
index 4fd9876d..efb8134c 100644
--- a/docs/release-notes.rst
+++ b/docs/release-notes.rst
@@ -39,6 +39,29 @@ under aai/oom for more details).
AAI now manages its own helm charts. See `aai/oom <https://gerrit.onap.org/r/admin/repos/aai/oom>`__
+**Known Issues**
+
+The AAI UI is now integrated with Portal and AAF. However, the AAF
+default boostrap does not include a role that is necessary the demo
+user to access the AAI UI.
+
+Run the following as a workaround, adjust the URL and credentials
+according to your environment. The user in CRED must be able to update
+the org.onap.aai namespace. The following example has been tested from
+inside the AAI resources pod.
+
+ .. code-block:: bash
+
+ URL='https://aaf-service.onap:8100'
+ CRED='aai@aai.onap.org:demo123456!'
+
+ curl -v -k -u "$CRED" -H "Content-Type: application/RoleRequest+json" $URL/authz/role -d '{"name":"org.onap.aai.aaiui"}'
+
+ curl -v -k -u "$CRED" -H "Content-Type: application/UserRoleRequest+json" $URL/authz/userRole -d '{ "user":"demo@people.osaaf.org", "role":"org.onap.aai.aaiui" }'
+
+Future releases will include the role and role assignment in the
+default bootstrap data (being tracked under `AAI-2475 <https://jira.onap.org/browse/AAI-2475>`__)
+
**Security Notes**
@@ -56,7 +79,7 @@ Quick Links:
- `AAI project page <https://wiki.onap.org/display/DW/Active+and+Available+Inventory+Project>`_
- `Passing Badge information for AAI <https://bestpractices.coreinfrastructure.org/en/projects/1591>`_
-- `Project Vulnerability Review Table for AAI <https://wiki.onap.org/pages/viewpage.action?pageId=64003431>`_
+- `R4 Project Vulnerability Review Table for AAI <https://wiki.onap.org/pages/viewpage.action?pageId=64003431>`_
@@ -192,7 +215,7 @@ Quick Links:
- `AAI project page <https://wiki.onap.org/display/DW/Active+and+Available+Inventory+Project>`_
- `Passing Badge information for AAI <https://bestpractices.coreinfrastructure.org/en/projects/1591>`_
-- `Project Vulnerability Review Table for AAI <https://wiki.onap.org/pages/viewpage.action?pageId=45307817>`_
+- `R3 Project Vulnerability Review Table for AAI <https://wiki.onap.org/pages/viewpage.action?pageId=45307817>`_
Version: 1.2.0