Author: lmccay
Date: Sat Aug  5 16:10:43 2017
New Revision: 1804195

URL: http://svn.apache.org/viewvc?rev=1804195&view=rev
Log:
KNOX-979 - Documentation for Atlas UI & Atlas Rest Api via Knox Proxy (Nixon 
Rodrigues via lmccay)

Modified:
    knox/trunk/books/0.13.0/book_ui_service_details.md

Modified: knox/trunk/books/0.13.0/book_ui_service_details.md
URL: 
http://svn.apache.org/viewvc/knox/trunk/books/0.13.0/book_ui_service_details.md?rev=1804195&r1=1804194&r2=1804195&view=diff
==============================================================================
--- knox/trunk/books/0.13.0/book_ui_service_details.md (original)
+++ knox/trunk/books/0.13.0/book_ui_service_details.md Sat Aug  5 16:10:43 2017
@@ -31,6 +31,7 @@ These are the current Hadoop services wi
 * #[Spark UI]
 * #[Ambari UI]
 * #[Ranger Admin Console]
+* #[Atlas UI]
 
 ### Assumptions
 
@@ -334,5 +335,79 @@ through authentication challenge and cre
             <url>http://localhost:8060</url>
         </service>
     </topology>
+
+        </service>
+    </topology>
     
-    
+   
+
+### Atlas UI ###
+
+### Atlas Rest API ###
+
+The Atlas Rest API can now be used behind the Knox gateway.
+To enable this functionality, a topology file needs to have the following 
configuration.
+
+    <service>
+        <role>ATLAS-API</role>
+        <url>http://<ATLAS_HOST>:<ATLAS_PORT></url>
+    </service>
+
+The default Atlas http port is 21000. Also please note that the UI service 
also requires the Atlas REST API
+service to be enabled to function properly. An example of a more complete 
topology is given below.
+
+Atlas Rest API URL Mapping
+For Atlas Rest URLs, the mapping of Knox Gateway accessible URLs to direct 
Atlas Rest URLs is the following.
+
+
+| ------- | 
-------------------------------------------------------------------------------------
 |
+| Gateway | 
`https://{gateway-host}:{gateway-port}/{gateway-path}/{topology}/atlas/`        
 |
+| Cluster | `http://{atlas-host}:{atlas-port}/}`                               
                 |
+
+
+
+Access Atlas Api using Curl call
+
+     curl -i -k -L -u admin:admin -X GET \
+               
'https://knox-gateway:8443/gateway/{topology}/atlas/api/atlas/v2/types/typedefs?type=classification&_=1495442879421'
+
+
+###   Atlas UI   ###
+In addition to the Atlas REST API, from this release there is the ability to 
access some of the functionality via a web. The initial functionality is very 
limited and serves more as a starting point/placeholder. The details are below.
+Atlas UI URL
+
+The URL mapping for the Atlas UI is:
+
+| ------- | 
-------------------------------------------------------------------------------------
 |
+|Gateway  |  
`https://{gateway-host}:{gateway-port}/{gateway-path}/{topology}/atlas/index.html`
+
+#### Example Topology for Atlas ####
+
+                <topology>
+                    <gateway>
+                        <provider>
+                            <role>authentication</role>
+                            <name>Anonymous</name>
+                            <enabled>true</enabled>
+                        </provider>
+                        <provider>
+                            <role>identity-assertion</role>
+                            <name>Default</name>
+                            <enabled>false</enabled>
+                        </provider>
+                    </gateway>
+
+                    <service>
+                        <role>ATLAS-API</role>
+                        <url>http://<ATLAS_HOST>:<ATLAS_PORT></url>
+                    </service>
+
+                    <service>
+                        <role>ATLAS</role>
+                        <url>http://<ATLAS_HOST>:<ATLAS_PORT></url>
+                    </service>
+                </topology>
+                                                                               
                                                         Atlas
+
+Note : - This feature will allow for 'anonymous' authentication. Essentially 
bypassing any LDAP or other authentication done by Knox and allow the proxied 
service to do the actual authentication.
+


Reply via email to